Manuals > Monitoring System Construction Guide > Building the Main Functions > Daily Reports > Building the Daily Report Function > Using the Quality Check Function

Aggregation Quality Check Configuration Parameters

The quality check for aggregation is set in the parameters of the Aggregation Log section of the Summary Master. In addition, by specifying the QualityCheckTypeFieldMaster parameter, the type of quality check for each tag field can be defined individually on the tag field master side.

■ Check the number of records in raw data (QualityCheckRequiredRecords parameter)

In the aggregation log section, which performs aggregation based on raw data, define the number of raw data records required for aggregation in the QualityCheckRequiredRecords parameter. This setting determines whether the value is unreliable due to a discrepancy in the number of data records.

This parameter should only be specified in the aggregation log section that aggregates data based on raw data.(For example, daily report aggregation using the aggregate log section "RAW::DAY").

If this parameter is not defined or if 0 is specified for it, no check will be performed based on the number of raw data items.

QualityCheckRequiredRecords=3600

■ Specifying the quality check type when counting (QualityCheckType parameter)

The type of quality check processing during aggregation is defined by the QualityCheckType parameter. By setting this parameter, if the data to be aggregated contains NULL values or unreliable values, the aggregated data can be set to unreliable or NULL values. This parameter can be defined for each aggregation log section.

The types of quality checks that can be specified are:

Setting Value	Contents
NONE	No quality check.
NULLTONULL	If there is a NULL value in the source data, it will be treated as a NULL value.
NULLTOBAD	If the source data contains NULL values, they will be treated as unreliable values (such as *123).
BADTONULL	If the source data contains unreliable values (such as *123), the value will be set to NULL.
BADTOBAD	If unreliable values (such as 123) exist in the source data, they will be treated as unreliable values (such as 123).

When the aggregation process is performed, the judgment will be made according to the content specified in this parameter. For example, if "NULLTOBAD" is specified, if there is even one NULL value record in the aggregate target data, the aggregation result will be unreliable.

If you want to apply multiple conditions, you can specify them by enumerating them with commas (e.g. NULLTOBAD,BADTOBAD). Note that if multiple conditions are specified like "XxxTONULL,XxxTOBAD", and both conditions are met (if NULL records exist and untrusted values exist), XxxTONULL will take precedence.

QualityCheckType=NULLTOBAD

■Define the quality check type during aggregation in the tag field master (QualityCheckTypeFieldMaster parameter)

The quality check type during aggregation can also be defined individually for each field in the tag field master. When defining the quality check type in the tag field master, first define the tag field master column name that stores the quality check type definition in the QualityCheckTypeFieldMaster parameter in each aggregation log section of the summary master. Then, prepare a column for the quality check type in the tag field master with the column name specified earlier, and define the check type individually for each field. Note that if both "QualityCheckType" and "QualityCheckTypeFieldMaster" are defined, the tag field master side will take priority for fields in rows where the quality check type is specified in the tag field master. For fields in rows where an empty string is specified as the quality check type, the QualityCheckType from the summary master will be used.

Example

QualityCheckTypeFieldMaster=[QualityCheckType1]

Example of setting the quality check for aggregation

Below is an example of setting up an aggregation quality check.

· RAW data will be logged at 1 second intervals (number of records per hour = 3600).

- The quality check type of the aggregation is defined in the tag field master.

- Display NULL values as "***". For information on customizing the NULL value display, see "Customizing the display method of NULL values".

Summary Master (*Example when RAW data is 1 minute interval)

[COMMON]

: : :

StringOfNullDataForDisplay=***

StringOfNullDataForSubReportExcel=***

StringOfNullDataForSubReportCSV=***

[RAW]

: : :

[RAW::DAY]

SummaryUnit=1HOUR

: : :

QualityCheckRequiredRecords=3600

QualityCheckType=NONE

QualityCheckTypeFieldMaster=[QualityCheckType1]

: : :

[DAY::MONTH]

SummaryUnit=1DAY

: : :

QualityCheckType=NONE

QualityCheckTypeFieldMaster=[QualityCheckType1]

: : :

[MONTH::YEAR]

SummaryUnit=1MONTH

: : :

QualityCheckType=NONE

QualityCheckTypeFieldMaster=[QualityCheckType1]

: : :

Tag Field Master (Example)

[Name],

[Tag],

[DataType],

[QualityCheckType1],

[TermOfValidity],

[DecimalNum1],

[SummaryType1],

[SummaryParam1],

[SummaryType2],

[SummaryParam2],

[ReportHeader1],

[ReportHeader2],

[ReportHeader3],

[ReportHeader4]

T000,

U01.F01.T000,

standard,

NULLTOBAD

AVERAGE,

Factory A,

Line 1,

Voltage,

T001,

U01.F01.T001,

standard,

NULLTOBAD

AVERAGE,

Factory A,

Line 1,

Current,

T002,

U01.F01.T002

standard,

NULLTOBAD

ADDINGCOUNT,

"1000000,IGNOREZERO",

TOTAL,

Factory A,

Line 1,

Amount of power,

kWh

(Explanation) Quality check specifications for each aggregation method

The quality check judgment method for each aggregation method is as follows:

Calculation method, etc.

specification

Common specifications for all log sections

If all data during the aggregation period is a NULL value, the aggregation result will be a NULL value.

When generating aggregate logs from raw data

When generating an aggregate log from raw data (for example, when aggregating daily reports using the aggregation log section "RAW::DAY"), if the number of records in the raw data for the period being aggregated does not match the number defined in the QualityCheckRequiredRecords parameter of the aggregation log section, the aggregation result will be an unreliable value (such as *123).

MIN

MAX

AVERAGE

TOTAL

RANGE

ADDINGTIME

ADDINGTIME2

ADDINGTIME3

ADDINGPLUS

Types of quality checks	Judgment method
NONE	No quality check.
NULLTONULL	If there is a NULL value in the source data, it will be treated as a NULL value.
NULLTOBAD	If the source data contains NULL values, they will be treated as unreliable values (such as *123).
BADTONULL	If the source data contains unreliable values (such as *123), the value will be set to NULL.
BADTOBAD	If unreliable values (such as 123) exist in the source data, they will be treated as unreliable values (such as 123).

START

Types of quality checks	Judgment method
NONE	No quality check.
NULLTONULL	If the data for the start time of the source data is NULL, it will be treated as NULL.
NULLTOBAD	If the data for the start time of the source data is a NULL value, an unreliable value (such as *123) is used.
BADTONULL	If the data for the start time of the source data is an unreliable value (such as *123), the value will be set to NULL.
BADTOBAD	If the data for the start time of the source data is an unreliable value (such as 123), it will be treated as an unreliable value (such as 123).

END

Types of quality checks	Judgment method
NONE	No quality check.
NULLTONULL	If the data for the end time of the source data is NULL, it will be treated as NULL.
NULLTOBAD	If the data for the end time of the source data is a NULL value, an unreliable value (such as *123) is used.
BADTONULL	If the data for the end time of the source data is an unreliable value (such as *123), the value will be set to NULL.
BADTOBAD	If the data for the end time of the source data is an unreliable value (such as 123), it will be treated as an unreliable value (such as 123).

DELTA

Types of quality checks	Judgment method
NONE	No quality check.
NULLTONULL	If the data for the start time or end time of the source data is NULL, it will be treated as NULL.
NULLTOBAD	If the data for the start time or end time of the source data is a NULL value, an unreliable value (such as *123) is used.
BADTONULL	If the start time or end time data of the source data is an unreliable value (such as *123), the value will be set to NULL.
BADTOBAD	If the data for the start time or end time of the source data is an unreliable value (such as 123), it will be treated as an unreliable value (such as 123).

ADDINGCOUNT

Types of quality checks	Judgment method
NONE	No quality check.
NULLTONULL	If the start time (*) or end time data of the source data is NULL, it will be treated as NULL.
NULLTOBAD	If the start time () or end time data of the source data is a NULL value, an unreliable value (such as 123) will be used.
BADTONULL	If the start time () or end time data of the source data is an unreliable value (such as 123), the value will be set to NULL.
BADTOBAD	If the start time () or end time data of the source data is an unreliable value (e.g., 123), it will be treated as an unreliable value (e.g., *123).

*The start time is the time when the previous value exists.

Quality check of the compilation

Quality check of the compilation