Changes for page Create report

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

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Report Guide
1 +Overview/Creating a simple report
Content
... ... @@ -1,9 +1,13 @@
1 -= **Overview** =
1 +(% class="wikigeneratedid" %)
2 +Table of contants:
2 2  
3 -In ThingsBoard, **Reporting** is a powerful and flexible tool for collecting, structuring, and automatically distributing data in the form of reports.
4 +{{toc/}}
4 4  
5 -Reporting in ThingsBoard is built on two key components:
6 6  
7 +In ThingsEye, **Reporting** is a powerful and flexible tool for collecting, structuring, and automatically distributing data in the form of reports.
8 +
9 +Reporting in ThingsEyeis built on two key components:
10 +
7 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 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 9  
... ... @@ -22,7 +22,7 @@
22 22  * Archiving data in an easy-to-read format.
23 23  * Automating communication during incidents.
24 24  
25 -**报告形式：**
29 +**Report format：**
26 26  
27 27  * **PDF** – visually styled reports that may include charts, tables, images, and company branding.
28 28  * **CSV** – data-oriented tabular reports that are easy to analyze in Excel or BI tools.
... ... @@ -29,20 +29,27 @@
29 29  
30 30  **Demo：**
31 31  
32 -[[image:1757901233737-956.png||height="405" width="720"]]
36 +[[image:1757901233737-956.png||_mstalt="297427" height="405" width="720"]]
33 33  
34 -[[image:1757901251979-243.png||height="1021" width="722"]]
35 35  
39 +[[image:1757901251979-243.png||_mstalt="296179" height="1021" width="722"]]
36 36  
37 -== **如何开始** ==
38 38  
39 -* Open the “**Reporting**” page from the left-hand sidebar. You'll automatically be taken to the “**Templates**” tab.
42 +----
43 +
44 += **How to generate a simple report** =
45 +
46 +== **Creat report** ==
47 +
48 +* (((
49 +Open the “**Reporting**” page from the left-hand sidebar. You'll automatically be taken to the “**Templates**” tab.
50 +)))
40 40  * Click the “**+ Add report template**” button in the top-right corner.
41 41  * Choose “**Create new report template**”.
42 42  * In the popup, fill out the following:
43 43  ** **Name** – a descriptive name for the report template.
44 44  ** **Format**: Choose **PDF** or **CSV** report format.
45 -** **Type**:
56 +** (% _mstmutation="1" %)**Type**(%%):
46 46  *** **Report** - a complete standalone report template.
47 47  *** Subreport - a modular component that can be embedded inside another report.
48 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.
... ... @@ -50,25 +50,74 @@
50 50  ** Click the “**+ Add report template**” button in the top-right corner.
51 51  ** Choose “**Create new report template**”.
52 52  
53 -[[image:1757899242101-256.png||height="245" width="711"]]
64 +[[image:1757899242101-256.png||_mstalt="294606" height="245" width="711"]]
54 54  
55 55  * In the popup, fill out the following:
56 56  ** **Name** – a descriptive name for the report template.
57 57  ** **Format**: Choose **PDF** or **CSV** report format.
58 -** **Type**:
69 +** (% _mstmutation="1" %)**Type**(%%):
59 59  *** **Report** - a complete standalone report template.
60 60  *** Subreport - a modular component that can be embedded inside another report.
61 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 62  
63 -[[image:1757899267136-753.png||height="435" width="712"]]
74 +[[image:1757899267136-753.png||_mstalt="298441" height="435" width="712"]]
64 64  
65 65  
66 66  ----
67 67  
68 -== **Report builder** ==
79 +== **Report Builder** ==
69 69  
70 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 71  
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 +
72 72  Here's what the Report Builder looks like:
73 73  
74 -[[image:1757900905980-599.png||height="660" width="715"]]
90 +[[image:1757900905980-599.png||_mstalt="299195" 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||_mstalt="295282" height="492" width="722"]]
97 +
98 +
99 +[[image:1757904522206-991.png||_mstalt="295672" 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||_mstalt="299325" 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||_mstalt="295763" 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||_mstalt="299598" height="405" width="716"]]
112 +
113 +* And so on, continue to add other components
114 +
115 +[[image:1757904996853-139.png||_mstalt="298844" height="484" width="720"]]
116 +
117 +
118 +[[image:1757905097135-701.png||_mstalt="294450" height="573" width="716"]]
119 +
120 +
121 +----
122 +
123 +== **Generate report** ==
124 +
125 +To verify the result, generate a test report sample by clicking the corresponding button in the top-right corner.
126 +
127 +[[image:1757905171500-699.png||_mstalt="296634" height="572" width="709"]]
128 +
129 +
130 +**Demo:**
131 +
132 +[[image:1757905724919-410.png||_mstalt="295191" height="991" width="711"]]
133 +
134 +
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