> For the complete documentation index, see [llms.txt](https://docs.datacake.de/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.datacake.de/portal/reports/energy-report.md).

# Report Builder (PDF Reports)

The PDF Report Builder allows you to create customized reports containing device data, KPIs, charts, and tables. Reports can be generated automatically according to a schedule and delivered to selected recipients by email.

### Opening the Report Builder

To open the Report Builder:

1. Open the relevant workspace.
2. Select **Reports** from the workspace navigation.
3. Open the **Report Builder** tab.

The Reports section contains the following tabs:

* **Report Builder** – Creates configurable PDF and web-based reports.
* **Simple CSV** – Displays reports created using the previous CSV reporting feature. This tab only appears if the workspace already has legacy CSV reports.
* **Energy Reports** – Creates reports intended specifically for energy-monitoring applications.<br>

<figure><img src="/files/MGtlleBnG2Xo08Tph8EW" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
The previous Simple CSV reporting feature has been deprecated. Raw data exports can now be configured from the separate **Exports** section.
{% endhint %}

### Configurations and generated reports

The Report Builder contains two tabs:

<figure><img src="/files/PKPBcB8aiGmoCy7dIe2f" alt=""><figcaption></figcaption></figure>

#### Configurations

The **Configurations** tab contains the report configurations created for the workspace. From here, you can create, open, and manage your scheduled reports.

#### Generated Reports

The **Generated Reports** tab contains the individual reports that have already been generated.

For every generated report, you can see information including:

* Generation status
* Report name
* Available artefacts
* Creation date
* Expiration date

Click an artefact to open or download it. You can also search the list using the report name or report ID.

### Creating a PDF report

To create a report:

1. Open **Reports**.
2. Select **Report Builder**.
3. Open the **Configurations** tab.
4. Click **Add Report**.
5. Select **PDF Report**.
6. Enter a name for the report.
7. Optionally, select an existing template.
8. Configure which devices should be included.

Devices can be selected directly or filtered using device names and tags. Using tags is especially helpful when the report should automatically cover a particular group of devices.

After creating the configuration, the Report Editor opens.<br>

<figure><img src="/files/2yJAXUZAsBNBK4W5PL7j" alt=""><figcaption></figcaption></figure>

### Working with the Report Editor

The Report Editor allows you to configure the report and build its contents. The editor includes a report preview so that you can review the structure while working on it.

The report Settings determines:

* When the report is generated
* Which period of data is included
* How the data is aggregated
* Which devices and fields are used
* Which content appears in the report
* How the finished report is delivered<br>

<figure><img src="/files/gwEWg5jIBvceEYOhMzms" alt=""><figcaption></figcaption></figure>

### Configuring the schedule

Reports can be generated automatically according to a recurring schedule.

Depending on the selected frequency, configure the relevant scheduling settings, such as:

* Frequency, for example weekly
* Day of generation
* Time of generation
* Time zone

The selected time zone determines when the scheduled report is generated and how dates and times are represented.

<figure><img src="/files/BuOTFrQw7kxR1re1LPoz" alt=""><figcaption></figcaption></figure>

### Configuring the report period

Select the period of data that each report should cover. For example, a weekly report can be configured to include the data collected during the previous week.

You can also select a resolution for the report data. Available resolutions include intervals such as:

* 15 minutes
* 30 minutes
* One hour
* One day

The resolution determines how the source data is grouped. It can also affect the size of tables and the level of detail shown in charts.

A smaller interval produces more data points and longer tables. A larger interval produces a more condensed overview.

### Choosing the output format

The report can be made available in the following formats:

* **PDF document** – Generates a downloadable PDF file.
* **Interactive web view** – Generates a browser-based version of the report.
* **PDF and web view** – Generates both formats.

<figure><img src="/files/oDG6G9PY6IwDGHDJSSXq" alt=""><figcaption></figcaption></figure>

### Language and regional formatting

Use the locale setting to select the language and regional formatting used in the report.

The selected locale can affect elements such as:

* Dates
* Times
* Numbers
* Automatically generated labels

### Configuring email delivery

Generated reports can be delivered automatically by email.

Add the email addresses that should receive a notification when the report is ready. The email contains a link through which the recipient can access the generated report.

When sharing reports externally, confirm that the selected devices and report contents are appropriate for every recipient.

<figure><img src="/files/ChhQsumpTJrjfks3Tt6g" alt=""><figcaption></figcaption></figure>

### Password protection

Reports can optionally be protected with a password. This provides additional protection when reports contain sensitive information or are distributed outside your organization.

Recipients must know the configured password to access a protected report.

### Handling gaps in the data

The Report Builder includes settings for handling periods in which no data is available.

Choose the appropriate behavior based on the report’s purpose and the expected reporting frequency of your devices. Be particularly careful when filling data gaps in reports used for compliance or operational decision-making, as generated values may not represent actual measurements.

<figure><img src="/files/N0sWd7wjMlN0qdXmnbOY" alt=""><figcaption></figcaption></figure>

### Adding content to the report

Reports are built by adding widgets to the report layout.

<figure><img src="/files/JYavAJHEHKA2J7gRj8iL" alt=""><figcaption></figcaption></figure>

#### KPI widget

The KPI widget displays a summarized value for a selected field.

Use KPI widgets to highlight important measurements such as:

* Average temperature
* Minimum or maximum values
* Energy consumption
* Average humidity
* Device performance indicators

Configure the device, field, and aggregation that should be used for the calculation.<br>

<figure><img src="/files/xsqcv1l0zwhRfGdczaCS" alt=""><figcaption></figcaption></figure>

#### Time Series Chart

The Time Series Chart visualizes how one or more measurements changed during the report period.

Use it to show:

* Environmental trends
* Temperature changes
* Energy consumption over time
* Comparisons between devices or fields
* Unusual peaks or drops

<figure><img src="/files/dZtqUhEjgecgCQPpPLYY" alt=""><figcaption></figcaption></figure>

#### Time Series Table

The Time Series Table displays historical measurements in a table.

The number of rows depends on the report period and selected data resolution. For example, a report using a 30-minute resolution contains more rows than the same report using a daily resolution.

Consider using a larger resolution if the table becomes too long for the report.<br>

<figure><img src="/files/bjRy2FBeqZ7yRNA07Y9E" alt=""><figcaption></figcaption></figure>

### Creating sections for each device

Use a **Device Loop** when the same report structure should be repeated for multiple devices.

Widgets placed inside the Device Loop are generated once for every selected device. For example, a loop can contain:

* A device heading
* A KPI summary
* A Time Series Chart
* A detailed data table

This is particularly useful when reporting on multiple rooms, locations, sensors, or assets using a consistent layout.

The devices included in the loop are determined by the report’s device selection or filters. When device tags are used, newly added devices with matching tags can be included without rebuilding the complete report structure.

<figure><img src="/files/MIT9wIB5aHFypdva9AYo" alt=""><figcaption></figcaption></figure>

### Saving and activating the report

Once the report has been configured:

1. Review the report settings and preview.
2. Save the report configuration.
3. Confirm that the schedule is enabled.
4. Return to the **Configurations** tab to verify that the report appears in the list.

The report will then run automatically according to its configured schedule.

When generation is complete:

* The result appears under **Generated Reports**.
* Configured recipients receive an email notification.
* The available PDF or web artifact can be opened from the report list.

<figure><img src="/files/vTsJT5uGzrMmimfOU6mq" alt=""><figcaption></figcaption></figure>

### Beta limitations

The Report Builder is currently in beta. Keep the following points in mind:

* The interface and available widgets may change.
* Generated reports have an expiration date.
* Report length depends on the number of devices, widgets, selected period, and data resolution.
* Large tables or Device Loops containing many devices can produce long reports.
* Data can only be displayed when measurements are available for the selected fields and period.
* The initial version focuses on configurable data presentation and does not automatically provide compliance assessments or alert summaries.

This draft still needs the exact names of the data-gap options, supported locales, and availability by plan. I would also add screenshots for the Reports overview, schedule settings, editor, widget menu, Device Loop, and Generated Reports page.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.datacake.de/portal/reports/energy-report.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.