Wiki source code of Report Guide
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
2.1 | 1 | = **Overview** = |
| 2 | |||
| |
4.1 | 3 | In ThingsBoard, **Reporting** is a powerful and flexible tool for collecting, structuring, and automatically distributing data in the form of reports. |
| |
2.1 | 4 | |
| |
4.1 | 5 | Reporting in ThingsBoard is built on two key components: |
| |
2.1 | 6 | |
| |
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). | ||
| |
2.1 | 9 | |
| |
4.1 | 10 | **Key features:** |
| |
2.1 | 11 | |
| |
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). | ||
| |
2.1 | 17 | |
| |
4.1 | 18 | **Where it's useful:** |
| |
2.1 | 19 | |
| |
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. | ||
| |
2.1 | 24 | |
| 25 | **报告形式：** | ||
| 26 | |||
| |
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. | ||
| |
2.1 | 29 | |
| |
4.1 | 30 | **Demo：** |
| |
2.1 | 31 | |
| |
5.1 | 32 | [[image:1757901233737-956.png||height="405" width="720"]] |
| |
4.1 | 33 | |
| |
5.1 | 34 | [[image:1757901251979-243.png||height="1021" width="722"]] |
| |
4.1 | 35 | |
| 36 | |||
| 37 | == **如何开始** == | ||
| 38 | |||
| 39 | * Open the “**Reporting**” page from the left-hand sidebar. You'll automatically be taken to the “**Templates**” tab. | ||
| 40 | * Click the “**+ Add report template**” button in the top-right corner. | ||
| 41 | * Choose “**Create new report template**”. | ||
| 42 | * In the popup, fill out the following: | ||
| 43 | ** **Name** – a descriptive name for the report template. | ||
| 44 | ** **Format**: Choose **PDF** or **CSV** report format. | ||
| 45 | ** **Type**: | ||
| 46 | *** **Report** - a complete standalone report template. | ||
| 47 | *** Subreport - a modular component that can be embedded inside another report. | ||
| 48 | ** 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. | ||
| 49 | ** Open the “**Reporting**” page from the left-hand sidebar. You'll automatically be taken to the “**Templates**” tab. | ||
| 50 | ** Click the “**+ Add report template**” button in the top-right corner. | ||
| 51 | ** Choose “**Create new report template**”. | ||
| 52 | |||
| |
2.1 | 53 | [[image:1757899242101-256.png||height="245" width="711"]] |
| 54 | |||
| |
5.1 | 55 | * In the popup, fill out the following: |
| 56 | ** **Name** – a descriptive name for the report template. | ||
| 57 | ** **Format**: Choose **PDF** or **CSV** report format. | ||
| 58 | ** **Type**: | ||
| 59 | *** **Report** - a complete standalone report template. | ||
| 60 | *** Subreport - a modular component that can be embedded inside another report. | ||
| 61 | ** 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. | ||
| 62 | |||
| 63 | [[image:1757899267136-753.png||height="435" width="712"]] | ||
| 64 | |||
| 65 | |||
| |
2.1 | 66 | ---- |
| 67 | |||
| |
5.1 | 68 | == **Report builder** == |
| |
2.1 | 69 | |
| |
5.1 | 70 | 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 | 71 | |
| |
5.1 | 72 | Here's what the Report Builder looks like: |
| 73 | |||
| 74 | [[image:1757900905980-599.png||height="660" width="715"]] |