overview
Summary actions require you to manually create various configuration files using text files.
This section describes the configuration of the summary action folder and setting file.
Download the sample
Sample master files required for setting summary actions are provided.
The sample can be downloaded from below.
Summary action file structure
Here, we will explain the folder and configuration file structure of summary actions using a client connection sample as an example. In the sample, the summary folder is set to "server_data\summary", and various master files are stored under the "server\summary" folder (for client connection samples, please refer to "Client Configuration Guide").
The folders and files are structured as follows:
Summary configuration file folder:
server\summary
master.txt... Summary master file (required)
fieldmaster_tag.csv... Tag field master file (required)
fieldmaster_calculation.csv・・・ Calculation field master file
layoutmaster.xls・・・ Layout master file
Summary Folder:
server_data\summary
|
reportmaster.txt ・・・ Report master file
|
|--- DB
| | index_tag.txt ... tag field index file
| | index_calculation.txt ・・・ Calculation field index file
| |
| | |-- RAW (folder for log data every second)
| | |-- SEC10 (folder for aggregated data every 10 seconds)
| | |-- AVERAGE (folder for average data every minute)
| | |-- MAX (folder for maximum data per minute)
| | |-- MIN (folder for minimum data per minute)
| | |-- DAY (folder for daily report summary data)
| | |-- MONTH (folder for monthly report summary data)
| ...
|
|-- CSV
|-- DAY (Folder for outputting daily report CSV files (sub-report))
|-- MONTH (Folder for outputting monthly report CSV files (sub-report))
|-- YEAR (Annual report CSV file output folder (sub-report))
Among the files in the above folder structure, the four underlined files are the ones that the developer needs to create. Of these, the Calculated Field Master and Layout Master can be omitted if not required. Files and folder structures other than these four files will be automatically created as necessary when the Summary Action is executed.
Below are the master files that the developer needs to define.
file |
Contents |
Summary Master File (Required)
|
A summary master file is a text file that describes the basic settings of the summary action, such as specifying where to save the log data and what kind of aggregation to perform (unit of aggregation, aggregation method, etc.). |
Tag Field Master File (Required)
|
The tag information to be logged is defined as a tag field. The tag field consists of one line per logging. |
Calculated Field Master File |
One of the functions of summary actions is to perform calculations between multiple tag fields when aggregating, and save the calculation results in the aggregated data. The field that defines this calculation is called a "calculated field." Calculated field definitions are written in the calculated field master. This file does not need to be defined if you do not use calculated fields. |
Layout Master File |
This is an Excel file that defines the layout (lines, titles, etc.) of the form used in report printing. This is not necessary if you are not using the report function.
|
Below are the files that the summary action automatically creates as needed.
file |
Contents |
Report Master File |
This file is created when using the report function. It stores definition information such as the page structure of the report and the order of display columns of tag fields (calculated fields) on each page. These settings can be freely changed by the operator during operation from the settings screen of the report screen of FA-Client. The setting information edited from the settings screen is saved in this file each time it is changed. |
Tag Field Index File |
This is index information to identify which column of which CSV file (or ODBC database table) the tag field information is saved in. It is used internally by summary actions.
|
Calculated Field Index File |
This is index information to identify which column of which CSV file (or ODBC database table) the calculated field information is saved in. It is used internally by summary actions.
|
|
In the above folder structure example, the report master file is saved in the summary folder (not in the folder for summary setting files). The reason for the above folder structure is that the report master may be updated by the user after operation starts (through page setting operations on the report screen), so it is necessary to manage it separately from other setting files. For example, after operation starts, when applying setting data changed on a separate PC in the development environment to the actual PC on site, by separating these setting files into folders, the risk of accidentally overwriting the report master updated on site can be avoided.
The above folder structure is an example. There is no problem in terms of specifications if the Report Master file is saved in the same folder as other setting files such as the Summary Master.
|
