Live File Processor Agent File – Series

<< Click to Display Table of Contents >>

Navigation:  Live > Agents > File Agents > File Processor > Settings > File >

Live File Processor Agent File – Series

The DT_LOGGER_SERIES.SERIES_NAME, and SERIES_UNIT and SERIES_FUNCTION, if any, identifies the series to which the data are added. It is obtained from one or more of the following sources. It cannot be NULL.

 

Examples:

'Power(kWh)' : SERIES_NAME = 'Power', SERIES_UNIT = 'kWh' (see Lorentz example).
 
(Note: If seriesName* and seriesUnit* settings are defined, then the SERIES_NAME and SERIES_UNIT are used to identify the series.)

'CO(ppm)\n(Min)' : SERIES_NAME = 'CO', SERIES_UNIT = 'ppm', SERIES_FUNCTION = 'Min' (see AreaRAE example).
 
(Note: If seriesName*, seriesUnit*, and seriesFunction* settings are defined, then the SERIES_NAME, SERIES_UNIT, and SERIES_FUNCTION are used to identify the series.)

'Press psi a' : SERIES_NAME = 'Press psi a' (see YSI-EXO example).
 
(Note: If only seriesName* setting is defined (or no series* settings are defined, in which case all of a column's header text is the SERIES_NAME), then only the SERIES_NAME is used to identify the series.)

 

Note: A series can be activated or deactivated by setting its STATUS_FLAG = 'A' or 'R', to start or stop (respectively) obtaining data for it.

 

 

SERIES_NAME

 

Setting

Type

Description

seriesNameColumnHeaderRegex

Regex

SERIES_NAME from file column value(s) (see LoggerDatum example).

 

If SERIES_NAME is a composite of more than one column value, split Regex patterns using ' || '.

seriesNameColumnHeaderRegexGroups

Regex Named Groups

SERIES_NAME from file column header.

 

Notes:

If no series* settings are defined, then all of a column's header text is the SERIES_NAME.

If seriesNameColumnHeaderRegex is defined, then the column header text is not included in the SERIES_NAME, unless this value is also defined.

seriesNameHeaderLinesRegexGroups

Regex Named Groups

SERIES_NAME from file header (see Envirosuite example).

 

Note that the SERIES_NAME can be a composite of more than one column value, and/or more than one of the above sources.

 

 

SERIES_UNIT

 

The SERIES_UNIT can come from a (one) column value or a column's header text.

 

Setting

Type

Description

seriesUnitColumnHeaderRegex

Regex

SERIES_UNIT from file column value (see LoggerDatum example).

seriesUnitColumnHeaderRegexGroups

Regex Named Groups

SERIES_UNIT from file column header.

 

 

SERIES_FUNCTION

 

Setting

Type

Description

seriesFunctionColumnHeaderRegexGroups

Regex Named Groups

SERIES_FUNCTION from file column header.

 

 

Note: A series' SERIES_DESC may be changed to something more meaningful; it is displayed in the Live Widgets. The SERIES_NAME (or SERIES_UNIT, and SERIES_FUNCTION, if they are being used) cannot be changed as these are used to identify the series.

Example – By default, when adding new series, this agent sets the series' SERIES_DESC equal to 'Min CO (ppm)', if SERIES_NAME = 'CO', SERIES_UNIT = 'ppm', and SERIES_FUNCTION = 'Min'.

 

 

LOCATION_PARAM_CODE

 

The DT_LOGGER_SERIES.LOCATION_PARAM_CODE can be used to identify multiple series across loggers that record the same type of data. If the location parameter code does not exist (in RT_LOCATION_PARAM_TYPE.PARAM_CODE), it is added (with STATUS_FLAG = 'R'). See updateExistingValues setting for updating the LOCATION_PARAM_CODE values in existing series rows.

 

Setting

Type

Description

locationParamCodeColumnHeaderRegex

Regex

LOCATION_PARAM_CODE from file column value.

locationParamCodeHeaderLinesRegexGroups

Regex Named Groups

LOCATION_PARAM_CODE from file header.

locationParamCodeFileNameRegexGroups

Regex Named Groups

LOCATION_PARAM_CODE from file name.

locationParamCodeDefaultValue

String

LOCATION_PARAM_CODE from default value.

 

 

DEFAULT_DATUM_QUALIFIER

 

The DT_LOGGER_SERIES.DEFAULT_DATUM_QUALIFIER can be used to set the DT_LOGGER_DATUM.DATUM_QUALIFIER of new datum. If the default datum qualifier does not exist (in RT_LOGGER_QUALIFIER.QUALIFIER), it is added (with STATUS_FLAG = 'R'). See updateExistingValues setting for updating the DEFAULT_DATUM_QUALIFIER values in existing series rows.

 

Setting

Type

Description

defaultDatumQualifierColumnHeaderRegex

Regex

DEFAULT_DATUM_QUALIFIER from file column value.

defaultDatumQualifierHeaderLinesRegexGroups

Regex Named Groups

DEFAULT_DATUM_QUALIFIER from file header.

defaultDatumQualifierFileNameRegexGroups

Regex Named Groups

DEFAULT_DATUM_QUALIFIER from file name.

defaultDatumQualifierDefaultValue

String

DEFAULT_DATUM_QUALIFIER from default value.