PLC Reports User Manual

11. Report Settings

In section “3. Settings” adjustments for each report can be made.

WarningNote!
It is important to distinguish between global settings and settings relating only to the report file. Settings in the section “Global Settings” are valid for the entire reporting system, whereas settings made in section “3. Settings” are valid for the corresponding report file only.

While the report file is open, Section “3. Settings” shows all valid settings defined in the worksheet “Settings” of the report template.

Setting definitions can be entered starting from row 6. Row 5 is reserved for the column headers. The header area (row 1-4) is not being interpreted.

11.1. Walk-Through: How to Edit Report Settings

  1. Open a report file for editing.
  2. Select the worksheet “Settings” in the Excel report template.
  3. Change the desired settings in Excel.
  4. Navigate to section “3. Settings” in PLC Reports.
  5. Click the button “Load and Check Settings”.Load and Check Settings
  6. PLC Reports now reads and validates all settings defined in worksheet “Settings”.
  7. Valid settings will be shown in table “Settings”.
  8. If errors occur while loading or validating, corresponding messages will be shown in the message list.
  9. By double-clicking an error message, you can directly jump to the error-prone cell in the Excel sheet.
  10. Any error can now be corrected.
  11. After editing the report template, save and close the workbook by using the corresponding commands in the Excel file menu.

Settings

11.2. Available Settings

11.2.1. Setting “Create Daily Subfolders”

This setting defines whether or not a separate subfolder for each day should be created. The name of the subfolder will be the same as the date of the month.

Possible values are: Yes, No.

11.2.2. Setting “Create Weekly Subfolders”

This setting defines whether or not a separate subfolder for each week should be created. The name of the subfolder will be the same as the calendar week.

Possible values are: Yes, No.

11.2.3. Setting “Create Monthly Subfolders”

This setting defines whether or not a separate subfolder for each month should be created. The name of the subfolder will be the same as the number of the month.

Possible values are: Yes, No.

11.2.4. Setting “Create Annual Subfolders”

This setting defines whether or not a separate subfolder for each year should be created. The name of the subfolder will correspond to the current year.

Possible values are: Yes, No.

11.2.5. Setting “Output Directory”

This setting defines whether or not a special output path should be used for this report.

Possible values are:
- Blank: If the value of this setting is left blank, the output path defined in the global settings is used.
- Specification of a valid path, e.g. “D:\Reports”.

11.2.6. Setting “Watchdog Time”

This setting defines the maximum time the execution of the instruction list may take. The time is specified in seconds. If the execution time exceeds the limit, the instruction list execution will be aborted.

Possible values are positive integers. The default value is 50.

WarningNote!
The watchdog is designed to monitor configuration errors, for example closed loops. Make sure that you do not use too short measures.

11.2.7. Setting “Max Number of Excel Rows in Auto Mode”

This setting defines the maximum number of rows to be inserted into a report when retrieving values from an archive. The limit is only active if the report was started by a schedule. If the number of rows exceeds the limit, the report creation will be aborted and an error message will appear.

This function is designed to prevent inserting unintended numbers of rows into Excel when reading values from an archive. Inserting multiple thousands of rows into Excel will highly influence the performance. Adjust the limit slightly higher than the expected number of rows.

Example:
An annual report is expected to show one archived value per day, in other words maximum 366 values in total. In this case, adjust the limit to e.g. 400.

Valid values are positive integers. The default value is 5,000.

11.2.8. Setting “Max Number of Excel Rows in Manual Mode”

This setting defines the maximum number of rows to be inserted into a report when retrieving values from an archive. The limit is only active if the report was started manually. If the number of rows exceeds the limit, the report creation will be aborted and an error message will appear.

This function is designed to prevent inserting unintended numbers of rows into Excel when reading values from an archive. There is a high risk to accidently retrieve an unexpected number of values, especially when starting a report manually. Inserting multiple thousands of rows into Excel will highly influence the performance. Adjust the limit slightly higher than the expected number of rows.

Example:
An annual report is expected to show one archived value per day, in other words maximum 366 values in total. In this case, adjust the limit to e.g. 400.

Valid values are positive integers. The default value is 5,000.

11.2.9. Setting „Start Parameter“

This setting defines a start parameter set for manual report start. When starting a report manually, it might be necessary to start the instruction list at a certain point. For this purpose, the instruction number to start with can be defined by a start parameter set.

Start Parameter 1

Reports can be started manually in the “Home” tab of PLC Reports. To start a report manually, a valid start parameter set must be defined and selected and the reporting system must be started. After starting the reporting system, select the report you wish to start from the list of reports. The drop down list will show all defined start parameter sets for selection. Select the desired set and click the button “Start Report Manually”.

Report List

Valid values are:
A start parameter set always consists of a clear text name and an instruction number to start with. The name and the number must be separated by a comma.