Wiki source code of How to set threshold alarm and get Email notification
Last modified by Alec Chen on 2025/12/22 09:43
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | = This tutorial aims to guide **ONLY tenant-level users **on how to configure alarm rules and set up email notifications for each device without writing code or modifying the rule chain. = | ||
| 2 | |||
| 3 | |||
| 4 | |||
| 5 | {{toc/}} | ||
| 6 | |||
| 7 | = 1. Import dashboard = | ||
| 8 | |||
| 9 | The Dashboard shown below displays all devices by default. [[attach:set_alarm.json||target="_blank"]] | ||
| 10 | |||
| 11 | [[image:https://wiki.thingseye.io/xwiki/bin/download/Downlink%20Command%20Guide/WebHome/1762933458042-294.png?width=645&height=565&rev=1.1||alt="1762933458042-294.png" height="898" width="1025"]] | ||
| 12 | |||
| 13 | [[image:1763627459220-746.png]] | ||
| 14 | |||
| 15 | |||
| 16 | Each device's threshold are managed separately. Clicking on a device in the device list on the left will display the current device status and preset thresholds/email addresses on the right. | ||
| 17 | |||
| 18 | [[image:1763713260857-974.png||height="792" width="1029"]] | ||
| 19 | |||
| 20 | |||
| 21 | ---- | ||
| 22 | |||
| 23 | = (% id="cke_bm_9685S" style="display:none" %) (%%)2. Configure profile rules = | ||
| 24 | |||
| 25 | == 2.1 Create a condition to trigger an alarm when a threshold is reached. == | ||
| 26 | |||
| 27 | (% class="wikigeneratedid" id="H70B951FB7F168F9156FE68078FDB51657F168F916A215F0F5E7665B05EFA62A58B6689C45219" %) | ||
| 28 | Click the edit icon to enter edit mode and create a new alarm rule. | ||
| 29 | |||
| 30 | (% class="wikigeneratedid" id="H-1" %) | ||
| 31 | [[image:1763630110726-980.png||height="720" width="1014"]] | ||
| 32 | |||
| 33 | [[image:1763630224004-924.png||height="720" width="1014"]] | ||
| 34 | |||
| 35 | [[image:1763630671736-678.png||height="721" width="1015"]] | ||
| 36 | |||
| 37 | [[image:1763630710302-584.png||height="721" width="1015"]] | ||
| 38 | |||
| 39 | [[image:1763630805148-569.png||height="721" width="1015"]] | ||
| 40 | |||
| 41 | [[image:1763630987781-241.png||height="721" width="1015"]] | ||
| 42 | |||
| 43 | [[image:1763714060349-779.png||height="782" width="1016"]] | ||
| 44 | |||
| 45 | |||
| 46 | [[image:1763631366289-693.png||height="720" width="1014"]] | ||
| 47 | |||
| 48 | [[image:1763709709956-185.png||height="722" width="1015"]] | ||
| 49 | |||
| 50 | |||
| 51 | |||
| 52 | ---- | ||
| 53 | |||
| 54 | == 2.2 Set a clear condition to clear the alarm when the data returns to normal. == | ||
| 55 | |||
| 56 | The steps are similar to Create alarm, only the values are set in reverse. | ||
| 57 | |||
| 58 | [[image:1763632387865-386.png||height="720" width="1014"]] | ||
| 59 | |||
| 60 | [[image:1763693498016-737.png||height="720" width="1014"]] | ||
| 61 | |||
| 62 | [[image:1763693573052-369.png||height="723" width="1018"]] | ||
| 63 | |||
| 64 | [[image:1763708672557-593.png||height="723" width="1017"]] | ||
| 65 | |||
| 66 | |||
| 67 | **Save after set** | ||
| 68 | |||
| 69 | [[image:1763708628399-171.png||height="723" width="1017"]] | ||
| 70 | |||
| 71 | [[image:1763694048124-392.png||height="722" width="1017"]] | ||
| 72 | |||
| 73 | [[image:1763694065009-504.png||height="722" width="1017"]] | ||
| 74 | |||
| 75 | |||
| 76 | ---- | ||
| 77 | |||
| 78 | = 3. Configure the threshold input box = | ||
| 79 | |||
| 80 | == 3.1 Select the Realtime data key to display == | ||
| 81 | |||
| 82 | Return to the dashboard and click on the device you want to edit. | ||
| 83 | |||
| 84 | [[image:1763714842488-945.png||height="784" width="1018"]] | ||
| 85 | |||
| 86 | [[image:1763715443568-173.png||height="784" width="1019"]] | ||
| 87 | |||
| 88 | |||
| 89 | **Click "Edit mode" to enter edit mode.** | ||
| 90 | |||
| 91 | [[image:1763715522992-941.png||height="785" width="1020"]] | ||
| 92 | |||
| 93 | [[image:1763715545212-375.png||height="786" width="1021"]] | ||
| 94 | |||
| 95 | |||
| 96 | **Delete the default key and select the key you want to display.** | ||
| 97 | |||
| 98 | [[image:1763717628344-632.png||height="789" width="1024"]] | ||
| 99 | |||
| 100 | |||
| 101 | **Save after confirmation.** | ||
| 102 | |||
| 103 | [[image:1763717656075-762.png||height="790" width="1026"]] | ||
| 104 | |||
| 105 | [[image:1763717678221-857.png||height="792" width="1029"]] | ||
| 106 | |||
| 107 | |||
| 108 | ---- | ||
| 109 | |||
| 110 | == 3.2 Create Threshold KEY == | ||
| 111 | |||
| 112 | Enter edit mode and select the Threshold Setting component. | ||
| 113 | |||
| 114 | [[image:1763717776928-677.png||height="794" width="1031"]] | ||
| 115 | |||
| 116 | [[image:1763717871745-156.png||height="794" width="1031"]] | ||
| 117 | |||
| 118 | |||
| 119 | **Save after add.** | ||
| 120 | |||
| 121 | [[image:1763718016288-797.png||height="795" width="1033"]] | ||
| 122 | |||
| 123 | [[image:1763718040563-785.png||height="797" width="1035"]] | ||
| 124 | |||
| 125 | ---- | ||
| 126 | |||
| 127 | == **3.3 Example** == | ||
| 128 | |||
| 129 | [[image:1763718234145-302.png||height="799" width="1037"]] | ||
| 130 | |||
| 131 | |||
| 132 | (% id="cke_bm_30710S" style="display:none" %) (%%)**Example of an alert email received:** | ||
| 133 | |||
| 134 | [[image:1763707708365-348.png]] | ||
| 135 | |||
| 136 | |||
| 137 | |||
| 138 | ---- | ||
| 139 | |||
| 140 | = 4. Configure Notification (only required for initial use) = | ||
| 141 | |||
| 142 | If this is the first time configuring the email sending function, you also need to configure the Notification to specify the recipient/template/sending rules. | ||
| 143 | |||
| 144 | == 4.1 Configure Recipients == | ||
| 145 | |||
| 146 | (% class="wikigeneratedid" id="H" %) | ||
| 147 | [[image:1763695480359-924.png||height="721" width="1015"]] | ||
| 148 | |||
| 149 | (% class="wikigeneratedid" id="H-1" %) | ||
| 150 | [[image:1763696273020-168.png||height="721" width="1015"]] | ||
| 151 | |||
| 152 | (% class="wikigeneratedid" id="H-2" %) | ||
| 153 | [[image:1763696322001-489.png||height="721" width="1015"]] | ||
| 154 | |||
| 155 | (% class="wikigeneratedid" %) | ||
| 156 | [[image:1763696373932-724.png||height="722" width="1015"]] | ||
| 157 | |||
| 158 | |||
| 159 | ---- | ||
| 160 | |||
| 161 | == 4.2 Configuring Templates == | ||
| 162 | |||
| 163 | [[image:1763704822528-793.png||height="721" width="1014"]] | ||
| 164 | |||
| 165 | **Set Compose** | ||
| 166 | |||
| 167 | (% class="box" %) | ||
| 168 | ((( | ||
| 169 | **Web** | ||
| 170 | |||
| 171 | **Subjtct:**${alarmOriginatorName} ${alarmType} | ||
| 172 | |||
| 173 | **Message:**${alarmOriginatorName} alarmed ${alarmType} | ||
| 174 | |||
| 175 | **Email** | ||
| 176 | |||
| 177 | **Subjtct:**${alarmOriginatorName} ${alarmType} | ||
| 178 | |||
| 179 | |||
| 180 | **Message:**Hi ${recipientFirstName:capitalize} ${recipientLastName:lowerCase} | ||
| 181 | |||
| 182 | The ${alarmOriginatorName} alarmed ${alarmType} ,PLZ check | ||
| 183 | ))) | ||
| 184 | |||
| 185 | [[image:1763705354353-222.png||height="719" width="1012"]] | ||
| 186 | |||
| 187 | [[image:1763705373057-540.png||height="719" width="1012"]] | ||
| 188 | |||
| 189 | |||
| 190 | ---- | ||
| 191 | |||
| 192 | == 4.3 Configure Notification Rules == | ||
| 193 | |||
| 194 | [[image:1763705587312-647.png||height="719" width="1012"]] | ||
| 195 | |||
| 196 | [[image:1763706113413-196.png||height="721" width="1015"]] | ||
| 197 | |||
| 198 | [[image:1763706072650-624.png||height="722" width="1016"]] | ||
| 199 | |||
| 200 | [[image:1763706241273-512.png||height="722" width="1016"]] | ||
| 201 | |||
| 202 | [[image:1763707736962-945.png||height="723" width="1017"]] | ||
| 203 | |||
| 204 | |||
| 205 | ---- | ||
| 206 | |||
| 207 | = Extended content: = | ||
| 208 | |||
| 209 | = 5. What if I want to send an email to a specific recipient? = | ||
| 210 | |||
| 211 | Currently, it supports three recipient types: Platform users, Slack, and Microsoft Teams. You can create a user using the email address you want to receive emails from, and then select the recipient in Platform users -> UserList. | ||
| 212 | |||
| 213 | [[image:1763970065522-362.png||height="550" width="1017"]] | ||
| 214 | |||
| 215 | [[image:1763970125819-288.png||height="550" width="1017"]] | ||
| 216 | |||
| 217 | [[image:1763970168381-554.png||height="551" width="1019"]] | ||
| 218 | |||
| 219 | [[image:1763970202306-593.png||height="552" width="1021"]] | ||
| 220 | |||
| 221 | |||
| 222 | ---- | ||
| 223 | |||
| 224 | = 6. How to set up a separate page for each device for easier management? = | ||
| 225 | |||
| 226 | Suppose we have a batch of AQI sensors and a batch of Tank sensors. How do we display them on two different pages or put them into an existing dashboard? | ||
| 227 | |||
| 228 | [[image:1764036365000-820.png||height="478" width="1022"]] | ||
| 229 | |||
| 230 | |||
| 231 | Here, we will create a blank dashboard for demonstration purposes, and create two States (Pages) to distinguish and display two different types of devices. | ||
| 232 | |||
| 233 | [[image:1764036526739-442.png||height="413" width="1024"]] | ||
| 234 | |||
| 235 | [[image:1764036704323-344.png||height="790" width="1027"]] | ||
| 236 | |||
| 237 | [[image:1764036761564-457.png||height="791" width="1028"]] | ||
| 238 | |||
| 239 | [[image:1764036789723-542.png||height="792" width="1030"]] | ||
| 240 | |||
| 241 | |||
| 242 | Add a button to the default page to navigate to different Stata instances. | ||
| 243 | |||
| 244 | [[image:1764038418645-404.png||height="495" width="1032"]] | ||
| 245 | |||
| 246 | [[image:1764038440153-893.png||height="506" width="1032"]] | ||
| 247 | |||
| 248 | [[image:1764038459795-265.png||height="446" width="1032"]] | ||
| 249 | |||
| 250 | [[image:1764038595799-636.png||height="795" width="1033"]] | ||
| 251 | |||
| 252 | [[image:1764041017702-761.png||height="847" width="1034"]] | ||
| 253 | |||
| 254 | [[image:1764041058281-147.png||height="848" width="1035"]] | ||
| 255 | |||
| 256 | [[image:1764038663915-300.png||height="288" width="1036"]] | ||
| 257 | |||
| 258 | |||
| 259 | Similarly, create an AQI alarm button. | ||
| 260 | |||
| 261 | [[image:1764038720507-522.png||height="308" width="1035"]] | ||
| 262 | |||
| 263 | |||
| 264 | Switch to Tank state | ||
| 265 | |||
| 266 | [[image:1764038993771-632.png||height="361" width="1040"]] | ||
| 267 | |||
| 268 | |||
| 269 | Open the Set Alarm dashboard in the new page and copy all the components there. | ||
| 270 | |||
| 271 | [[image:1763627459220-746.png]] | ||
| 272 | |||
| 273 | [[image:1764039091299-607.png||height="528" width="1028"]] | ||
| 274 | |||
| 275 | |||
| 276 | Enter the component editing page and switch the device group to be displayed. | ||
| 277 | |||
| 278 | [[image:1764039434202-995.png||height="496" width="1026"]] | ||
| 279 | |||
| 280 | [[image:1764039490910-964.png||height="497" width="1028"]] | ||
| 281 | |||
| 282 | |||
| 283 | Add a button to return to the initial page. | ||
| 284 | |||
| 285 | [[image:1764041404181-108.png||height="839" width="1025"]] | ||
| 286 | |||
| 287 | [[image:1764041446883-114.png||height="840" width="1026"]] | ||
| 288 | |||
| 289 | [[image:1764041476537-950.png||height="682" width="1028"]] | ||
| 290 | |||
| 291 | [[image:1764041567433-493.png||height="842" width="1028"]] | ||
| 292 | |||
| 293 | |||
| 294 | This completes the creation of a State page that only displays Tank-class devices. The AQI State configuration can be referenced from the Tank page. | ||
| 295 | |||
| 296 | [[image:1764041604908-185.png||height="843" width="1029"]] | ||
| 297 | |||
| 298 | |||
| 299 |