Results

Configuring reports

Description

A report is configured either for a planned periodical or a one-off generation.

The configuration for a report is saved.

You define the following for a report:

  • Report interval: One-off or planned

  • KPIs and variables that are reported

  • Type of aggregation: Balance value or process values

  • Placement of the values in a sheet of an Excel file

  • Recipients of the report

A report consists of one or multiple areas. For example, the values of a year can be shown in one area, while the daily values of the last month are shown in an additional area.

Procedure

To configure a report, follow these steps:

  1. Open the "Reports" of the asset.

    If a configuration has already been created, the overview is displayed.

  2. Select "Create new report configuration".

  3. The "Create report configuration" editor opens.

    152544616843.png

  4. Enter the name of the report.

    The name is shown as the subject in the sent email and in the overview of all reports.

  5. Enter a description for the report.

    The description makes it easier to assign the report.

  6. Upload an Excel file as report template.

    The template can be an empty file. The template can, for example, already be structured as filled cells that are pre-formatted by headlines. The template can, for example, contain a letter head or recurring information on the location of the plant for each report.

    If you do not upload a template, a blank Excel file is used as the basis for the report. When editing the configuration for a regularly generated report again, you see a note that an automatically generated Excel file is being used. You can replace the automatically generated template with your own template.

    NOTE

    Excel template

    An Excel file is required to create the report.

    • Permitted data formats XLSX, XLTX, XLSM and XLTM

    • Minimum file size: 1 KB

    • Maximum file size: 5 MB

  7. Select the "Report interval".

  8. Select the date on which you want the report generation to start.

    The report is generated for the first time when the interval after the start date is reached.

    153264033547.png

    Example: The start date is 1/1/22. The interval is one week. The report is generated on 1/7/22.

  9. Select a time zone.

    The time zone is added as an offset to the start date.

  10. To create a configuration for a report that is generated regularly based on the selected interval, activate the switch.

    152678858763.png

    To generate a one-off report, deactivate the switch.

    152680813195.png

    NOTE

    One-off reports

    The configuration for one-off reports is not saved.

    One-off reports are not sent via email.

  11. To automatically send a report that is generated regularly based on an interval, enter a recipient.

    • Click "Add recipient".

    • Add additional recipients.

    One-off reports are not sent.

  12. Enter the name of the first section.

    NOTE

    Creating sections

    You can create up to 20 sections with different configurations. The sections can be exported in different sheets of the Excel workbook.

    153273775499.png

    The name is specified together with the report interval in the start cell of the report. The values are listed below.

  13. Specify the name of the Excel workbook sheet in which the section is exported.

    If a sheet with that name does not exist in the template, it is created.

  14. Enter the start cell as of which the values are exported.

    NOTE

    No check of the cell sections

    There is no check as to whether the exported values will overwrite existing content.

  15. Select whether a balance value or process values are exported in this section.

    • Balance value: Single value that results from the aggregation of the interval values.

      Example: The average value for one month.

    • Process values: All values that are available during the selected interval.

      Example: A value is exported for each day of a month.

  16. For process values only: Select the interval for the calculation.

    Specifies how often a process value is output within the reporting period.

    Example: For the reporting period of one month, values are output every hour.

  17. For process values only: Select whether the display is in columns or rows.

  18. Select the parameters that are exported in the section.

    152936206219.png

    NOTE

    Parameter selection

    Maximum number per section: 50 parameters.

    Parameters of the type String are not permitted.

    • To add a parameter to the report, select 152017844107.png "Parameter".

    • Select the type of the parameter aggregation.

      NOTE

      Too many process values through "None" aggregation

      If "Aggregation: None" and "Data alignment: Rows" is selected, there is a limit of 16,384 data points that can be exported.

    • To change the order of the parameters, click on the arrows in front of the parameter name.

  19. To create an additional section, select 152017844107.png "Add section".

  20. To save the configuration, select "Save".

Result

  • The configuration for a report has been created and saved.

  • The "Overview of all reports" is displayed.

  • The report is generated as of the start date with the selected interval.

    - or -

    The report is generated once on the start date.

Chap. 10.3