Use Reports

How are Reports structured?

Reports consist of 3 areas:

  • General

  • Provisioning

  • Content

Fig 1. - The "Create Report" menu The 3 areas are each marked.

[A] – General

The "General" area contains the name and title of the report. Here you can also select the time period the report should cover.

You can find out how to configure this area -> HERE

[B] – Provisioning

In the "Provisioning" area, you can select how the report should be delivered. The options are:

  • Download report immediately

  • Set up regular delivery.

You can find out how to configure this area -> HERE

[C] – Content

In this area, the actual content of the report is specified. You select what the report will contain.

You assemble the content of the report individually from different elements.

You can find out how to configure this area -> HERE

Add a new Report

Fig. 2
  1. Click on Analytics and Reports [D]

    ▷ The "Analytics and Reports Overview" opens

  2. Click on [E] to create a new report

    ▷ The "Add Report" window [F] opens

  3. Enter a name for the report [G]

  4. Click on Confirm [H]

    ▷ The "Add Report" window closes

    ▷ The new report appears in the "Reports" section of the "Analytics and Reports Overview"

  5. Click on [I]

    ▷ The "Create Report" menu opens

Configure a Report

Area [A] – General

Fig. 3

[A1]

Title

The title of the report appears prominently at the beginning of the generated report. You can use variables in {{curly brackets}} in the title

[A2]

Report name

The report name was given in [G]. Here you can adjust the name. The report name appears inconspicuously in the footer of the generated report.

[A3]

Show logo

If this option is activated, the generated report is provided with the corresponding -> project logo.

[A4]

Choose time range

In this area, you can set the time period the report should cover.

[A5]

Date "From"

Here you can choose the start date. This is the earliest date that is considered in the generated report. The following options are available to you:

  • Period before "Date To": You can specify a period that is calculated backward from the end date [A6].

  • Exact time: You can freely define a specific time, including the time of day.

[A6]

Date "To"

Here you can choose the end date. This is the last date that is considered in the generated report. The following options are available to you:

  • Day and time of report creation: The moment the report is generated. This function is particularly useful when you have automated reports.

  • Exact time: You can freely define a specific time, including the time of day.

Provisioning

Download on demand

Fig. 4

You can generate and download the report immediately.

Prerequisite:

You have added -> content to the report.

  1. Select [B1]

  2. Click on Save [X]

  3. Click on [B2] to generate a preview

  4. Click on [B3] to download the report

Deliver regularly

Fig. 5 – Options for regular delivery of reports

Prerequisite:

You have added -> content to the report.

  1. Click on [B4]

    ▷ Additional options appear, see Fig. 5

  2. Under [B5], select the email address to which the report should be sent.

    ▷ The selected email address appears in the viewport.

  3. Repeat step 2 to add more email addresses

  4. Under [B10] and [B11], select how often the report should be generated and sent

  5. Under [B13] and [B14], select when the first report should be sent.

  6. Under [B12], it shows when the next report will be generated and sent.

  7. Click on Save [Z]

  8. Optional: Click on [B8] to generate a preview of the report.

  9. Click on Send [B9] to start the delivery.

Content

In this area, you can determine which data and assets are included in the report.

  1. Click on [C1]

    ▷ The Add Section [C2] window opens

  2. Select the element you want to add via [C3] / [C4] / [C5] / [C6]

    ▷ The configuration menu for the respective option is displayed

  3. Fill in the configuration menu (see below)

  4. Click on Confirm [CX]

    ▷ The element is added

  5. Optional: Repeat steps 1-4 to add more elements

Text

This field is intended for writing and formatting free text. You can emphasize certain aspects of your reports this way.

You can insert variables in {{curly brackets}}.

Data Table

Data tables list all data of a selected asset. Select one or more assets, as well as the corresponding attributes.

Analytic

You can insert existing → Analytics into a report to display their evaluation directly in the report.

Use report time range

  • Enabled → The analytic adopts the time period defined in the report.

  • Disabled → The analytic is displayed in the report with its own time period, which was set in the analytic configuration.

Alarm Report

The Alarm Report allows you to include a summary of the most important alarms in a report. You can choose different display formats, such as:

  • Top 10 alarms by duration (table)

  • Top 10 alarms by frequency (table)

  • Alarm quantity as a pie chart

  • Overview of the daily alarm quantity (graphic)

Additionally, you can specify whether the alarms for all assets or only for a specific selection of assets should be included in the report.

▶ Further information on alarm statistics and their analysis can be found in the documentation for Alarm Statistics.

Last updated