Changes for page Create report

Last modified by Hera Guo on 2025/09/16 14:41

From version 8.1
edited by Hera Guo
on 2025/09/15 10:39
Change comment: There is no comment for this version
To version 13.1
edited by Hera Guo
on 2025/09/15 11:10
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -4,7 +4,7 @@
4 4  {{toc/}}
5 5  
6 6  
7 -= **Overview** =
7 += **1. Overview** =
8 8  
9 9  In ThingsBoard, **Reporting** is a powerful and flexible tool for collecting, structuring, and automatically distributing data in the form of reports.
10 10  
... ... @@ -28,7 +28,7 @@
28 28  * Archiving data in an easy-to-read format.
29 29  * Automating communication during incidents.
30 30  
31 -**报告形式:**
31 +**Report format:**
32 32  
33 33  * **PDF** – visually styled reports that may include charts, tables, images, and company branding.
34 34  * **CSV** – data-oriented tabular reports that are easy to analyze in Excel or BI tools.
... ... @@ -35,16 +35,18 @@
35 35  
36 36  **Demo:**
37 37  
38 -[[image:1757901233737-956.png||height="405" width="720"]]
38 +[[image:1757901233737-956.png||_mstalt="297427" height="405" width="720"]]
39 39  
40 40  
41 -[[image:1757901251979-243.png||height="1021" width="722"]]
41 +[[image:1757901251979-243.png||_mstalt="296179" height="1021" width="722"]]
42 42  
43 43  
44 44  ----
45 45  
46 -= **How to generate a simple report** =
46 += **2. How to generate a simple report** =
47 47  
48 +== **2.1 Creat report** ==
49 +
48 48  * (((
49 49  Open the “**Reporting**” page from the left-hand sidebar. You'll automatically be taken to the “**Templates**” tab.
50 50  )))
... ... @@ -53,7 +53,7 @@
53 53  * In the popup, fill out the following:
54 54  ** **Name** – a descriptive name for the report template.
55 55  ** **Format**: Choose **PDF** or **CSV** report format.
56 -** **Type**:
58 +** (% _mstmutation="1" %)**Type**(%%):
57 57  *** **Report** - a complete standalone report template.
58 58  *** Subreport - a modular component that can be embedded inside another report.
59 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.
... ... @@ -61,32 +61,74 @@
61 61  ** Click the “**+ Add report template**” button in the top-right corner.
62 62  ** Choose “**Create new report template**”.
63 63  
64 -[[image:1757899242101-256.png||height="245" width="711"]]
66 +[[image:1757899242101-256.png||_mstalt="294606" height="245" width="711"]]
65 65  
66 66  * In the popup, fill out the following:
67 67  ** **Name** – a descriptive name for the report template.
68 68  ** **Format**: Choose **PDF** or **CSV** report format.
69 -** **Type**:
71 +** (% _mstmutation="1" %)**Type**(%%):
70 70  *** **Report** - a complete standalone report template.
71 71  *** Subreport - a modular component that can be embedded inside another report.
72 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 73  
74 -[[image:1757899267136-753.png||height="435" width="712"]]
76 +[[image:1757899267136-753.png||_mstalt="298441" height="435" width="712"]]
75 75  
76 76  
77 77  ----
78 78  
79 -== **Report Builder** ==
81 +== **2.2 Report Builder** ==
80 80  
81 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 82  
83 -每个组件都有两个主要配置部分:
85 +Each component has two main configuration sections:
84 84  
85 -* **数据配置** — 定义组件将显示哪些数据以及如何过滤这些数据。支持动态数据绑定的实体别名和过滤器。
86 -* **布局配置** — 控制最终文档中的视觉样式和格式。
87 +* **Data configuration** — defines which data the component will display and how it will be filtered. Supports entity aliases and filters for dynamic data binding.
88 +* **Layout configuration** — controls the visual style and formatting in the final document.
87 87  
88 88  Here's what the Report Builder looks like:
89 89  
90 -[[image:1757900905980-599.png||height="660" width="715"]]
92 +[[image:1757900905980-599.png||_mstalt="299195" height="660" width="715"]]
91 91  
94 +----
95 +
96 +* 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).
97 +
98 +[[image:1757904337253-670.png||_mstalt="295282" height="492" width="722"]]
99 +
100 +
101 +[[image:1757904522206-991.png||_mstalt="295672" height="342" width="724"]]
102 +
103 +* 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.
104 +
105 +[[image:1757904586368-737.png||_mstalt="299325" height="376" width="718"]]
106 +
107 +* **Select variables** (for example, ${humidity}), and its value will be inserted into the report during generation.
108 +
109 +[[image:1757904657842-206.png||_mstalt="295763" height="482" width="716"]]
110 +
111 +* When finished, click the “**Save**” button in the top-right corner to apply your changes.
112 +
113 +[[image:1757904729910-988.png||_mstalt="299598" height="405" width="716"]]
114 +
115 +* And so on, continue to add other components
116 +
117 +[[image:1757904996853-139.png||_mstalt="298844" height="484" width="720"]]
118 +
119 +
120 +[[image:1757905097135-701.png||_mstalt="294450" height="573" width="716"]]
121 +
122 +
123 +----
124 +
125 +== **2.3 Generate report** ==
126 +
127 +To verify the result, generate a test report sample by clicking the corresponding button in the top-right corner.
128 +
129 +[[image:1757905171500-699.png||_mstalt="296634" height="572" width="709"]]
130 +
131 +
132 +**Demo:**
133 +
134 +[[image:1757905724919-410.png||_mstalt="295191" height="991" width="711"]]
135 +
92 92  
1757904286579-666.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.hera
Size
... ... @@ -1,0 +1,1 @@
1 +217.5 KB
Content
1757904337253-670.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.hera
Size
... ... @@ -1,0 +1,1 @@
1 +225.2 KB
Content
1757904522206-991.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.hera
Size
... ... @@ -1,0 +1,1 @@
1 +155.5 KB
Content
1757904586368-737.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.hera
Size
... ... @@ -1,0 +1,1 @@
1 +148.4 KB
Content
1757904657842-206.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.hera
Size
... ... @@ -1,0 +1,1 @@
1 +180.5 KB
Content
1757904729910-988.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.hera
Size
... ... @@ -1,0 +1,1 @@
1 +164.5 KB
Content
1757904794248-120.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.hera
Size
... ... @@ -1,0 +1,1 @@
1 +225.6 KB
Content
1757904996853-139.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.hera
Size
... ... @@ -1,0 +1,1 @@
1 +233.2 KB
Content
1757905097135-701.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.hera
Size
... ... @@ -1,0 +1,1 @@
1 +208.2 KB
Content
1757905171500-699.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.hera
Size
... ... @@ -1,0 +1,1 @@
1 +248.7 KB
Content
1757905629976-248.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.hera
Size
... ... @@ -1,0 +1,1 @@
1 +100.7 KB
Content
1757905724919-410.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.hera
Size
... ... @@ -1,0 +1,1 @@
1 +101.8 KB
Content