Event Settings

<< Click to Display Table of Contents >>

Manual > Server Creation Guide > Action Edition > Action Reference > Summary Actions (Logging/Counting/Daily Reports) >

Event Settings

Event Settings

To execute a summary action, you must register an event that will trigger the summary action.

 

The logging process for summary actions is controlled by the frequency at which the event is called. For example, if you want to log at a 1 second frequency, the most common setup is to create a single Scheduled event that fires every second and specify the summary action as the execution action.

 

This event marks the logging cycle for the route log (RAW, raw data).

 

Example of 1 second cycle (generated every second with Scheduled event)

c_action_0302

 

If there is only one root log, you only need to specify the action name of the summary action in the event execution action; there is no need to specify any parameters.

 

c_action_0303

 

The image above is an example of specifying "Summary" as the action name.

 

 

hint

The minimum logging period for summary actions is one second.

 

 

When logging to multiple route logs at different intervals

By specifying parameters when calling from an event, you can specify different log intervals for multiple root logs.

 

If you have defined two or more route logs in the Summary Master File, you can set the period for each route log separately as follows:

 

 

Example) If two route logs, RAW1/RAW2, are defined and you want to log at 1 minute and 5 minute intervals, respectively

 

1.In the Summary Master definition, register two root logs with the names "RAW1" and "RAW2".

 

2.Define two Periodic event that call summary actions. In this example, we call them "E01" and "E02".

 

3.Set the E01 cycle to 1 minute and specify "LOG(RAW1)" as the execution action parameter.

 

c_action_0304

 

4.Set the cycle of E02 to 5 minutes and specify "LOG(RAW2)" as the execution action parameter.

 

c_action_0305

 

 

 

Event Parameter List

Summary actions can have parameters specified when they are called by an event.

Event parameters are specified as strings in the "Parameters" field on the "Action" tab of the event setting screen.

 

c_action_logger_0118

 

 

Summary action parameters include the following types. You can perform logging for multiple route logs at different log intervals, automatically print reports, output sub-report files, and more.

 

Parameter Characters

Operation

(Not specified)

If no parameter is specified, logging will be performed for all route logs.

 

LOG(Root log name)

If you have defined two or more route logs in the Summary Master File, use this parameter if you want to set the cycle for each route log separately.

 

Example: LOG(RAW1)

 

PRINTREPORT(

Report Master,

Summary name,

Start reference time,

End reference time,

Group ID,

Page ID,

Printer name,

Preview screen,

Print start waiting time,

Waiting for printing to finish,

[Page target number = 0],

[Show progress bar] = T)

 

Automatic printing will be performed.

 

Example) Scheduled event (set at 0:05 every day) outputs the previous day's daily report

PRINTREPORT(reportmaster.csv,DAY,DAY-1D, DAY,-1,-1,,F,0,F)

 

Example) Scheduled event (set to 12:05 on the 1st of every month) will output the previous month's monthly report

PRINTREPORT(reportmaster.csv,MONTH,MONTH-1MO,MONTH,-1,-1,,F,0,F)

 

Example) Scheduled event (set to 0:05 on January 1st every year) will output this year's annual report

PRINTREPORT(reportmaster.csv,YEAR,YEAR-1Y,YEAR,-1,-1,,F,0,F)

 

 

argument

explanation

Report Master

Report master file name. Please specify the relative path from the summary folder.

Summary Name

Summary name (aggregated log name) such as DAY/MONTH/YEAR

Start Reference Time

Specify the start reference time of the period for which you want to output the report in relative time format (for information on relative time formats, see "Date/Time Formats").

For details about the reference time, see "ReferenceOffsetSee the " parameter description.

End reference time

Specify the end reference time of the period you want to output the report in relative time format. Records with the exact end reference time will not be included (for information on relative time formats, see "Date/Time Format").

For details about the reference time, see "ReferenceOffsetSee the " parameter description.

Group ID

Specify the group of reports you want to print using a zero-based index.

-1 - Print all groups

0 or more - Print only the specified group

Page ID

Specifies the page of the report you want to print, using a zero-based index.

-1 - Print all pages

0 or more - Print only the specified pages

Printer Name

The printer name. If none is specified, the default printer specified in the Summary Master File will be used.

Preview screen

Displays a preview screen before printing. Use this only for testing purposes.

Print start waiting time

Specifies the wait time (msec) before starting printing.

If multiple events with PRINTREPORT specified are created and executed simultaneously, the order of pages may be out of order due to the timing of the actual printing. In such a case, you can adjust the order of printing by specifying different print start wait times for each event.

Waiting for printing to finish

If you specify T, the action execution will stop until printing is completed. Since logging will also stop, you should normally specify F.

Page Target Number

Specify [x] if you want to print automatically according to the page property PageTarget[x] of Summary report grid control. For example, if you want to select the pages to print automatically according to the settings of PageTarget1, specify 1. If you specify 0, all pages that match the specified group ID and page ID will be printed. If this argument is omitted, it will be treated as 0.

*This parameter is optional. If omitted, the value will be 0.

Show progress bar

If you specify F, you can hide the progress bar.

*This parameter is optional. If omitted, the default value will be T.

 

CREATESUBREPORT(

Report Master,

File type,

Output file name,

Summary name,

Start reference time,

End reference time,

Group,

Page,

Creation start waiting time,

Waiting for creation to finish,

[Page target number = 0],

[Show progress bar] = T)

 

Automatic subreport creation.

 

Example) Scheduled event (set at 0:05 every day) outputs the previous day's daily report

CREATESUBREPORT (reportmaster.csv,csv_header2,

 CSV\DAY\DAYSUB_[GROUPID2]_[PAGEID2]_%Y%m%d.csv,

 DAY,DAY-1D,DAY,-1,-1,0,F)

 

Example) Scheduled event (set to 12:05 on the 1st of every month) will output the previous month's monthly report

CREATESUBREPORT (reportmaster.csv,csv_header2,

 CSV\MONTH\MONTHSUB_[GROUPID]_[PAGEID]_%Y%m%d.csv,

 MONTH,MONTH-1MO,MONTH,-1,-1,0,F)

 

Example) Scheduled event (set to 0:05 on January 1st every year) outputs the previous year's annual report

CREATESUBREPORT (reportmaster.csv,csv_header2,

 CSV\YEAR\YEARSUB_[GROUPID]_[PAGEID]_%Y%m%d.csv,

 YEAR,YEAR-1Y,YEAR,-1,-1,0,F)

 

argument

explanation

Report Master

Report master file name. Please specify the relative path from the summary folder.

File type

The type of file to output.

excel - Excel file

csv - CSV file

 

If the file type is CSV, you can set the detailed format by concatenating the following strings with "_" after "csv".

 

example)

csv

csv_header1

csv_header1_date[reporttitledateformat]

csv_date['%Y/%m/%d %[H+1]:00:00']

 

●header1

Adds a header. The header name is created based on the field name.

●header2

Adds a header. The header name is created based on the report header.

●date[reporttitledateformat]

The text in the time column is determined according to the ReportTitleDateFormat in the Summary Master File.

●date['%Y/%m/%d %[H+1]:00:00']

The characters in the time column will be determined according to the specified format. You can freely specify the ''%Y/%m/%d %[H+1]:00:00' part. For available formats, refer to the ReportTitleDateFormat property in the Summary Master.

Output File Name

The file name when output.

You can specify a date format in the file name, such as "%Y%m%d".

If the file type is CSV, adding a keyword such as [PAGEID] to the file name as shown below will automatically separate the file by group or page. Note that this argument must be set using a relative path; it cannot be specified using an absolute path.

 

Example 1)

CSV\DAY\DAYSUB_[GROUPID2]_[PAGEID2]_

%Y%m%d.csv

DAYSUB_1_1_20100312.csv

DAYSUB_1_2_20100312.csv

DAYSUB_2_1_20100312.csv

DAYSUB_2_2_20100312.csv

...

 

Example 2)

CSV\DAY\DAYSUB_[GROUPID]_%Y%m%d.csv

 

DAYSUB_0_20100312.csv

DAYSUB_1_20100312.csv

...

 

If the file type is CSV, the following keywords can be used:

 

[GROUPID] : Group number starting from 0

[GROUPID2] : Group number starting from 1

[GROUPNAME]        : Group name

[PAGEID] : Page number starting from 0

[PAGEID2] : Page number starting from 1

[PAGENAME]        : Page name

 

Summary Name

Summary name such as DAY/MONTH/YEAR.

Start Reference Time

Specify the start reference time of the period for which you want to output the report in relative time format (for information on relative time formats, see "Date/Time Formats").

For details about the reference time, see "ReferenceOffsetSee the " parameter description.

End reference time

Specify the end reference time of the period you want to output the report in relative time format. Records with the exact end reference time will not be included (for information on relative time formats, see "Date/Time Format").

For details about the reference time, see "ReferenceOffsetSee the " parameter description.

group

Specify the group of reports you want to create by specifying the group index, starting from 0.

-1 - Create all groups

0 or more - create only the specified groups

page

Specifies the page of the report you want to create, using a zero-based index.

-1 - Create all pages

0 or more - create only the specified pages

Creation start waiting time

Specifies the amount of time (in Kmsec) to wait before starting the creation. Normally this is 0.

Waiting for creation to finish

If you specify T, the action execution will stop until creation is complete. Since logging will also stop, you should normally specify F.

Page Target Number

Specify [x] if you want to output an automatic subreport according to the page property PageTarget[x] of Summary report grid control. For example, if you want to select the page on which to output an automatic subreport according to the PageTarget2 setting, specify 2. If you specify 0, subreports for all pages that match the specified group ID and page ID will be output.

*This parameter is optional. If omitted, the value will be 0.

Show progress bar

If you specify F, you can hide the progress bar.

*This parameter is optional. If omitted, the default value will be T.