Common Properties 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 >

Common Properties Section

Common property section: List of properties

Log function related

Parameter Name

(Default value)

subject

Required

Commentary

DaysOfHoldingData

(0)

CSV/ODBC

 

The default data retention period for all logged and aggregated data.

Setting Value

Contents

0

Permanent retention

1 or more

Number of days to keep

 

When retaining data for one year

DaysOfHoldingData =365

 

hint

If you want to specify a different number of days to hold data for each log, specify DaysOfHoldingData for each log section. If DaysOfHoldingData is specified in both [COMMON] and each log section, the setting in the log section takes precedence.

 

TermOfValidityDefinition{n}

(Not specified)

 

CSV/ODBC

 

Defines the validity period for logging. This is defined when you want to collect data only for a certain period. You can define multiple periods by specifying a number in the {n} part. By specifying this validity period number in the [TermOfValidity] column of the tag field master, you can specify the period for which you want to save data for each tag. The format is as follows:

 

TermOfValidityDefinition{n}=yyyy/mm/dd h:m:s - yyyy/mm/dd h:m:s [Wx]

▪{n} is the validity period number starting from 1.

▪You can use && to take multiple forms of And.
Example) xxx && xxx && xxx

▪You can use || to OR multiple formats.
Example) xxx || xxx || xxx

▪You can take the OR of multiple And conditions.
Example) xxx && xxx || xxx && xxx || xxx && xxx

▪You cannot use operators other than those mentioned above, such as parentheses () or +-*/.

▪You can specify the day of the week with [Wx]. For x, specify the following: 1: Sunday, 2: Monday, 4: Tuesday, 8: Wednesday, 16: Thursday, 32: Friday, 64: Saturday.

 

1: Daytime 2: Nighttime

TermOfValidityDefinition1=*/*/* 8:*:* - */*/* 21:*:*

TermOfValidityDefinition2=*/*/* 22:*:* - */*/* 7:*:*

1: Daytime 2: Nighttime 3: Peak hours (taking into account seasonal hours)

TermOfValidityDefinition1=*/7/1 *:*:* - */9/30 *:*:* && */*/* 8:*:* - */*/* 12:*:* || */7/1 *:*:* - */9/30 *:*:* && */*/* 16:*:* - */*/* 21:*:* || */10/1 *:*:* - */6/30 *:*:* && */*/* 8:*:* - */*/* 21:*:*

TermOfValidityDefinition2=*/*/* 22:*:* - */*/* 7:*:*

TermOfValidityDefinition3=*/7/1 *:*:* - */9/30 *:*:* && */*/* 13:*:* - */*/* 15:*:*

 

hint

Even if TimeRangeType is TYPE2, define it assuming TYPE1. If TYPE2 is specified, the time zone will be automatically adjusted as shown in the example below.

Example 1) */*/* 8:*:* - */*/* 22:*:*

For TYPE1, the time will be adjusted to 8:00:00-22:59:59, and for TYPE2, the time will be adjusted to 8:00:01-23:00:00.

 

Example 2) */*/* 8:0:0 - */*/* 22:59:59

For TYPE2, it will automatically be adjusted to 8:00:01-23:00:00.

 

Example 3) */*/* *:*:* - */*/* *:*:* W62

Monday to Friday (2+4+8+16+32=62). For TYPE1, the date is 00:00:00-23:59:59, for TYPE2, the date is 00:00:01-next day is 00:00:00)

 

Example 4) */7/1 *:*:* - */9/30 *:*:* && */*/* 8:*:* - */*/* 22:*:*

The period is the same as Example 1, from July 1st to September 30th.

 

TermOfValidityType

(TYPE1)

CSV/ODBC

 

Specifies how to process the data collection/aggregation time period when using TermOfValidityDefinition. This parameter affects the accumulation process using the accumulation counter value (ADDINGCOUNT), accumulation time value (ADDINGTIME/ADDINGTIME2/ADDINGTIME3), and accumulation pulse value (ADDINGPULSE).

 

Setting Value

Contents

TYPE1

In the accumulation process, values that change outside the period being accumulated will also be accumulated.

TYPE2

In the accumulation process, values that change outside the time period being accumulated will not be accumulated. For example, if you want to accumulate measurement data such as usage amounts separately for day and night, specify "TYPE2".

 

TermOfValidityType=TYPE2

 

PowerfactorMaxMinType

(TYPE1)

CSV/ODBC

 

How to calculate maximum and minimum power factor values.

Setting Value

Contents

TYPE1

Minimum value: Power factor close to -0.5 in the negative direction / Maximum value: Power factor close to 0.5 in the positive direction

TYPE2

Minimum value: Power factor whose absolute value is farthest from 1 (100%) / Maximum value: Power factor whose absolute value is closest to 1 (100%)

 

PowerfactorMaxMinType=TYPE2

 

AddingCountIgnoreType

(TYPE1)

CSV/ODBC

 

The aggregation method when IGNOREZERO/IGNORENUM is specified in the aggregation method ADDINGCOUNT.

Setting Value

Contents

TYPE1

If all values in the aggregation range are excluded, the aggregate value will be 0.

TYPE2

If all values in the aggregation range are excluded, the aggregated value will be an invalid value (NULL).

 

AddingCountIgnoreType=TYPE2

 

MaintenanceASync

(T)

CSV/ODBC

 

Maintenance (auto-delete) sync mode.

Setting Value

Contents

T

Asynchronous

F

Synchronization

 

MaintenanceASync=F

 

MaintenanceDelayTime

(610)

CSV/ODBC

 

The delay from the change of days for performing maintenance (in seconds).

Setting Value

Contents

0

Run immediately after the date changes

1 or more

Delay from day change (seconds)

 

MaintenanceDelayTime=0

 

MaintenanceStartup

(F)

CSV/ODBC

 

Will maintenance be performed immediately after going online?

Setting Value

Contents

T

Perform maintenance.

F

No maintenance is performed.

 

MaintenanceStartup=T

 

OdbcDatabaseType

(Not specified)

 

ODBC

Required

ODBCDatabase type. The following database types can be specified:

Database Product Name

Database Type

SQL Server

SQLSERVER

Oracle

ORACLE

MySQL

MYSQL

PostgreSQL

POSTGRESQL

*Please check Operating Environment for compatible versions.

 

OdbcDatabaseType=SQLSERVER

 

OdbcSchema

(Not specified)

 

ODBC

 

ODBC The name of the database schema. Set this if you want to use a schema other than the default one for the database.

 

OdbcSchema=XXX (the name of the schema you want to specify)

 

attention

Do not specify this parameter when connecting to MySQL.

 

OdbcCreatedTimeFieldName

(CREATEDTIME)

 

ODBC

 

Field name of the time field. Usually, this setting is not necessary.

 

OdbcCreatedTimeFieldName=XXX (field name you want to specify)

 

attention

The name has been changed from OdbcDateTimeFieldName from Rev7. The old name will still work.

 

OdbcCreatedTimeDataType

(Automatically selected by OdbcDatabaseType)

 

ODBC

 

Data type of the time field. Normally, this setting is not necessary.

Database Type

Default value

SQLSERVER

DATETIME PRIMARY KEY

ORACLE

DATE PRIMARY KEY

MYSQL

DATETIME PRIMARY KEY

POSTGRESQL

TIMESTAMP PRIMARY KEY

 

OdbcCreatedTimeDataType=XXX (data type you want to specify)

 

attention

The name has been changed from OdbcDateTimeDataType from Rev7. The old name still works.

 

OdbcFaultedTimeFieldName

(FAULTEDTIME)

ODBC

 

If the time cannot be saved to the sub side during duplication, the time field name for synchronization. Normally, this setting is not necessary.

 

OdbcFaultedTimeFieldName=XXX (field name you want to specify)

 

OdbcFaultedTimeDataType

(Automatically selected by OdbcDatabaseType)

ODBC

 

If the data cannot be saved to the secondary side during duplication, this is the data type of the time field for synchronization. Normally, this setting is not required.

Database Type

Default value

SQLSERVER

DATETIME

ORACLE

DATE

MYSQL

DATETIME

POSTGRESQL

TIMESTAMP

 

OdbcFaultedTimeDataType=XXX (data type you want to specify)

 

OdbcValueFieldName

(empty text)

ODBC

 

Field name of the value field. Usually, this setting is not necessary.

 

hint

If you specify this setting, it will be added to the beginning of the field name of the tag field master. For example, if you specify the following, the field names defined in the database table will be "ABCF0001" and "ABCF0002".

Summary master file

OdbcValueFieldName=ABC

Tag field master file

[Name],[Tag]

F001,U01.F01.T000

F002,U01.F01.T001

 

OdbcValueDataType

(Automatically selected by OdbcDatabaseType)

ODBC

 

Data type of the value field. Normally, this setting is not necessary.

Database Type

Default value

SQLSERVER

FLOAT

ORACLE

BINARY_DOUBLE

MYSQL

DOUBLE

POSTGRESQL

DOUBLE PRECISION

 

OdbcValueDataType = XXX (data type you want to specify)

 

OdbcRestoreASync

(T)

ODBC

 

Synchronization mode for repair. Normally, this setting is not necessary.

Setting Value

Contents

T

Asynchronous

F

Synchronization

 

OdbcRestoreASync=F

 

OdbcRestoreThreadQueue

(0)

ODBC

 

The maximum number of threads to use when repairing. Normally, this setting is not necessary.

Setting Value

Contents

0

By database

1 or more

Maximum Threads

 

OdbcRestoreThreadQueue=4

 

OdbcRestoreInsertQueue

(0)

ODBC

 

The number of INSERT statements queued during repair. Normally, this setting is not necessary.

Setting Value

Contents

0

By database

1 or more

Number of INSERT statements in the queue

 

OdbcRestoreInsertQueue=10

 

OdbcRestoreSelectLimit

(0)

ODBC

 

Maximum LIMIT number for SELECT during repair. Normally, this setting is not necessary.

Setting Value

Contents

0

By database

1 or more

Maximum LIMIT number

 

OdbcRestoreSelectLimit=100

 

OdbcModifyASync

(T)

ODBC

 

Synchronization mode for re-aggregation. Normally, this setting is not necessary.

Setting Value

Contents

T

Asynchronous

F

Synchronization

 

OdbcModifyASync=F

 

OdbcModifyThreadQueue

(0)

ODBC

 

The maximum number of threads to use when re-aggregating. Normally, this setting is not necessary.

Setting Value

Contents

0

By database

1 or more

Maximum Threads

 

OdbcModifyThreadQueue=4

 

 

 

Report function related

Parameter Name

(Default value)

subject

Required

Commentary

ReportHeaders

(4)

CSV/ODBC

 

Number of header lines in the summary report (1-5).

 

ReportHeaders =2

 

 

 

Quality check function related

 

hint

By enabling the quality check function of summary actions, if the source data is missing or contains unreliable values, the aggregated data can be treated as unreliable values such as "*123". For details on the quality check function, see "Using the quality check function". In addition, if the aggregated data is NULL, you can display it on the daily report screen as a specified string such as "***", and you can also set the NULL value to the specified string for the output data of the CSV or Excel file of the subreport. For information on how to specify the display string for NULL values, see "Customizing the display method of NULL values".

 

Parameter Name

(Default value)

subject

Required

Commentary

StringOfNullDataForDisplay

(Not specified)

CSV/ODBC

 

The string to be displayed on the report screen when the aggregated value is NULL.

 

StringOfNullDataForDisplay=***

 

hint

If this parameter is not specified, or if the parameter is left blank, it will be displayed blank (note that it is not "")

 

StringOfNullDataForDisplay=

 

 

StringOfNullDataForSubReportExcel

(Not specified)

CSV/ODBC

 

The string to be output to the subreport (Excel) when the summary value is NULL.

 

StringOfNullDataForSubReportExcel=***

 

hint

The method for specifying blanks is the same as for "StringOfNullDataForDisplay" above.

 

StringOfNullDataForSubReportCSV

(Not specified)

CSV/ODBC

 

The string to output to the subreport (CSV) when the aggregate value is NULL.

 

StringOfNullDataForSubReportCSV=***

 

hint

The method for specifying blanks is the same as for "StringOfNullDataForDisplay" above.

 

ShowQualityForSubReportExcel

(T)

CSV/ODBC

 

If the value is unreliable, whether to output the subreport (Excel) with the unreliable value flag "*".

 

Setting Value

Contents

T

If the value is unreliable, add the unreliable value flag "*". Example: *123

F

If the value is unreliable, it will not be displayed as unreliable. Example: 123

 

ShowQualityForSubReportExcel=F

 

ShowQualityForSubReportCSV

(T)

CSV/ODBC

 

If the value is untrusted, whether to output a subreport (CSV) with the untrusted value flag "*".

 

Setting Value

Contents

T

If the value is unreliable, add the unreliable value flag "*". Example: *123

F

If the value is unreliable, it will not be displayed as unreliable. Example: 123

 

ShowQualityForSubReportCSV=F

 

OdbcQualityCheckDataType

 

ODBC

 

The data type of the field that stores the quality check value.

 

The following default values are automatically adopted depending on the type of DBMS to connect to. Normally, this setting is not necessary. Specify it if you want to intentionally change the field size.

 

DBMS

Contents

SQLSERVER

VARCHAR(1000)

ORACLE

VARCHAR2(1000)

MYSQL

VARCHAR(1017)

POSTGRESQL

VARCHAR

 

OdbcQualityCheckDataType=VARCHAR(500)

 

OdbcQualityCheckFieldName

(QUALITYCHECK)

 

ODBC

 

The field name of the field that stores the quality check value.

 

OdbcQualityCheckFieldName=QUALITYCHECK

 

ActiveExpressionQualityCheckType

(NONE)

 

CSV/ODBC

 

The default value for the type of quality check in the dynamic calculation of the field. If you want to apply multiple conditions, list them with commas.

Example: NULLTOBAD,BADTOBAD

 

Setting Value

Contents

NONE

No quality check.

NULLTONULL

If a NULL value exists in the calculation data, it is treated as a NULL value.

NULLTOBAD

If a NULL value is present in the calculation data, it is treated as an unreliable value (such as *123).

BADTONULL

If the calculation data contains unreliable values (such as *123), the value is treated as NULL.

BADTOBAD

If an unreliable value (such as *123) is present in the calculated data, it is treated as an unreliable value (such as *123).

 

If multiple conditions are specified, such as "XxxTONULL,XxxTOBAD", and both conditions are met (NULL records exist and untrusted values exist), XxxTONULL will take precedence.

 

For details about dynamic calculations, please refer to "Dynamic calculations in fields (specifying calculation formulas when registering points)".

 

ActiveExpressionQualityCheckType=NULLTOBAD

 

 

 

Common property section configuration example

Example: Minimum settings when saving to a CSV file

[COMMON]

DaysOfHoldingData=365

 

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

[COMMON]

DaysOfHoldingData=365

OdbcDatabaseType=SQLSERVER

 

Example) When the aggregate value is NULL, the daily report screen and subreport are displayed as "***"

[COMMON]

DaysOfHoldingData=365

StringOfNullDataForDisplay=***

StringOfNullDataForSubReportExcel=***

StringOfNullDataForSubReportCSV=***