Changes for page Create report

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

Summary

Details

Page properties
Content
... ... @@ -1,117 +1,0 @@
1 -(% class="wikigeneratedid" %)
2 -Table of contants:
3 -
4 -{{toc/}}
5 -
6 -
7 -= **Overview** =
8 -
9 -In ThingsBoard, **Reporting** is a powerful and flexible tool for collecting, structuring, and automatically distributing data in the form of reports.
10 -
11 -Reporting in ThingsBoard is built on two key components:
12 -
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).
15 -
16 -**Key features:**
17 -
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).
23 -
24 -**Where it's useful:**
25 -
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.
30 -
31 -**报告形式：**
32 -
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.
35 -
36 -**Demo：**
37 -
38 -[[image:1757901233737-956.png||height="405" width="720"]]
39 -
40 -
41 -[[image:1757901251979-243.png||height="1021" width="722"]]
42 -
43 -
44 -----
45 -
46 -= **How to generate a simple report** =
47 -
48 -* (((
49 -Open the “**Reporting**” page from the left-hand sidebar. You'll automatically be taken to the “**Templates**” tab.
50 -)))
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 -Each component has two main configuration sections:
84 -
85 -* **Data configuration** — defines which data the component will display and how it will be filtered. Supports entity aliases and filters for dynamic data binding.
86 -* **Layout configuration** — controls the visual style and formatting in the final document.
87 -
88 -Here's what the Report Builder looks like:
89 -
90 -[[image:1757900905980-599.png||height="660" width="715"]]
91 -
92 -----
93 -
94 -* In the **Report Builder**, add a component (for example, Rich text) and, in the “**Data**” tab, specify its data source (target entity and data keys).
95 -
96 -[[image:1757904337253-670.png||height="492" width="722"]]
97 -
98 -
99 -[[image:1757904522206-991.png||height="342" width="724"]]
100 -
101 -* Next, in the component's text field, type the symbol where you want to insert a variable's value. This will open a list of all available variables in the current context.
102 -
103 -[[image:1757904586368-737.png||height="376" width="718"]]
104 -
105 -* **Select variables** (for example, ${humidity}), and its value will be inserted into the report during generation.
106 -
107 -[[image:1757904657842-206.png||height="482" width="716"]]
108 -
109 -* When finished, click the “**Save**” button in the top-right corner to apply your changes.
110 -
111 -[[image:1757904729910-988.png||height="405" width="716"]]
112 -
113 -----
114 -
115 -To verify the result, generate a test report sample by clicking the corresponding button in the top-right corner.
116 -
117 -[[image:1757904794248-120.png||height="481" width="716"]]
1757899242101-256.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.hera
Size
... ... @@ -1,1 +1,0 @@
1 -74.6 KB
Content
1757899267136-753.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.hera
Size
... ... @@ -1,1 +1,0 @@
1 -119.4 KB
Content
1757900905980-599.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.hera
Size
... ... @@ -1,1 +1,0 @@
1 -169.6 KB
Content
1757901233737-956.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.hera
Size
... ... @@ -1,1 +1,0 @@
1 -401.6 KB
Content
1757901251979-243.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.hera
Size
... ... @@ -1,1 +1,0 @@
1 -342.1 KB
Content
1757904286579-666.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.hera
Size
... ... @@ -1,1 +1,0 @@
1 -217.5 KB
Content
1757904337253-670.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.hera
Size
... ... @@ -1,1 +1,0 @@
1 -225.2 KB
Content
1757904522206-991.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.hera
Size
... ... @@ -1,1 +1,0 @@
1 -155.5 KB
Content
1757904586368-737.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.hera
Size
... ... @@ -1,1 +1,0 @@
1 -148.4 KB
Content
1757904657842-206.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.hera
Size
... ... @@ -1,1 +1,0 @@
1 -180.5 KB
Content
1757904729910-988.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.hera
Size
... ... @@ -1,1 +1,0 @@
1 -164.5 KB
Content
1757904794248-120.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.hera
Size
... ... @@ -1,1 +1,0 @@
1 -225.6 KB
Content