Aggregation log section property list
Aggregation function related
Parameter Name (Default value) |
subject |
Required |
Commentary |
|||||||||||||||||||||||||||||
DaysOfHoldingData (-1) |
CSV/ODBC |
|
Number of days aggregate log data is retained.
|
|||||||||||||||||||||||||||||
SummaryUnit (Not specified) |
CSV/ODBC |
Required |
The unit of time for the aggregation.
|
|||||||||||||||||||||||||||||
SummaryType (Not specified) |
CSV/ODBC |
|
Specify the aggregation method.
In this case, specify the aggregation method in the tag field master as follows:
|
|||||||||||||||||||||||||||||
SummaryParam (Not specified) |
CSV/ODBC |
|
Specifying aggregation parameters.
In this case, specify the aggregation method in the tag field master as follows:
|
|||||||||||||||||||||||||||||
SummaryOffset (0) |
CSV/ODBC |
Specify this parameter if you want to offset the aggregation time.
The units of SummaryOffset (hours, days, etc.) are determined by the unit specified in SummaryUnit (MIN, HOUR, DAY, etc.) and are as follows: For example, if "SummaryUnit=1MONTH", MONTH is specified, so the unit of SummaryOffset is one day, and if "SummaryOffset=1" is specified, it will be offset by one day.
|
||||||||||||||||||||||||||||||
CalculationType ([Expression]) |
CSV/ODBC |
If you want to log calculations, specify the calculation method. For information about calculation fields, see "Calculation Field Master".
An example of calculating field master settings.
|
||||||||||||||||||||||||||||||
CalculationParam (Not specified) |
CSV/ODBC |
|
Specify the aggregation parameters for the calculation log.
An example of calculating field master settings.
|
|||||||||||||||||||||||||||||
TimeRangeType (TYPE1) |
CSV/ODBC |
The type of time range to save when aggregating.
|
||||||||||||||||||||||||||||||
DecimalNum (-1) |
CSV/ODBC |
Specify the number of decimal places.
In this case, you can specify the number of decimal points for each field in the tag field master as follows:
|
||||||||||||||||||||||||||||||
SearchMaxPrevMins (Not specified) |
CSV/ODBC |
If this parameter is specified, the calculation method (ADDINGCOUNT/ADDINGTIME/ADDINGTIME2/ADDINGTIME3/ADDINGPULSE) will search back to the specified minute period when calculating, and if no valid value is found, it will calculate assuming that no previous value exists. If this parameter is not specified, the search will continue until a valid value is found.
|
||||||||||||||||||||||||||||||
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.
|
|||||||||||||||||||||||||||||
CsvFileUnit (DAY) |
CSV |
Specifies the unit for saving the file.
|
||||||||||||||||||||||||||||||
CsvSearchMaxPrevRecords (10000) |
CSV |
When calculating the cumulative value (ADDINGCOUNT), if the specified record search does not find the value, the previous value will be used as 0. If no value is specified, the default value will be 10000.
|
||||||||||||||||||||||||||||||
OdbcSearchMaxPrevRecords (100) |
ODBC |
When calculating the cumulative value (ADDINGCOUNT), if the specified record search does not find the value, the previous value will be set to 0. If no value is specified, the default value will be 100.
|
||||||||||||||||||||||||||||||
OdbcTable (Not specified) |
ODBC |
Required |
The name of the table in the ODBC database where the logs will be saved.
|
|||||||||||||||||||||||||||||
SummaryASync (F) |
ODBC |
The synchronization mode for the aggregation.
|
Report function related
Parameter Name (Default value) |
subject |
Required |
Commentary |
|||||||||||
ReportLayoutMaster (Not specified) |
CSV/ODBC |
Required |
The path to the layout master file, specified relative to the summary folder.
|
|||||||||||
ReportLayoutMasterSheet (Not specified) |
CSV/ODBC |
|
The sheet name to use when printing.
|
|||||||||||
ReportOutputSheetName (Not specified)
|
CSV/ODBC |
|
The name of the sheet when outputting to an Excel file as a subreport.
|
|||||||||||
ReportPrinter ((default)) |
CSV/ODBC |
|
Name of the printer to use when printing reports. If you want to use the default printer set in the OS, specify "(default)".
|
|||||||||||
ReportExcel (F) |
CSV/ODBC |
|
Set whether to use formulas and graphs in the Layout Master File.
|
|||||||||||
ReportTitleHeader (Not specified) |
CSV/ODBC |
|
The report title header.
|
|||||||||||
ReportTitleFooter (Not specified) |
CSV/ODBC |
|
The report title footer.
|
|||||||||||
ReportTitleTotal (Not specified) |
CSV/ODBC |
|
Specifies the title string (total) to be displayed in the summary row of the report. If you specify a keyword (**F_TitleTotal) in the layout master, the value of this property will be output when printing or when outputting to a Excel file. If you specify a string in TitleTotal of Summary report grid control, that will take priority when displayed on the screen. |
|||||||||||
ReportTitleAverage (Not specified) |
CSV/ODBC |
|
Specifies the title string (average) to be displayed in the summary row of the report. If a keyword (**F_TitleAverage) is specified in the layout master, the value of this property will be output when printing or when outputting to a Excel file. Note that if a string is specified in TitleAverage of Summary report grid control, that will take priority when displayed on the screen. |
|||||||||||
ReportTitleMax (Not specified) |
CSV/ODBC |
|
Specifies the title string (maximum) to be displayed in the summary row of the report. If you specify a keyword (**F_TitleMax) in the layout master, the value of this property will be output when printing or when outputting to a Excel file. Note that if you specify a string in TitleMax of Summary report grid control, that will take priority when displayed on the screen. |
|||||||||||
ReportTitleMin (Not specified) |
CSV/ODBC |
|
Specifies the title string (minimum) to be displayed in the summary row of the report. If you specify a keyword (**F_TitleMin) in the layout master, the value of this property will be output when printing or when outputting to a Excel file. If you specify a string in TitleMin of Summary report grid control, that will take priority when displayed on the screen. |
|||||||||||
ReportTitleLoadFactor (Not specified) |
CSV/ODBC |
|
Specifies the title string (load factor) to be displayed in the summary row of the report. If you specify a keyword (**F_TitleLoadFactor) in the layout master, the value of this property will be output when printing or when outputting to a Excel file. If you specify a string in TitleLoadFactor in Summary report grid control, that will take priority when displayed on the screen. |
|||||||||||
ReportExcelCellFormatType (formatednum) |
CSV/ODBC |
|
Cell formatting when outputting to Excel. For details, please refer to "About supported Excel cell formats".
|
|||||||||||
ReportOffset (0) |
CSV/ODBC |
|
Specify this when you want to change the display start time (date and time) in the report display. You cannot specify a negative value for this parameter.
The units of ReportOffset (hours, days, etc.) are determined by the units specified in SummaryUnit (MIN, HOUR, DAY, etc.) and are as follows: For example, if "SummaryUnit=1HOUR", HOUR is specified, so the units of ReportOffset are in units of one hour, and if "ReportOffset=1" is specified, it will be offset by one hour.
|
|||||||||||
(0) |
CSV/ODBC |
Specify this when you want to change the reference time (date and time) of the report.
Normally, the reference time and the time of the actual data are in the same time series, but if you want to shift the date and time specified when referencing aggregated data from the date and time of the referenced data, specify this parameter. For example, if you set this parameter to "1" in the aggregated log section of the monthly report, the reference time will be processed as being the date and time that is one month larger (for example, if April is specified as the reference time, the aggregated data for March will be used). The reference time (the time after the offset) is used in the start reference time and end reference time of the event parameters.
・Event: CREATESUBREPORT / PRINTREPORT
When specifying the start and end reference times in relative time for an event, if you specify the keyword "[REFERENCEOFFSET]", the value specified with ReferenceOffset will be embedded with a plus or minus sign.
Example) Example of specifying the start and end times of the event parameters Daily report: ...,DAY-1D[REFERENCEOFFSET]D,DAY[REFERENCEOFFSET]D,... Monthly report: ...,MONTH-1MO[REFERENCEOFFSET]MO,MONTH[REFERENCEOFFSET]MO,... Annual report: ...,YEAR+1Y[REFERENCEOFFSET]Y,YEAR[REFERENCEOFFSET]Y,...
Furthermore, the units of ReferenceOffset (hours, days, etc.) are determined based on the units specified in SummaryUnit (MIN, HOUR, DAY, etc.) and are as follows: For example, if "SummaryUnit=1HOUR", HOUR is specified, so the units of ReferenceOffset are in days, and if "ReferenceOffset=1" is specified, it will be offset by 1 day.
■ What is reference time?
The reference time refers to the date and time specified when specifying the range of aggregated data to be processed from various functions that access aggregated data. For example, when retrieving aggregated data such as Daily/Monthly/Yearly Report from a daily report screen and displaying it on a screen, the target aggregated data is displayed by specifying the date of the report you want to refer to on the screen, and the date specified here is the reference time.
For example, if you set the ReportOffset parameter in the monthly report aggregation log section as shown below, the generated monthly report aggregation data will be from the 10th to the 9th of the following month.
[DAY::MONTH] SummaryUnit=1DAY ReportOffset=10
If you do not specify ReferenceOffcet above, and specify "April" as the start reference time for PRINTREPORT and "May" as the end reference time, the monthly report data to be processed will be data from April 10 to May 9. If this specification does not meet your requirements, there is no need to specify the ReferenceOffset parameter.
On the other hand, if you want to treat the monthly report data from April 10th to May 9th as "May" instead of "April" due to user requirements, you can use the ReferenceOffcet parameter as follows.
[DAY::MONTH] SummaryUnit=1DAY ReportOffset=10 ReferenceOffset=1
By setting it up as above, if you specify "May" as the start reference time for PRINTREPORT etc. and "June" as the end reference time, the monthly report data to be processed will be data from April 10th to May 9th.
|
||||||||||||
ReportTitleDateFormat (Not specified) |
CSV/ODBC |
|
Report date format. This is the format used for dates when printing and displaying on the screen.
▪If you specify a format in Summary report grid control's TitleDateFormat, it will take precedence when displayed on the screen. ▪When printing or outputting to a Excel file, the date data type is output as a string. If you do not specify anything in ReportTitleDateFormat, the data type will be output as a date type. However, in that case, you must specify the format in TitleDateFormat in Summary report grid control. ▪You can specify the date and time format (free format) for this parameter. For details on the format, see "Date and time format (free format)".
|
|||||||||||
ReportReferenceDateFormat (Not specified) |
CSV/ODBC |
|
You can specify the date and time format for the report's reference date when printing. For details on the format, please refer to "Date and time format (free format)".
|
Quality check function related
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 about the quality check function, see "Using the quality check function". |
Parameter Name (Default value) |
subject |
Required |
Commentary |
|||||||||||||||
QualityCheckRequiredRecords (0) |
CSV/ODBC |
|
The number of pieces of raw data required for each aggregated record. For example, if raw data is logged at one-minute intervals, the number of records for one hour will be 60.
If you define this parameter, for example when performing daily report aggregation from raw data, if the number of data items to be aggregated for one hour does not match the number specified in this parameter, it will be considered an anomaly and an unreliable value flag "*" will be added to the aggregated data. If you do not define this parameter or specify 0 for this parameter, no check will be made based on the number of data items to be aggregated.
This parameter should only be specified in the aggregation log section that performs aggregation based on raw data (e.g., [RAW::DAY]).
|
|||||||||||||||
QualityCheckType (NONE)
|
CSV/ODBC |
|
The type of quality check in the tag field master and the calculated field master (when "CalculationType=[SummaryType{n}]" is specified in the aggregation log section of the summary master). If you want to apply multiple conditions, list them with commas. Example: NULLTOBAD,BADTOBAD
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. In addition, fields with TermOfValidity set are not subject to quality checks and behave the same as NONE.
|
|||||||||||||||
QualityCheckTypeFieldMaster (Not specified)
|
CSV/ODBC |
|
If you want to specify the QualityCheckType individually for each field in the tag field master and calculation field master (when "CalculationType=[SummaryType{n}]" is specified), specify the column name of the tag field master (and calculation field master) in this parameter.
|
|||||||||||||||
ExpressionQualityCheckType (NONE)
|
CSV/ODBC |
|
The type of quality check in the calculation expression in the calculation field master (when "CalculationType=[Expression]" is specified). If you want to apply multiple conditions, list them with commas. Example: NULLTOBAD,BADTOBAD
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. In addition, if you specify "F" in the [UncertainIsZero] column of the calculation field master, the calculation result will be NULL if a NULL value exists. For more information on this matter, please refer to the description in "Calculation Field Master".
|
|||||||||||||||
ExpressionQualityCheckTypeFieldMaster (Not specified)
|
CSV/ODBC |
|
In static calculations using calculated fields, if you want to specify the ExpressionQualityCheckType for each field individually, specify the column name of the calculated field master.
|
Example of aggregate log section settings
Example: Minimum settings when saving to a CSV file
[RAW::AVERAGE] CsvFileName=DB\AVRAGE\SMR_AVERAGE_.csv CsvFileUnit=DAY SummaryType=AVERAGE SummaryUnit=1MIN |
Example) Minimum settings for saving to a ODBC database
[RAW::AVERAGE] ODBCTable=AVERAGETABLE SummaryType=AVERAGE SummaryUnit=1MIN |
Example: Minimum settings when using the report function
[RAW::DAY] CsvFileName=DB\DAY\SMR_DAY_.csv CsvFileUnit=DAY DecimalNum=[DecimalNum1] TimeRangeType=TYPE2 SummaryType=[SummaryType1] SummaryParam=[SummaryParam1] SummaryUnit=1HOUR ReportLayoutMaster=layoutmaster.xls ReportLayoutMasterSheet=DAY ReportTitleDateFormat=@[%H hour] |
Example: Additional items when using calculated fields
[RAW::DAY] ... CalculationType=[Expression] ...
[DAY::MONTH] ... CalculationType=[SummaryType1] ...
[MONTH::YEAR] ... CalculationType=[SummaryType1] ...
|
Example) Setting example when using the quality check function (*When RAW data is 1 minute interval)
[RAW::DAY] QualityCheckRequiredRecords=60 QualityCheckType=NULLTOBAD QualityCheckTypeFieldMaster=[QualityCheckType1] ExpressionQualityCheckType=NULLTOBAD ExpressionQualityCheckTypeFieldMaster=[ExpressionQualityCheckType1]
[DAY::MONTH] QualityCheckType=NULLTOBAD QualityCheckTypeFieldMaster=[QualityCheckType1] ExpressionQualityCheckType=NULLTOBAD ExpressionQualityCheckTypeFieldMaster=[ExpressionQualityCheckType1]
[MONTH::YEAR] QualityCheckType=NULLTOBAD QualityCheckTypeFieldMaster=[QualityCheckType1] ExpressionQualityCheckType=NULLTOBAD ExpressionQualityCheckTypeFieldMaster=[ExpressionQualityCheckType1] |
Starting with Ver6, it is now possible to specify "Date and time format (free format)" as a format that can be specified for the ReportTitleDateFormat parameter. This parameter definition is upward compatible and will also work with older formats, but unless there is a special reason, we recommend that you specify the date and time format (free format).
The old formats that can be specified for ReportTitleDateFormat are as follows.
|