Wiki source code of Report Guide

Version 4.1 by Hera Guo on 2025/09/15 09:48
Hide last authors
Hera Guo 2.1 1 = **Overview** =
2
Hera Guo 4.1 3 In ThingsBoard, **Reporting** is a powerful and flexible tool for collecting, structuring, and automatically distributing data in the form of reports.
Hera Guo 2.1 4
Hera Guo 4.1 5 Reporting in ThingsBoard is built on two key components:
Hera Guo 2.1 6
Hera Guo 4.1 7 * **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.
8 * **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).
Hera Guo 2.1 9
Hera Guo 4.1 10 **Key features:**
Hera Guo 2.1 11
Hera Guo 4.1 12 * **Automated scheduling** – preconfigured scheduler events can send reports on a set schedule without any user action.
13 * **Reusable templates** – a single template can be used for different recipients by applying filters and parameters.
14 * **Event-based delivery** – send reports when specific events occur (e.g., an active alarm on a device).
15 * **Rich content support** – include text blocks, tables, charts, images, and more.
16 * **Notification integration** – attach a generated report to system notifications (Email, Slack).
Hera Guo 2.1 17
Hera Guo 4.1 18 **Where it's useful:**
Hera Guo 2.1 19
Hera Guo 4.1 20 * Regular monitoring of your device's metrics.
21 * Sharing summary data with partners or management.
22 * Archiving data in an easy-to-read format.
23 * Automating communication during incidents.
Hera Guo 2.1 24
25 **报告形式：**
26
Hera Guo 4.1 27 * **PDF** – visually styled reports that may include charts, tables, images, and company branding.
28 * **CSV** – data-oriented tabular reports that are easy to analyze in Excel or BI tools.
Hera Guo 2.1 29
30
Hera Guo 4.1 31 **Demo：**
Hera Guo 2.1 32
Hera Guo 4.1 33
34
35
36 == **如何开始** ==
37
38 * Open the “**Reporting**” page from the left-hand sidebar. You'll automatically be taken to the “**Templates**” tab.
39 * Click the “**+ Add report template**” button in the top-right corner.
40 * Choose “**Create new report template**”.
41 * In the popup, fill out the following:
42 ** **Name** – a descriptive name for the report template.
43 ** **Format**: Choose **PDF** or **CSV** report format.
44 ** **Type**:
45 *** **Report** - a complete standalone report template.
46 *** Subreport - a modular component that can be embedded inside another report.
47 ** 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.
48 ** Open the “**Reporting**” page from the left-hand sidebar. You'll automatically be taken to the “**Templates**” tab.
49 ** Click the “**+ Add report template**” button in the top-right corner.
50 ** Choose “**Create new report template**”.
51 ** In the popup, fill out the following:
52 *** **Name** – a descriptive name for the report template.
53 *** **Format**: Choose **PDF** or **CSV** report format.
54 *** **Type**:
55 **** **Report** - a complete standalone report template.
56 **** Subreport - a modular component that can be embedded inside another report.
57 *** 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.
58
59
Hera Guo 2.1 60 [[image:1757899242101-256.png||height="245" width="711"]]
61
62 ----
63
64
65
Hera Guo 3.1 66 [[image:1757899267136-753.png||height="435" width="712"]]