Live File Processor Agent File

Setting	Type	Description
addNewLoggers	Boolean	If false, does not add new DT_LOGGER rows to the database. Default Value: True

Setting

Type

Description

addNewLoggers

If false, does not add new DT_LOGGER rows to the database.

Default Value: True

LOGGER_CODE

The DT_LOGGER.LOGGER_CODE identifies the logger to which the series and datum are added. It is obtained from one of the following sources. It cannot be NULL.

Setting	Type	Description
loggerCodeColumnHeaderRegex	Regex	LOGGER_CODE from file column value(s). The value in one or more columns, in each data line, if this setting is defined and not empty and one or more columns exist in the file whose header text matches this pattern (see Lorentz example). If LOGGER_CODE is a composite of more than one column value, split Regex patterns using ' \|\| '.
loggerCodeHeaderLinesRegexGroups	Regex Named Groups	LOGGER_CODE from file header. This named group's value, if this setting is defined and not empty and this pattern exists in the file's header (see HOBO example). If multi-line header (pattern), split lines using '\n' (see Solinst example).
loggerCodeFileNameRegexGroups	Regex Named Groups	LOGGER_CODE from file name. This named group's value, if this setting is not empty and this pattern exists in the file's name (see YSI-6 example). Also, see note about FileNameRegexGroups and Excel and zip files.
loggerCodeDefaultValue	String	LOGGER_CODE from default value.

Note: *ColumnHeaderRegex, *HeaderLinesRegexGroups, *FileNameRegexGroups, and *DefaultValue are also used for other settings (e.g., * = facilityId, facilityCode, sysLocCode, and locationParamCode).

LOGGER_DESC

The DT_LOGGER.LOGGER_DESC describes the logger.

Setting	Type	Description
loggerDescPrefix	Composite String	Sets DT_LOGGER.LOGGER_DESC = this value + LOGGER_CODE, when adding new loggers (see Lorentz example). If this setting is not defined or is empty, LOGGER_DESC is set to NULL.

Setting

Type

Description

loggerDescPrefix

Composite String

Sets DT_LOGGER.LOGGER_DESC = this value + LOGGER_CODE, when adding new loggers (see Lorentz example).

If this setting is not defined or is empty, LOGGER_DESC is set to NULL.

LIVE_DATA_SOURCE

The DT_LOGGER.LIVE_DATA_SOURCE is the source from which the live data are collected.

Setting	Type	Description
liveDataSourceGet	Composite String	Gets loggers with DT_LOGGER.LIVE_DATA_SOURCE = this value, when searching for loggers. May also contain SQL Server wildcard characters like %. Default Value: % (LIVE_DATA_SOURCE can be anything, including NULL or empty)
liveDataSourceSet	Composite String	Sets LOGGER.LIVE_DATA_SOURCE = this value, when adding new loggers. Default Value: {computerName}/{folderWatcherPath} for local and shared folders, or {remoteUriWithPath} for remote folders.

Setting

Type

Description

liveDataSourceGet

Composite String

Gets loggers with DT_LOGGER.LIVE_DATA_SOURCE = this value, when searching for loggers.

May also contain SQL Server wildcard characters like %.

Default Value: % (LIVE_DATA_SOURCE can be anything, including NULL or empty)

liveDataSourceSet

Composite String

Sets LOGGER.LIVE_DATA_SOURCE = this value, when adding new loggers.

Default Value: {computerName}/{folderWatcherPath} for local and shared folders, or {remoteUriWithPath} for remote folders.

FACILITY_ID

The DT_LOGGER.FACILITY_ID is the unique identifier of the facility associated with the logger, if any. The order in which the following settings are tried is the order in the Setting column, topmost first. The facility needs to exist in the DT_FACILITY table. If a FACILITY_CODE is provided instead of a FACILITY_ID, then its FACILITY_ID is looked up in the DT_FACILITY table. If the facility does not exist, then an error is logged, and the data are not added to the database.

Setting	Type	Description
facilityIdColumnHeaderRegex	Regex	FACILITY_ID from file column value.
facilityCodeColumnHeaderRegex	Regex	FACILITY_CODE from file column value.
facilityIdHeaderLinesRegexGroups	Regex Named Groups	FACILITY_ID from file header.
facilityCodeHeaderLinesRegexGroups	Regex Named Groups	FACILITY_CODE from file header.
facilityIdFileNameRegexGroups	Regex Named Groups	FACILITY_ID from file name.
facilityCodeFileNameRegexGroups	Regex Named Groups	FACILITY_CODE from file name.
facilityIdDefaultValue	String	FACILITY_ID from default value.
facilityCodeDefaultValue	String	FACILITY_CODE from default value.

If the above 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.

SYS_LOC_CODE

The DT_LOGGER.SYS_LOC_CODE is the unique identifier of the location associated with the logger, if any. If the facility exists, but the location does not exist (in DT_LOCATION.SYS_LOC_CODE for the provided facility), it is added with STATUS_FLAG = 'R'. See updateExistingValues setting for updating the SYS_LOC_CODE values in existing logger rows.

Setting	Type	Description
sysLocCodeColumnHeaderRegex	Regex	SYS_LOC_CODE from file column value(s). If SYS_LOC_CODE is a composite of more than one column value, split Regex patterns using ' \|\| '.
sysLocCodeHeaderLinesRegexGroups	Regex Named Groups	SYS_LOC_CODE from file header.
sysLocCodeFileNameRegexGroups	Regex Named Groups	SYS_LOC_CODE from file name.
sysLocCodeDefaultValue	String	SYS_LOC_CODE default value.

Note: The *FileNameRegexGroups settings may be used in combination with the folderWatcherFilterRegex setting to ignore files whose names do not match a desired pattern (see E-BAM example).

Finding a Logger

The following criteria are used to identify the logger to which the series and datum should be added:

•LOGGER_CODE = LOGGER_CODE obtained from loggerCode* settings (above)

•LIVE_DATA_SOURCE = liveDataSourceGet setting value (above)

•STATUS_FLAG = 'A' (active)

•FACILITY_ID, SYS_LOC_CODE:

FACILITY_ID	SYS_LOC_CODE	Logger Search Criteria and Order: 1, or 2, or 3, or add new logger
Provided	Provided	1.Logger's FACILITY_ID matches provided FACILITY_ID, and logger's SYS_LOC_CODE matches provided SYS_LOC_CODE. 2.Logger's FACILITY_ID matches provided FACILITY_ID, and logger's SYS_LOC_CODE is anything. 3.Logger's FACILITY_ID is NULL, and logger's SYS_LOC_CODE is anything.
Provided	Not provided	1.Logger's FACILITY_ID matches provided FACILITY_ID, and logger's SYS_LOC_CODE is NULL. 2.Logger's FACILITY_ID matches provided FACILITY_ID, and logger's SYS_LOC_CODE is anything. 3.Logger's FACILITY_ID is NULL, and logger's SYS_LOC_CODE is anything.
Not provided	Provided	Not allowed; SYS_LOC_CODE is not used if a facility is not provided.
Not provided	Not provided	1.Logger's FACILITY_ID is NULL, and logger's SYS_LOC_CODE is NULL. 2.Logger's FACILITY_ID is NULL, and logger's SYS_LOC_CODE is anything. 3.Logger's FACILITY_ID is anything, and logger's SYS_LOC_CODE is anything.

If a logger is not found, a new logger is added.

If multiple loggers match the search criteria – e.g., if multiple active (STATUS_FLAG = 'A') loggers have the same LOGGER_CODE, and a FACILITY_ID is not provided – the logger with the lowest LOGGER_ID is used.

If a FACILITY_ID is provided and the logger's FACILITY_ID is NULL, then the logger's FACILITY_ID is updated to the provided FACILITY_ID.

Live File Processor Agent File – Logger

Live File Processor Agent File – Logger

LOGGER_DESC

LIVE_DATA_SOURCE

FACILITY_ID

SYS_LOC_CODE

Finding a Logger