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 15.2
edited by Hera Guo
on 2025/09/15 16:06
Change comment: Update property hidden

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Report Guide
1 +Overview/Creating a simple report
Hidden
... ... @@ -1,1 +1,1 @@
1 -true
1 +false
Content
... ... @@ -1,0 +1,134 @@
1 +(% class="wikigeneratedid" %)
2 +Table of contants:
3 +
4 +{{toc/}}
5 +
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 +
11 +* **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.
12 +* **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).
13 +
14 +**Key features:**
15 +
16 +* **Automated scheduling** – preconfigured scheduler events can send reports on a set schedule without any user action.
17 +* **Reusable templates** – a single template can be used for different recipients by applying filters and parameters.
18 +* **Event-based delivery** – send reports when specific events occur (e.g., an active alarm on a device).
19 +* **Rich content support** – include text blocks, tables, charts, images, and more.
20 +* **Notification integration** – attach a generated report to system notifications (Email, Slack).
21 +
22 +**Where it's useful:**
23 +
24 +* Regular monitoring of your device's metrics.
25 +* Sharing summary data with partners or management.
26 +* Archiving data in an easy-to-read format.
27 +* Automating communication during incidents.
28 +
29 +**Report format：**
30 +
31 +* **PDF** – visually styled reports that may include charts, tables, images, and company branding.
32 +* **CSV** – data-oriented tabular reports that are easy to analyze in Excel or BI tools.
33 +
34 +**Demo：**
35 +
36 +[[image:1757901233737-956.png||_mstalt="297427" height="405" width="720"]]
37 +
38 +
39 +[[image:1757901251979-243.png||_mstalt="296179" height="1021" width="722"]]
40 +
41 +
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 +)))
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 +** (% _mstmutation="1" %)**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||_mstalt="294606" 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 +** (% _mstmutation="1" %)**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||_mstalt="298441" 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||_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 +
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
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