Root Log Section

<< Click to Display Table of Contents >>

Manual > Server Creation Guide > Action Edition > Action Reference > Summary Action (Logging/Counting/Daily Report) > Summary Action Configuration File and Folder Structure > Summary Master >

Root Log Section

Route Log Section Property List

Log function related

Parameter Name

(Default value)

subject

Required

Commentary

DaysOfHoldingData

(-1)

CSV/ODBC

 

Number of days root log data is retained.

Setting Value

Contents

-1

According to the setting of the DaysOfHoldingData parameter in the Common Properties section

0

Permanent retention

1 or more

Number of days to keep

 

When retaining data for one year

DaysOfHoldingData =365

 

TagFieldMaster

(Not specified)

CSV/ODBC

Required

The path to the tag field master file, specified relative to the summary folder.

 

TagFieldMaster=fieldmaster_tag.csv

 

TagFieldIndex

(Not specified)

CSV/ODBC

Required

The path to the tag field index file, relative to the summary folder.

 

TagFieldIndex=DB\index_tag.txt

 

CalculationFieldMaster

(Not specified)

CSV/ODBC

 

The path to the Calculated Field Master File, specified as a relative path from the summary folder.

 

CalculationFieldMaster=fieldmaster_calculation.csv

 

CalculationFieldIndex

(Not specified)

CSV/ODBC

 

The path to the calculated field index file, specified as a relative path from the summary folder.

 

CalculationFieldIndex=DB\index_calculation.txt

 

TimeRangeType

(TYPE1)

CSV/ODBC

 

The type of time range to save. It affects the type of time range when TermOfValidity is specified in the tag field master and calculated field master. For more information, see "TermOfValidityDefinition" in the common properties section.

Setting Value

Contents

TYPE1

From the current hour (including the current hour) to the next hour (excluding the next hour)

TYPE2

From the current hour (excluding the current hour) to the next hour (including the next hour)

 

TimeRangeType=TYPE2

 

InvalidValue

(Not specified)

CSV/ODBC

 

Invalid value. If you set an invalid value, it will be logged as an invalid value if the actual value matches an invalid value. If you do not set anything, any value will be saved in the log.

 

InvalidValue=999999

 

CsvFileName

(Not specified)

CSV

Required

The CSV file name to save the log. The actual file name will be appended with the date according to the CsvFileUnit setting. Specify the relative path from the summary folder. Also, do not specify the same folder as other root logs or aggregate logs.

 

CsvFileName=DB\RAW\SMR_RAW_.csv

 

CsvFileUnit

(DAY)

CSV

 

Specifies the unit for saving the file.

Setting Value

Contents

DAY

A file will be created and saved on a daily basis.

MONTH

Files will be created and saved on a monthly basis.

YEAR

Files will be created and saved on an annual basis.

 

CsvFileUnit=DAY

 

hint

If you select DAY, "YYYYMMDD" will be added to the file name. Similarly, if you select MONTH, "YYYYMM" will be added to the file name, and if you select YEAR, "YYYY" will be added to the file name.

 

CsvFileMaxFields

(0)

CSV

 

Specifies the maximum number of tag fields per file.

Setting Value

Contents

0

Do not automatically split files based on the number of tag fields

1 or more

Automatically split files if the number of tags exceeds the maximum number of tag fields you specify

 

hint

CsvFileName=DB\RAW\SMR_RAW_.csv

CsvFileMaxFields=255

In the above example, if there are 1,000 tag fields stored in the tag field master file, they will be split into four files and saved with the following file names.

The first 255

:SMR_RAW_0_20100101.csv

Next 255

:SMR_RAW_1_20100101.csv

Next 255

:SMR_RAW_2_20100101.csv

The remaining 235

:SMR_RAW_3_20100101.csv

 

The actual number of fields in the CSV file will be the number in the example above plus one due to the addition of a time field.

The index of the split file is automatically added after the file name. If you do not specify CsvFileMaxFields, no index number will be added to the file name (i.e. SMR_RAW_20100101.csv).

Do not specify CsvFileMaxFields for aggregate logs. The maximum number of tag fields for aggregate logs follows the specification of the parent root log.

 

CsvFileFlushCount

(1)

CSV

 

Flash settings for CSV files.

Setting Value

Contents

0

The timing of the flush depends on the OS and hardware specifications.

1 or more

Writes the specified number of records to the physical area of the hard disk.

 

OdbcTable

(Not specified)

ODBC

Required

The name of the table in the ODBC database that stores the route logs.

 

OdbcTable=RAW

 

OdbcMaxFields

(0)

ODBC

 

Specifies the maximum number of tag fields per table.

Setting Value

Contents

0

Do not automatically split tables based on the number of tag fields

1 or more

Automatically split tables if the number of tags exceeds the maximum number of tag fields you specify

 

hint

OdbcTable=RAW

OdbcMaxFields=500

In the above example, if the number of tag fields stored in the Tag Field Master File is, for example, 1,000, they will be split and stored in two tables.

The first 500

:RAW0

The remaining 500

:RAW1

 

The actual number of fields in the table will be the number in the above example plus one, since a time field will be added.

The index of the split file is automatically appended after the table name. If you do not specify OdbcMaxFields, no index number will be appended to the table name (i.e. it will be stored in a table called "RAW").

Do not specify OdbcMaxFields for aggregate logs. The maximum number of tag fields for aggregate logs follows the specification of the parent root log.

 

 

Example of a configuration in the root log section

Example: Minimum settings when saving to a CSV file

[RAW]

TagFieldMaster=fieldmaster_tag.csv

TagFieldIndex=DB\index_tag.txt

CsvFileName=DB\LOG01\LOG.csv

CsvFileMaxFields=1000

 

Example) Minimum settings when saving to a ODBC database (Microsoft SQL Server)

[RAW]

TagFieldMaster=fieldmaster_tag.csv

TagFieldIndex=DB\index_tag.txt

OdbcTable=RAW

OdbcMaxFields=500

 

Example: Additional items when using calculated fields

[RAW]

...

CalculationFieldMaster=fieldmaster_calculation.csv

CalculationFieldIndex=DB\index_calculation.txt

...