Live File Processor Agent Report

Report Name: EQuIS Live: File Processor (example)

Description: The EQuIS Live: File Processor report allows users to load file data in EQuIS Professional and Enterprise; it can be run manually or as an EIA.

Report Parameters

File types

Select one or more ST_CONFIG.CONFIG_KEYS and OBJECT_TYPES.

See Processor Settings article for more info.

This parameter value is split using pipes ('|') and dots ('.'), and saved in ST_USER_REPORT_PARAMETER.PARAM_VALUE. The ST_CONFIG.CONFIG_KEY and OBJECT_TYPE values cannot contain pipes, and the OBJECT_TYPES cannot contain dots.

No file info action

Select what to do if there is no file info in ST_USER_REPORT.USER_REPORT_INFO (e.g., if this is the first time that this user report runs, or if this is not a user report); allows overriding ST_CONFIG noFileInfoAction setting value(s).

Value

Description

config

Use ST_CONFIG noFileInfoAction setting value(s) (default value).

Note: If there is not an ST_CONFIG noFileInfoAction setting, then the default is load.

load

Get file info and load files.

info

Get file info only.

UPDATE existing values?

Select whether or not to update existing database values if file values are changed; allows overriding ST_CONFIG updateExistingValues setting value(s).

Value	Description
config	Use ST_CONFIG updateExistingValues setting value(s) (default value). Note: If there is not an ST_CONFIG updateExistingValues setting, then the default is false.
false	False.
true	True.

Details to be included in report output

Select the level of detail to be included in the report output.

The report output columns are the same for all of these options, but a row (e.g., file) is not added to the report output unless it meets the selected criteria.

Level	Description
info	Rows with info, warnings, and/or errors. (Default Value)
warn	Rows with warnings and/or errors.
error	Rows with errors.
off	Nothing.

Notes:

•If this report is run as a user report, it will save the file info (file name, file last modified date and time, and file size) in ST_USER_REPORT.USER_REPORT_INFO for each file, in each folderWatcherPath, so that it does not process a file (the next time it is run) unless the file is new or has changed.

•The folderWatcherPath (folder) needs to be accessible by this report, e.g., if it is run in EQuIS Professional then the folder needs to be accessible on the local computer, and if it is run in EQuIS Enterprise then the folder needs to be accessible on the server on which Enterprise is installed.

•If using EQuIS Enterprise, then the EmailRetrieve Agent can also be used to save 'local' files, but it can only be used by the Live File Processor if it is not already being used by EDP (it currently only supports one 'EML' folder).

•If facility settings are not defined or are empty, or the facility is not found in a file or file name, then the selected facility is used, e.g., new loggers are added to the selected facility in EQuIS Professional or Enterprise when running this agent as a report (if facility settings are not defined).

•This report reads the ST_CONFIG settings each time it runs; if the settings are changed, it will detect the changes the next time that it runs.