Live File Processor Agent Report

<< Click to Display Table of Contents >>

Navigation:  Live > Agents > File Agents > File Processor > Installation and Configuration >

Live File Processor Agent Report

Installation and Setup

 

Publish the EQuIS Live: File Processor report, available in EarthSoft.Live.Reports.dll file.

 

Note: If this report is run as a user report 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.

 

 

Loading Data

 

This report can be run as a scheduled EQuIS Information Agent (EIA), at the desired frequency, to automatically load data as often as needed.

 

It can also be run in EQuIS Professional or Enterprise (using the EZView widget), to load the data manually, without having to schedule an EIA.

 

It has the following input parameters.

 

Parameter

Description

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).

 

Value

Description

load

Get file info and load files. (Default Value)

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)

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.

 

 

Important Note: The root level value in the log4net.config file, in EQuIS Professional or EQuIS Enterprise, needs to be set to all, info, or warn, so that this report can provide warnings and errors in its output. For example,

 <root>

   <level value="warn" />

   ...

 </root>

 

This is a known issue that will be fixed in a future EQuIS release.

 

 

Notes:

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 computer (or virtual machine, or Azure?) on which Enterprise is installed.

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.