Results

Configuring reports

Description

To create a report once or with periodic planning, define a configuration. You define the following in the configuration which is saved:

  • 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. Go to My Plant and select an asset. The tiles of automatically generated and user-defined dashboards for this asset are displayed.

  2. Click 157424219787.png in the information panel next to the "Reports".

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

  3. To define a new configuration, select "Create new report configuration".

  4. The "Add report configuration" editor appears.

    170792023563.png

  5. Enter the name of the report.

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

  6. Optionally enter a description for the report.

    The description makes it easier to assign the report.

  7. Load an Excel file as a template for the report.

    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

    You can use either an automatically generated template or a user-defined Excel template.

    NOTE

    User-defined Excel template

    There are no further restrictions when designing the template.

    When selecting the start cell within a range, ensure that elements of your template are not overwritten.

    The template can, for example, contain a letter head, or recurring information on the location of the plant for each report. You can structure a template using pre-formatted, filled cells as headings.

    If you do not upload a template, a blank Excel file is used as the basis for the report. You can replace the automatically generated template with your own template at any time.

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

    The date can lie in the past.

    169334085515.png

  9. Select a time zone.

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

  10. Select the "Data interval".

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

    Example: The start date is 01/01/2022. The interval is one week. The report is generated on 7 Jan. 2022.

  11. To create a configuration for a report that is generated regularly based on the selected interval, activate the "Periodic scheduling" switch.

    152678858763.png

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

    152680813195.png

  12. Specify up to 20 valid email addresses for sending a periodical report by email.

    166574714635.png

    NOTE

    One-off reports

    One-off reports are not sent via email.

  13. 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.

    161077889419.png

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

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

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

  15. 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.

  16. 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.

      164413974539.png

  17. Only for process values, select the interval of the calculation. The interval 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.

  18. Select whether the data is arranged in columns or rows.

  19. For new report configurations, add at least one parameter which is output in the area.

    156784229259.png

    To change the sequence of the parameters, drag a parameter up or down by means of 156768540299.png.

    NOTE

    Parameter selection

    Maximum number per section: 50 parameters.

    Parameters of the String type are not supported.

    NOTE

    Limited export to Excel

    In a report, you can export a maximum of 500,000 cells to Excel.

  20. You can add another value at any time by clicking 152017844107.png "Add parameter".

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

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

Result

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

  • The "Reports" view is displayed.

  • The periodic reports are generated as of the start date with the selected interval. The one-time reports are only created for the start date.

Chap. 5.6.3