Changes for page Create Scheduler Report

Last modified by Hera Guo on 2025/09/16 13:56
From version 4.1
edited by Hera Guo
on 2025/09/16 10:45
Change comment: There is no comment for this version
To version 10.1
edited by Hera Guo
on 2025/09/16 13:51
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,26 +1,134 @@
1 -定时报告/对子客户安排报告
1 +Table of contents:
2 2  
3 +{{toc/}}
3 3  
4 4  
5 5  
6 6  
7 -报告系统围绕两个关键组件构建：
8 +The template defines **what** will be in the report, while the scheduler determines **when** and **to whom** it will be delivered.
8 8  
9 -* **报告模板** – 定义报告的结构、内容和格式。模板可以是 **PDF** 或 **CSV** 格式，并包含任何受支持的组件
10 -* **调度程序事件** – 在指定时间自动触发报告生成，并通过可用渠道（例如电子邮件、Slack 或其他集成）将其发送给选定的收件人。
10 +In this guide, we'll walk through the basic steps of using Reporting in ThingsEye , and create a report template with automated delivery configured for two different customers.
11 11  
12 -**简而言之**：模板定义了报告**中的内容，**而调度程序则确定报告的**交付时间**和**对象**。
12 += **1. Create the report template** =
13 13  
14 -在本指南中，我们将逐步介绍在 ThingsEye 中使用报告的基本步骤，并为两个不同的客户创建一个配置了自动交付的报告模板。
14 +By default, you are assumed to know how to create a report template. If not, please consult this wiki:**：[[Create report>>doc:Main.Report Guide.WebHome]]**
15 15  
16 16  
17 -= **Step 1. Create the report template** =
17 +----
18 18  
19 -**请查阅这个WIKI：[[Create report>>doc:Main.Report Guide.WebHome]]**
19 += **2. Scheduling the report for customers** =
20 20  
21 +**Key points for correct scheduling**
21 21  
23 +To ensure the report is generated correctly and contains accurate data, you must specify:
24 +
25 +* **Report recipients** – the users who will receive the generated report (e.g., managers or clients).
26 +* **User account** – the account under which the report will be generated. This defines the data scope and permissions applied to the report.
27 +
28 +**Example:**
29 +
30 +* If the report should include only devices owned by **Customer A**, you must set the **User** field to the email address of a user belonging to Customer A when scheduling the report.
31 +* Likewise, to schedule a report for **Customer B** recipients, use the email address of a Customer B user in the **User** field.
32 +
33 +This ensures the report will only display devices and data accessible to that specific user.
34 +
22 22  ----
23 23  
24 -= **Step 2. Create the “Alarm table” component** =
37 +== **2.1 Scheduling a report for CustomerA users** ==
25 25  
26 -
39 +First, we'll set up automated delivery of the report for all CustomerA users. The report will be generated on behalf of Alec , the administrator for this customer.
40 +
41 +* Go to the “**Scheduling**” tab on the “**Reporting**” page.
42 +* Сlick the “**+ Scheduled Report**” in the top-right corner to create a new scheduler event.
43 +
44 +[[image:1757991254381-634.png||height="721" width="1107"]]
45 +
46 +----
47 +
48 +* In the **scheduling** dialog, provide the following details:
49 +** Give your schedule event a clear title, for example: Report for Customer A
50 +** **Event type** – always set to **Create report**.
51 +** **Report template** – select the previously created Daily Devices Alarm Report template.
52 +** **User** – specify the user account on whose behalf the report will be generated: **Alec@thingseye.io** (Alec — CustomerA administrator).
53 +
54 +[[image:1757991512124-527.png||height="723" width="1110"]]
55 +
56 +----
57 +
58 +* Set the **recipients**:
59 +** In the “**Recipients**” field, click **Create new** to create a new recipient group.
60 +*** Enter a **name** for the notification recipient group.
61 +*** Select **Customer users** filter.
62 +*** Set **Customer** to **Customer A**.
63 +*** Click “**Add**”.
64 +
65 +[[image:1757991797040-630.png||height="723" width="1111"]]
66 +
67 +----
68 +
69 +* **Notification template** & delivery methods:
70 +** Select an existing notification template (defines how the report will be delivered) and edit it.
71 +** Add **Email** as a delivery method alongside **Web**. Click “**Next**”.
72 +** Add the **subject and body text** for the **email notification** to which the **PDF report** will be attached. Click “**Save**”.
73 +
74 +[[image:1757991868588-546.png||height="722" width="1112"]]
75 +
76 +[[image:1757992829865-745.png||height="722" width="1112"]]
77 +
78 +[[image:1757992985183-979.png]]
79 +
80 +----
81 +
82 += **3. Set up the schedule** =
83 +
84 +* (((
85 +Go to the **Schedule** tab.
86 +)))
87 +* **Start time** – set the date and time of the first run.
88 +* **Time zone** – choose the applicable time zone.
89 +* Enable **Repeat**:
90 +** **Interval** – select **Daily**.
91 +** **End date** – set an end date or leave blank for ongoing delivery.
92 +* Finally, click “**Create**” to save and apply the scheduler event.
93 +
94 +Now, every day at the scheduled time, all Customer A users will automatically receive a report with the latest information about their device alarms.
95 +
96 +[[image:1757994096517-904.png||height="720" width="1118"]]
97 +
98 +
99 +----
100 +
101 += **3. Scheduled events result** =
102 +
103 +Each user from customerA receives their own individual report containing only the entities they have access to.
104 +
105 +The system automatically sends the reports daily at the scheduled time, without any manual intervention.
106 +
107 +At the time specified in the scheduled events, all users of Customer A will receive notifications along with the generated report on their device alarms.
108 +
109 +Notifications will be delivered through two channels:
110 +
111 +**~1. Web UI notification**
112 +
113 +* A notification about the generated report will appear in the ThingsEye Web UI.
114 +* Tenant Users can open the report directly within the ThingsEye interface.
115 +
116 +(% class="box" %)
117 +(((
118 +**Important:**
119 +
120 +* Only Tenant Users can view generated reports directly in the ThingsEye Web UI.
121 +* Customer users do not have access to reports in the Web UI — they can only receive them through **Email** or **Slack**.
122 +If your recipients are customer users, make sure at least one of these delivery channels is selected.
123 +)))
124 +
125 +[[image:1757994928716-266.png||height="373" width="1098"]]
126 +
127 +----
128 +
129 +**2. Email notification**
130 +
131 +* An email will be sent to the user with the subject and message you configured in the notification template.
132 +* The email will have the report attached as a PDF file, which can be opened and viewed in the browser or downloaded.
133 +
134 +[[image:1757995049919-870.png||height="670" width="1095"]]
1757991254381-634.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.hera
Size
... ... @@ -1,0 +1,1 @@
1 +187.9 KB
Content
1757991512124-527.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.hera
Size
... ... @@ -1,0 +1,1 @@
1 +277.9 KB
Content
1757991797040-630.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.hera
Size
... ... @@ -1,0 +1,1 @@
1 +308.8 KB
Content
1757991868588-546.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.hera
Size
... ... @@ -1,0 +1,1 @@
1 +229.1 KB
Content
1757992733653-489.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.hera
Size
... ... @@ -1,0 +1,1 @@
1 +251.0 KB
Content
1757992829865-745.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.hera
Size
... ... @@ -1,0 +1,1 @@
1 +262.1 KB
Content
1757992985183-979.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.hera
Size
... ... @@ -1,0 +1,1 @@
1 +156.5 KB
Content
1757994096517-904.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.hera
Size
... ... @@ -1,0 +1,1 @@
1 +242.0 KB
Content
1757994928716-266.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.hera
Size
... ... @@ -1,0 +1,1 @@
1 +73.3 KB
Content
1757995032989-120.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.hera
Size
... ... @@ -1,0 +1,1 @@
1 +208.1 KB
Content
1757995049919-870.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.hera
Size
... ... @@ -1,0 +1,1 @@
1 +208.1 KB
Content