Changes for page Create report

Last modified by Hera Guo on 2025/09/16 14:41
From version 3.1
edited by Hera Guo
on 2025/09/15 09:21
Change comment: There is no comment for this version
To version 11.1
edited by Hera Guo
on 2025/09/15 11:08
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,39 +1,136 @@
1 +(% class="wikigeneratedid" %)
2 +Table of contants:
3 +
4 +{{toc/}}
5 +
6 +
1 1  = **Overview** =
2 2  
3 -在 ThingsEye中，**报告**是一种强大而灵活的工具，用于以报告的形式收集、构建和自动分发数据。
9 +In ThingsBoard, **Reporting** is a powerful and flexible tool for collecting, structuring, and automatically distributing data in the form of reports.
4 4  
5 -ThingsEye中的报告基于两个关键组件：
11 +Reporting in ThingsBoard is built on two key components:
6 6  
7 -* **配置报告模板**——定义报告的结构、内容和格式。模板可以是**PDF**或**CSV**格式，并且可以包含任何支持的组件，例如表格、图表、文本块、图像等。
8 -* **调度程序事件**——在指定时间自动触发报告生成，并通过可用的传递渠道（例如**电子邮件**、**Slack**和其他集成）将其发送给选定的收件人。
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).
9 9  
10 -**主要特点：**
16 +**Key features:**
11 11  
12 -* **自动调度**——预先配置的调度程序事件可以按照设定的时间表发送报告，无需任何用户操作。
13 -* **可重复使用的模板**——通过应用过滤器和参数，单个模板可用于不同的收件人。
14 -* **基于事件的交付**——当特定事件发生时发送报告（例如，设备上的活动警报）。
15 -* **丰富的内容支持**——包括文本块、表格、图表、图像等。
16 -* **通知集成**——将生成的报告附加到系统通知（电子邮件、Slack）。
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).
17 17  
18 -**益处：**
24 +**Where it's useful:**
19 19  
20 -* 定期监控您的设备指标。
21 -* 与合作伙伴或管理层共享摘要数据。
22 -* 以易于阅读的格式存档数据。
23 -* 事件发生时实现自动化沟通。
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.
24 24  
25 25  **报告形式：**
26 26  
27 -* **PDF——**视觉风格的报告，可能包括图表、表格、图像和公司品牌。
28 -* **CSV** – 面向数据的表格报告，易于在 Excel 或 BI 工具中进行分析。
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.
29 29  
30 -== 如何使用 ==
36 +**Demo：**
31 31  
38 +[[image:1757901233737-956.png||height="405" width="720"]]
32 32  
33 -[[image:1757899242101-256.png||height="245" width="711"]]
34 34  
41 +[[image:1757901251979-243.png||height="1021" width="722"]]
42 +
43 +
35 35  ----
36 36  
46 += **How to generate a simple report** =
37 37  
48 +== **Creat report** ==
38 38  
50 +* (((
51 +Open the “**Reporting**” page from the left-hand sidebar. You'll automatically be taken to the “**Templates**” tab.
52 +)))
53 +* Click the “**+ Add report template**” button in the top-right corner.
54 +* Choose “**Create new report template**”.
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 +** Open the “**Reporting**” page from the left-hand sidebar. You'll automatically be taken to the “**Templates**” tab.
63 +** Click the “**+ Add report template**” button in the top-right corner.
64 +** Choose “**Create new report template**”.
65 +
66 +[[image:1757899242101-256.png||height="245" width="711"]]
67 +
68 +* In the popup, fill out the following:
69 +** **Name** – a descriptive name for the report template.
70 +** **Format**: Choose **PDF** or **CSV** report format.
71 +** **Type**:
72 +*** **Report** - a complete standalone report template.
73 +*** Subreport - a modular component that can be embedded inside another report.
74 +** 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.
75 +
39 39  [[image:1757899267136-753.png||height="435" width="712"]]
77 +
78 +
79 +----
80 +
81 +== **Report Builder** ==
82 +
83 +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.
84 +
85 +Each component has two main configuration sections:
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.
89 +
90 +Here's what the Report Builder looks like:
91 +
92 +[[image:1757900905980-599.png||height="660" width="715"]]
93 +
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||height="492" width="722"]]
99 +
100 +
101 +[[image:1757904522206-991.png||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||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||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||height="405" width="716"]]
114 +
115 +* And so on, continue to add other components
116 +
117 +[[image:1757904996853-139.png||height="484" width="720"]]
118 +
119 +
120 +[[image:1757905097135-701.png||height="573" width="716"]]
121 +
122 +
123 +----
124 +
125 +== **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||height="572" width="709"]]
130 +
131 +
132 +**Demo:**
133 +
134 +[[image:1757905629976-248.png||height="1002" width="713"]]
135 +
136 +
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
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