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 6.1
edited by Hera Guo
on 2025/09/15 09:56
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,0 +1,86 @@
1 +(% class="wikigeneratedid" %)
2 +Table of contants:
3 +
4 +{{toc/}}
5 +
6 +(% class="wikigeneratedid" id="H" %)
7 +
8 +
9 += **Overview** =
10 +
11 +In ThingsBoard, **Reporting** is a powerful and flexible tool for collecting, structuring, and automatically distributing data in the form of reports.
12 +
13 +Reporting in ThingsBoard is built on two key components:
14 +
15 +* **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.
16 +* **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).
17 +
18 +**Key features:**
19 +
20 +* **Automated scheduling** – preconfigured scheduler events can send reports on a set schedule without any user action.
21 +* **Reusable templates** – a single template can be used for different recipients by applying filters and parameters.
22 +* **Event-based delivery** – send reports when specific events occur (e.g., an active alarm on a device).
23 +* **Rich content support** – include text blocks, tables, charts, images, and more.
24 +* **Notification integration** – attach a generated report to system notifications (Email, Slack).
25 +
26 +**Where it's useful:**
27 +
28 +* Regular monitoring of your device's metrics.
29 +* Sharing summary data with partners or management.
30 +* Archiving data in an easy-to-read format.
31 +* Automating communication during incidents.
32 +
33 +**报告形式：**
34 +
35 +* **PDF** – visually styled reports that may include charts, tables, images, and company branding.
36 +* **CSV** – data-oriented tabular reports that are easy to analyze in Excel or BI tools.
37 +
38 +**Demo：**
39 +
40 +[[image:1757901233737-956.png||height="405" width="720"]]
41 +
42 +
43 +[[image:1757901251979-243.png||height="1021" width="722"]]
44 +
45 +
46 +----
47 +
48 +== **How to start** ==
49 +
50 +* Open the “**Reporting**” page from the left-hand sidebar. You'll automatically be taken to the “**Templates**” tab.
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 +
64 +[[image:1757899242101-256.png||height="245" width="711"]]
65 +
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 +
77 +----
78 +
79 +== **Report Builder** ==
80 +
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.
82 +
83 +Here's what the Report Builder looks like:
84 +
85 +[[image:1757900905980-599.png||height="660" width="715"]]
86 +
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