Summary Master Definition
The Summary Master file (master.txt) is a text file that describes the basic settings for a Summary action.When using summary actions, developers must define this master file..
The format of the Summary Master is a standard Windows INI file.
For example, the standard framework for the frame library is defined as follows (partial excerpt):
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;Common information definition [COMMON] DaysOfHoldingData=3660 ReportHeaders=4
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;Root log definition
[RAW] TagFieldMaster=..\..\server\summary\fieldmaster_tag.csv TagFieldIndex=DB\index_tag.txt CalculationFieldMaster=..\..\server\summary\fieldmaster_calculation.csv CalculationFieldIndex=DB\index_calculation.txt ...
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ; Aggregation log definition
[RAW::DAY] CsvFileName=DB\DAY\SMR_DAY_.csv CsvFileUnit=DAY ...
[DAY::MONTH] CsvFileName=DB\MONTH\SMR_MONTH_.csv CsvFileUnit=MONTH ...
[MONTH::YEAR] CsvFileName=DB\YEAR\SMR_YEAR_.csv CsvFileUnit=YEAR ...
|
The definition of the summary master consists of three sections: "Common property section", "Root log section", and "Aggregation log section". The definition name of the root log section ("RAW" in the above definition example) is called the "summary name", and is an important name used as the definition name when referencing historical data. In addition, in the case of the aggregation log section, the string on the right side of the definition name written in the header separated by "::" becomes the summary name, and is an important name for distinguishing and referencing the aggregated data. For example, if the definition name is [RAW::DAY], then "DAY" is the summary name.
The common properties section ([COMMON]) sets properties common to summary actions.
For example, one of the common properties is "DaysOfHoldingData." If you define "DaysOfHoldingData=365," the log data retention period will be 365 days, and log data older than 365 days will be automatically deleted.
The root log section ([Summary name]) defines how to save the root log (raw data). The root log is the most basic historical data for creating aggregate logs. In the above definition example, the name is defined as "RAW", so "RAW" will be the summary name. This definition name can be anything other than RAW.
The aggregation log section ([Parent summary name::Summary name]) defines how to save the aggregation log. The parent summary name is the summary name that is the basis for the aggregation. Not only the root log but also the aggregation log can be specified as the parent summary name. For example, to create a monthly report, if you specify the daily report aggregation log as the parent summary name, such as [DAY::MONTH], the daily report aggregation data will be aggregated and lifted up to the monthly report aggregation data (rather than aggregating RAW). Also, if you specify [DAY::MONTH], the summary name will be "MONTH".If you do not perform aggregation processing, you do not need to define the aggregation log section..
You can also define multiple root log sections and aggregate log sections, as shown in the image below.
[COMMON] Property name = Setting value ... [Summary name 1] Property name = Setting value ... [Summary name 1::Summary name 2] Property name = Setting value ... [Summary name 2:: Summary name 3] Property name = Setting value ... [Summary name 3:: Summary name 4] Property name = Setting value ... [Summary name 5] Property name = Setting value ... [Summary name 5::Summary name 6] Property name = Setting value ... |
|
You can define multiple root logs. For example, you can separate logs that are saved at slow intervals from logs that are saved at fast intervals. If the root log names are RAW1 and RAW2, define two events for slow and fast speeds, and specify "LOG(RAW1)" and "LOG(RAW2)" in the event parameters. For details about event parameters for summary actions, see "Event Settings". |
|
You can also add or delete root log sections and aggregate log sections after the system has started operating. If you modify the summary master after the system has started operating, you must take FA-Server offline and then back online to apply the modifications. |
|
When using Daily/Monthly/Yearly Report from the report screen of FA-Client, the summary name of Daily/Monthly/Yearly Report must be defined as "DAY", "MONTH", and "YEAR" (for example, "RAW::DAY", "DAY::MONTH", and "MONTH::YEAR"). |