# Use reports

## How are reports structured?

Reports consist of 3 sections:

* General
* Delivery
* Content

<div data-full-width="true"><figure><img src="https://content.gitbook.com/content/Nyvwhz1kEMXcHf4HLuZ8/blobs/LVHE1pMTDxBx0vtuV5xf/734ABD2A-A294-48B4-8339-71933B798F96.png" alt=""><figcaption><p>Fig. 1 - The "Create report" menu<br>The 3 sections are marked respectively.</p></figcaption></figure></div>

### \[A] – General

The "General" section contains the name and title of the report. You can also select the period that will be covered in the report here.

You can find out how to configure this section [-> HERE](#a-allgemein)

### \[B] – Delivery

In the "Delivery" section, you can choose how the report should be delivered. The options are:

* Download report immediately&#x20;
* set up regular sending.&#x20;

You can find out how to configure this section [-> HERE](#b-bereitstellung)

### \[C] – Content

This section specifies the actual content of the report. It is selected what will be included in the report.&#x20;

You compose the report content individually from various elements.&#x20;

You can find out how to configure this section [-> HERE](#c-inhalt)

## Add a new report

<figure><img src="https://content.gitbook.com/content/Nyvwhz1kEMXcHf4HLuZ8/blobs/zVLTbU03kn8fCew1svfT/A987FF40-EBBD-4E42-8A16-5629A4ACC525.png" alt=""><figcaption><p>Fig. 2</p></figcaption></figure>

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 Confirm **\[H]**\
   ▷ The "Add report" window closes\
   ▷ In "Analytics and reports overview" the new report appears in the "Reports" section
5. Click on **\[I]**\
   ▷ The "Create report" menu opens

## Configure a report

### Section \[A] – General

<div data-full-width="true"><figure><img src="https://content.gitbook.com/content/Nyvwhz1kEMXcHf4HLuZ8/blobs/RSXI8uzPqvYIroEKIelp/99E820BC-4699-4F12-AD50-04727D1BEBAB.png" alt=""><figcaption><p>Fig. 3</p></figcaption></figure></div>

<table><thead><tr><th width="113.33333333333331"></th><th width="133"></th><th></th></tr></thead><tbody><tr><td><strong>[A1]</strong></td><td>Title</td><td>The report title appears prominently at the beginning of the generated report. You can use variables in {{curly brackets}} in the title</td></tr><tr><td><strong>[A2]</strong></td><td>Report name</td><td>The report name was assigned in <strong>[G]</strong> Here you can adjust the name. The report name appears unobtrusively in the footer of the generated report. </td></tr><tr><td><strong>[A3]</strong></td><td>Show logo</td><td>If this option is enabled, the generated report will be provided with the associated <a href="broken-reference">-> project logo</a> .</td></tr><tr><td><strong>[A4]</strong></td><td>Choose time period</td><td>In this section you can define which period the report should cover.</td></tr><tr><td><strong>[A5]</strong></td><td>Date "From"</td><td><p>Here you can choose the start date. <br>This is the earliest date that will be considered in the generated report. The following options are available to you:</p><ul><li>Period before the "Date To": You can specify a period that is calculated backwards from the <strong>end date [A6]</strong> .</li><li> Exact time: You can freely define a specific point in time, including the time. </li></ul></td></tr><tr><td>[<strong>A6]</strong></td><td>Date "To"</td><td><p>Here you can choose the end date. <br>This is the latest date that will be considered in the generated report. The following options are available to you:</p><ul><li>Day and time of report creation: The moment when the report is generated. This function is particularly useful if you have automated reports. </li><li> Exact time: You can freely define a specific point in time, including the time. </li></ul></td></tr></tbody></table>

### Delivery

#### Download on demand

<div data-full-width="true"><figure><img src="https://content.gitbook.com/content/Nyvwhz1kEMXcHf4HLuZ8/blobs/L6aiXmRPUE2g0nNnZKNE/0FAE04F6-6D39-4524-8D14-B5DF0AEE6119.png" alt=""><figcaption><p>Fig. 4</p></figcaption></figure></div>

You can generate and download the report immediately.

{% hint style="info" %}
*Prerequisite:*

You have added [-> content](#inhalt) to the report.
{% endhint %}

1. Select **\[B1]**
2. Click on **Save** **\[X]**
3. &#x20;Click on **\[B2]**, to generate a preview
4. Click on **\[B3]**, to download the report

#### Deliver regularly

<div data-full-width="true"><figure><img src="https://content.gitbook.com/content/Nyvwhz1kEMXcHf4HLuZ8/blobs/Cf54PUquJqfgp5Va1pHA/412F7DFF-406F-4555-8F41-BBBA6506F5B1.png" alt=""><figcaption><p>Fig. 5 – Options for regular delivery of reports</p></figcaption></figure></div>

{% hint style="info" %}
*Prerequisite:*

You have added [-> content](#inhalt) to the report.
{% endhint %}

1. Click on **\[B4]**\
   ▷ Additional options appear, see Fig. 5
2. &#x20;Select 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 additional email addresses
4. Select under **\[B10]** and **\[B11]** select how often the report should be generated and sent
5. Select under **\[B13]** and **\[B14]** select when the first report should be sent.
6. Under **\[B12]** is displayed 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 delivery.

### Content

In this section you can define which data and assets are included in the report.

<div data-full-width="true"><figure><img src="https://content.gitbook.com/content/Nyvwhz1kEMXcHf4HLuZ8/blobs/mtSq9lzr2Mre6BdO4ZVf/A62EC22E-96E2-4D0F-9E70-8AEA6509FF65.png" alt=""><figcaption></figcaption></figure></div>

1. Click on **\[C1]**\
   ▷ The window **Add section \[C2]** opens
2. Select via **\[C3]** / **\[C4]** / **\[C5]** / **\[C6]** the element you want to add\
   ▷ 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

<figure><img src="https://content.gitbook.com/content/Nyvwhz1kEMXcHf4HLuZ8/blobs/YGCKbyxcmai2etoh2GaM/0D605C03-D4BB-4FD2-B559-4DBD3E86966E.png" alt=""><figcaption></figcaption></figure>

This field is intended for writing and formatting free text. This allows you to emphasize certain aspects of your reports.&#x20;

You can insert variables in {{curly brackets}}.&#x20;

#### Data table

<figure><img src="https://content.gitbook.com/content/Nyvwhz1kEMXcHf4HLuZ8/blobs/gCoVVoLWJT3WyJ9dZ9Xm/17E8D80C-C490-44C0-B602-EEC80FFD85C2.png" alt=""><figcaption></figcaption></figure>

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

#### Analytic

<figure><img src="https://content.gitbook.com/content/Nyvwhz1kEMXcHf4HLuZ8/blobs/NtE8X9UcVbiRrtrIb6yx/Report%20Analysis.png" alt=""><figcaption></figcaption></figure>

You can add existing [→ analytics](https://docs.buildings.ability.abb/collection/english-v14/documentation/widgets/predefined-widgets/analytics) to a report in order to display their analysis directly in the report.

**Use report time period**

* **Enabled** → The analytic adopts the time period defined in the report.
* **Disabled** → The analytic is displayed in the report with its own time period defined in the analytic configuration.

#### Alarm report

<figure><img src="https://content.gitbook.com/content/Nyvwhz1kEMXcHf4HLuZ8/blobs/BHQUEb3ZKt4Y2Wk6fKnq/98A36B77-50F0-4677-A204-614513FED973.png" alt=""><figcaption></figcaption></figure>

The *Alarm report* makes it possible to include a summary of the most important alarms in a report. Different display formats can be chosen, such as:

* **Top 10 alarms by duration** (table)
* **Top 10 alarms by frequency** (table)
* **Alarm volume as a pie chart**
* **Overview of the daily alarm volume** (chart)

In addition, it can be defined 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 the [→ *Alarm statistics*](https://docs.buildings.ability.abb/collection/english-v14/documentation/alarms-rules-and-escalations/alarms/alarm-statistics).