Changes for page Create report

Last modified by Hera Guo on 2025/09/16 14:41
From version 1.1
edited by Hera Guo
on 2025/09/15 09:11
Change comment: There is no comment for this version
To version 5.1
edited by Hera Guo
on 2025/09/15 09:54
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,0 +1,74 @@
1 += **Overview** =
2 +
3 +In ThingsBoard, **Reporting** is a powerful and flexible tool for collecting, structuring, and automatically distributing data in the form of reports.
4 +
5 +Reporting in ThingsBoard is built on two key components:
6 +
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).
9 +
10 +**Key features:**
11 +
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).
17 +
18 +**Where it's useful:**
19 +
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.
24 +
25 +**报告形式：**
26 +
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.
29 +
30 +**Demo：**
31 +
32 +[[image:1757901233737-956.png||height="405" width="720"]]
33 +
34 +[[image:1757901251979-243.png||height="1021" width="722"]]
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 +
53 +[[image:1757899242101-256.png||height="245" width="711"]]
54 +
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 +
66 +----
67 +
68 +== **Report builder** ==
69 +
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.
71 +
72 +Here's what the Report Builder looks like:
73 +
74 +[[image:1757900905980-599.png||height="660" width="715"]]
1757899242101-256.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.hera
Size
... ... @@ -1,0 +1,1 @@
1 +74.6 KB
Content
1757899267136-753.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.hera
Size
... ... @@ -1,0 +1,1 @@
1 +119.4 KB
Content
1757900905980-599.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.hera
Size
... ... @@ -1,0 +1,1 @@
1 +169.6 KB
Content
1757901233737-956.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.hera
Size
... ... @@ -1,0 +1,1 @@
1 +401.6 KB
Content
1757901251979-243.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.hera
Size
... ... @@ -1,0 +1,1 @@
1 +342.1 KB
Content