Wiki source code of Report Guide
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
6.1 | 1 | (% class="wikigeneratedid" %) |
| 2 | Table of contants: | ||
| 3 | |||
| 4 | {{toc/}} | ||
| 5 | |||
| 6 | |||
| |
2.1 | 7 | = **Overview** = |
| 8 | |||
| |
4.1 | 9 | In ThingsBoard, **Reporting** is a powerful and flexible tool for collecting, structuring, and automatically distributing data in the form of reports. |
| |
2.1 | 10 | |
| |
4.1 | 11 | Reporting in ThingsBoard is built on two key components: |
| |
2.1 | 12 | |
| |
4.1 | 13 | * **Configured report template** – defines the structure, content, and format of the report. A template can be in **PDF** or **CSV** format and may include any supported components, such as tables, charts, text blocks, images, and more. |
| 14 | * **Scheduler event** – automatically triggers report generation at the specified time and sends it to selected recipients via available delivery channels (such as **email**, **Slack**, and other integrations). | ||
| |
2.1 | 15 | |
| |
4.1 | 16 | **Key features:** |
| |
2.1 | 17 | |
| |
4.1 | 18 | * **Automated scheduling** – preconfigured scheduler events can send reports on a set schedule without any user action. |
| 19 | * **Reusable templates** – a single template can be used for different recipients by applying filters and parameters. | ||
| 20 | * **Event-based delivery** – send reports when specific events occur (e.g., an active alarm on a device). | ||
| 21 | * **Rich content support** – include text blocks, tables, charts, images, and more. | ||
| 22 | * **Notification integration** – attach a generated report to system notifications (Email, Slack). | ||
| |
2.1 | 23 | |
| |
4.1 | 24 | **Where it's useful:** |
| |
2.1 | 25 | |
| |
4.1 | 26 | * Regular monitoring of your device's metrics. |
| 27 | * Sharing summary data with partners or management. | ||
| 28 | * Archiving data in an easy-to-read format. | ||
| 29 | * Automating communication during incidents. | ||
| |
2.1 | 30 | |
| 31 | **报告形式：** | ||
| 32 | |||
| |
4.1 | 33 | * **PDF** – visually styled reports that may include charts, tables, images, and company branding. |
| 34 | * **CSV** – data-oriented tabular reports that are easy to analyze in Excel or BI tools. | ||
| |
2.1 | 35 | |
| |
4.1 | 36 | **Demo：** |
| |
2.1 | 37 | |
| |
5.1 | 38 | [[image:1757901233737-956.png||height="405" width="720"]] |
| |
4.1 | 39 | |
| |
6.1 | 40 | |
| |
5.1 | 41 | [[image:1757901251979-243.png||height="1021" width="722"]] |
| |
4.1 | 42 | |
| 43 | |||
| |
6.1 | 44 | ---- |
| |
4.1 | 45 | |
| |
8.1 | 46 | = **How to generate a simple report** = |
| |
6.1 | 47 | |
| |
7.1 | 48 | * ((( |
| 49 | Open the “**Reporting**” page from the left-hand sidebar. You'll automatically be taken to the “**Templates**” tab. | ||
| 50 | ))) | ||
| |
4.1 | 51 | * Click the “**+ Add report template**” button in the top-right corner. |
| 52 | * Choose “**Create new report template**”. | ||
| 53 | * In the popup, fill out the following: | ||
| 54 | ** **Name** – a descriptive name for the report template. | ||
| 55 | ** **Format**: Choose **PDF** or **CSV** report format. | ||
| 56 | ** **Type**: | ||
| 57 | *** **Report** - a complete standalone report template. | ||
| 58 | *** Subreport - a modular component that can be embedded inside another report. | ||
| 59 | ** Click “**Add**” to create the report template and open the **Report Builder** interface, where you can design the structure, layout, and content of your report. | ||
| 60 | ** Open the “**Reporting**” page from the left-hand sidebar. You'll automatically be taken to the “**Templates**” tab. | ||
| 61 | ** Click the “**+ Add report template**” button in the top-right corner. | ||
| 62 | ** Choose “**Create new report template**”. | ||
| 63 | |||
| |
2.1 | 64 | [[image:1757899242101-256.png||height="245" width="711"]] |
| 65 | |||
| |
5.1 | 66 | * In the popup, fill out the following: |
| 67 | ** **Name** – a descriptive name for the report template. | ||
| 68 | ** **Format**: Choose **PDF** or **CSV** report format. | ||
| 69 | ** **Type**: | ||
| 70 | *** **Report** - a complete standalone report template. | ||
| 71 | *** Subreport - a modular component that can be embedded inside another report. | ||
| 72 | ** Click “**Add**” to create the report template and open the **Report Builder** interface, where you can design the structure, layout, and content of your report. | ||
| 73 | |||
| 74 | [[image:1757899267136-753.png||height="435" width="712"]] | ||
| 75 | |||
| 76 | |||
| |
2.1 | 77 | ---- |
| 78 | |||
| |
6.1 | 79 | == **Report Builder** == |
| |
2.1 | 80 | |
| |
5.1 | 81 | The **Report Builder** is a drag-and-drop editor that lets you design your report template using visual and data components. You have full control over both the appearance and structure of the report. |
| |
2.1 | 82 | |
| |
8.1 | 83 | 每个组件都有两个主要配置部分： |
| 84 | |||
| 85 | * **数据配置** — 定义组件将显示哪些数据以及如何过滤这些数据。支持动态数据绑定的实体别名和过滤器。 | ||
| 86 | * **布局配置** — 控制最终文档中的视觉样式和格式。 | ||
| 87 | |||
| |
5.1 | 88 | Here's what the Report Builder looks like: |
| 89 | |||
| 90 | [[image:1757900905980-599.png||height="660" width="715"]] | ||
| |
8.1 | 91 | |
| 92 |