English     Dutch     French     German     Spanish

Wiki source code of Alarm management

Last modified by Matthijs Noppe on 2024/05/29 12:14

Show last authors
1 = **Introduction** =
2
3 (((
4 An alarm configuration can be set for each measuring point in the EMS. There are 3 types of alarms available as standard: Low Threshold, High Threshold, and Offline. The Custom alarm type is a feature that is not activated by default.
5 )))
6
7 (((
8
9 )))
10
11 (((
12 By default, alarm management is shown for all user types: super admin, admin, installer, and user. It is possible to hide this part.
13 )))
14
15 (((
16
17 )))
18
19 (((
20 You must set an alarm configuration for a measuring point. The evaluations of an alarm configuration are set via “alarm” in the left menu. You need a configuration and an evaluation to receive alarm emails
21 )))
22
23
24 == **The alarm configuration of a measuring point** ==
25
26 (((
27 At the measuring point level we must clearly define the time series, choose the types of alarms, and set associated parameters.
28 )))
29
30 == **Data** ==
31
32 (((
33 Type of time series: If the measuring point concerns a counter reading, then "Show counter reading as counter reading" must be selected here. The alarm configuration can handle any type of time series, but there are certain situations that can cause problems:
34 )))
35
36 (((
37
38 )))
39
40 (((
41 Data that arrives with a delay (e.g. Fluvius or Ores data) has an alarm configuration that ideally is not evaluated during the period in which data is absent. This makes it impossible to evaluate such data points in real time, but a delay can be used (“max duration of no data or delayed data”).
42 )))
43
44 (((
45
46 )))
47
48 Data that arrives irregularly
49
50 [[image:1694469998758-831.png||height="165" width="547"]]
51
52 (((
53 **Aggregation**: here you can choose whether the average value or the real-time value is evaluated. Please note: the average value corresponds to the field that is filled in under “field_mean” at a measuring point and the real-time value corresponds to the field that is filled in under “field” at a measuring point.
54 )))
55
56 (((
57
58 )))
59
60 (((
61 **PLEASE NOTE: if you work with an aggregate (a measuring point that has a field preceded by mean_), this aggregate is available with a delay. E.g. a generator that is averaged from 4:45 PM to 5:00 PM may sometimes be available at 5:01 PM or 5:10 PM. Depending on how busy the server is, a generator will be calculated sooner or later. That is why setting alarms on generators is risky.**
62 )))
63
64
65
66 __Considered time interval:__
67
68 (((
69 This is the interval in which a counter reading is evaluated, starting from the evaluation moment. Since we work with an interval, this only applies to meter readings. If the alarm management evaluates with a frequency of 5 minutes (to be set later) and the interval considered is 15 minutes, then the following example applies:
70 )))
71
72 17:00, beschouw het interval van 16u45 TOT 17u00. If there is a measuring point every minute, then these are 15 measuring points that are considered.
73
74 .
75
76 (((
77 **PLEASE NOTE: if you work with an aggregate (a measuring point that has a field preceded by mean_), this aggregate is available with a delay. E.g. a generator that is averaged from 4:45 PM to 5:00 PM may sometimes be available at 5:01 PM or 5:10 PM. Depending on how busy the server is, a generator will be calculated sooner or later. That is why setting alarms on generators is risky**
78 )))
79
80 (((
81
82 )))
83
84 (((
85 **It is also for this reason that “Last 15 minutes - only for real-time data” is explicitly stated that this is only for real-time data!**
86 )))
87
88 [[image:1694470028060-449.png||height="208" width="478"]]
89
90
91
92 == **Alarm Type** ==
93
94
95 You can raise an alarm on:
96
97 * (((
98 The absence of a measuring point for a period of X minutes. A zero value does not mean that a measuring point is absent.
99 )))
100 * (((
101 Exceeding a maximum.
102 )))
103 * (((
104 Falling below a minimum
105 )))
106
107 (((
108 **NOTE: The units must be respected (W or minutes).**
109 )))
110
111
112 == **The alarm window** ==
113
114
115 (((
116 This is the interval within which the evaluation of alarm configurations takes place. Outside this interval, the alarm configuration will enter the “hibernate” status.
117 )))
118
119 (((
120
121 )))
122
123 (((
124 The alarm severity is currently a feature that is not active by default.
125 )))
126
127 {{video url="https://youtu.be/IwAqgCUoV-Y"/}}
128
129
130 This has been updated with extra functionality. You can now choose to keep state or reset state. This means that if a window is set it will resend your alarm every day if it gets triggered again. If you decide to keep the state it means it will not resend the alarm tomorrow if it was triggered yesterday.
131 [[image:1716984443911-429.png]]
132
133 == **Monitored Data Points** ==
134
135
136 this is a status table that shows for a given measuring point:
137
138 * whether a maximum has been set(not active here),
139 * a minimum is set (active here and 0W),
140 * the absence of a measuring point
141 * the observed value
142
143 (((
144 The observed value can also be seen in a graph at the bottom of the page.
145 )))
146
147
148 [[image:1694470086669-261.png]]
149
150
151 == **Evaluations** ==
152
153 (((
154 After an alarm configuration has been assigned to one or more measuring points of a building, you must have the alarm configurations evaluated and actions defined for this building.
155 )))
156
157 (((
158
159 )))
160
161 (((
162 To do this, go to “alarms” in the left menu, go to “Evaluations per type of alarm per building” and choose “ADD”.
163 )))
164
165
166 [[image:1694470104776-249.png]]
167
168
169 (((
170 Measuring points of the type “low threshold” or “offline” or “high threshold” or “custom” are bundled (evaluated together and actions taken together).
171 )))
172
173 [[image:1694470118141-727.png]]
174
175 (((
176 E.g. above, all cases where a threshold value is exceeded at the measuring points of a building are bundled.
177 )))
178
179 (((
180
181 )))
182
183 (((
184 Under “Owned by”, enter either the super admin or the admin level of a building. A super admin then has the option to evaluate multiple buildings.
185 )))
186
187
188 [[image:1694470125741-939.png]]
189
190 (((
191 Once the evaluation has been created, we need to further configure it. Click on the gear.
192 )))
193
194
195 == **Frequency** ==
196
197 (((
198 By frequency, we mean the rate at which an alarm configuration for the group of measuring points is evaluated. For example, if we choose 5 minutes, the alarm configurations of the measuring points that fall under the monitored object (the monitored building) with the previously specified alarm type are evaluated every 5 minutes.
199 )))
200
201
202 [[image:1694470145009-530.png]]
203
204
205 == **Monitored objects** ==
206
207 (((
208 With this, we indicate the role of a building (e.g. Building – Admins) for which we wish to monitor the measuring points of the previously specified alarm type
209 )))
210
211 (((
212 **Please note**: please select one object.
213 )))
214
215
216 [[image:1694470158674-242.png]]
217
218
219 == **Evaluation** ==
220
221 (((
222 This button is not yet completed but is not critical to the operation
223 )))
224
225
226 == **Actions** ==
227
228 (((
229 Here you can link actions to the status of alarm configurations after evaluation. Multiple actions can be set per status. There are two alarm statuses: the alarm is active or the alarm is inactive.
230 )))
231
232
233 [[image:1694470186018-661.png]]
234
235
236 * (((
237 With "status duration" you can set how long the status should be active before the action is executed. E.g. send an email after the evaluation of the alarm configuration 3600s was positive.
238 )))
239 * (((
240 Receivers: by setting a full contact list, a reference is made to the email recipients in the alarm section at the measuring point level. By choosing fixed you can manually specify the email recipients on the same screen.
241 )))
242 * (((
243 "Language" should be set to Default by default.
244 )))
245 * (((
246 Subject and Content: This can be set according to the syntax described in email templates.
247 )))
248
249 [[image:1694470196877-756.png]]
250
251
252
253 == **Email templates** ==
254
255 (((
256 Here you can link actions to the status of alarm configurations after evaluation. Multiple actions can be set per status. There are two alarm statuses: the alarm is active or the alarm is inactive
257 )))
258
259
260 (((
261 Below you will find some email templates.
262 )))
263
264 === Subject ===
265
266 (((
267 Please enter a text that specifies which site and type of alarm it concerns, e.g.: "Site Eniris - High Threshold Alarm"
268 )))
269
270 (((
271
272 )))
273
274 (((
275 Indiction which measuring point is involved is only possible if the site only contains one measuring point to be monitored
276 )))
277
278
279 === Body Templates ===
280
281 **Site X - High Treshold Alarm**
282
283
284 **Site X - High Treshold Alarm**
285
286 {{code language="none"}}
287 <p>Hallo,</p>
288 <p>Er is een nieuw alarm opgetreden!</p>
289
290 <p><br /><strong>Wanneer?</strong> </p>
291 <p>Storing opgetreden op: {{#formatInTimeZone}}{{date}},Europe/Brussels,yyyy-MM-dd HH:mm{{/formatInTimeZone}}</p>
292 <p><strong>Wat?</strong></p>
293 <ul>
294 <ul>{{#points}} Object: {{site}} - {{name}} met als waarde: {{value}} overschrijdt de maximale waarde: {{maxValue}}</ul>
295 </ul>
296 <p>&nbsp;</p>
297 <ul>{{/points}}</ul>
298 <p>Zolang het alarm actief is, wordt een herinnering verstuurd om de 2.0 uur. <br />Om dit interval aan te passen, of de overwaking uit te zetten, dient u naar de alarminstellingen te navigeren.</p>
299 <p>Kind regards</p>
300
301 {{/code}}
302
303 **Site X - Herstel High Treshold Alarm**
304
305
306 {{code language="none"}}
307 <p>Hallo,</p>
308 <p>Er is een alarm hersteld!</p>
309
310 <p><br /><strong>Wanneer?</strong> </p>
311 <p>Herstel opgetreden op: {{#formatInTimeZone}}{{date}},Europe/Brussels,yyyy-MM-dd HH:mm{{/formatInTimeZone}}</p>
312 <p><strong>Wat?</strong></p>
313 <ul>
314 <ul>{{#points}} Object: {{site}} - {{name}} met als waarde: {{value}} en maximale waarde: {{maxValue}}</ul>
315 </ul>
316 <p>&nbsp;</p>
317 <ul>{{/points}}</ul>
318 <p>Zolang het alarm actief is, wordt een herinnering verstuurd om de 2.0 uur. <br />Om dit interval aan te passen, of de overwaking uit te zetten, dient u naar de alarminstellingen te navigeren.</p>
319 <p>Kind regards</p>
320 {{/code}}
321
322 **Site X - Low Treshold Alarm**
323
324 {{code language="none"}}
325 <p>Hallo,</p>
326 <p>Er is een nieuw alarm opgetreden!</p>
327
328 <p><br /><strong>Wanneer?</strong> </p>
329 <p>Storing opgetreden op: {{#formatInTimeZone}}{{date}},Europe/Brussels,yyyy-MM-dd HH:mm{{/formatInTimeZone}}</p>
330 <p><strong>Wat?</strong></p>
331 <ul>
332 <ul>{{#points}} Object: {{site}} - {{name}} met als waarde: {{value}} zit onder de minimale waarde: {{minValue}}</ul>
333 </ul>
334 <p>&nbsp;</p>
335 <ul>{{/points}}</ul>
336 <p>Zolang het alarm actief is, wordt een herinnering verstuurd om de 2.0 uur. <br />Om dit interval aan te passen, of de overwaking uit te zetten, dient u naar de alarminstellingen te navigeren.</p>
337 <p>Kind regards</p>
338 {{/code}}
339
340 **Site X - Herstel Low Treshold Alarm**
341
342 {{code language="none"}}
343 <p>Hallo,</p>
344 <p>Er is een alarm hersteld!</p>
345
346 <p><br /><strong>Wanneer?</strong> </p>
347 <p>Herstel opgetreden op: {{#formatInTimeZone}}{{date}},Europe/Brussels,yyyy-MM-dd HH:mm{{/formatInTimeZone}}</p>
348 <p><strong>Wat?</strong></p>
349 <ul>
350 <ul>{{#points}} Object: {{site}} - {{name}} met als waarde: {{value}} en minimale waarde: {{minValue}}</ul>
351 </ul>
352 <p>&nbsp;</p>
353 <ul>{{/points}}</ul>
354 <p>Zolang het alarm actief is, wordt een herinnering verstuurd om de 2.0 uur. <br />Om dit interval aan te passen, of de overwaking uit te zetten, dient u naar de alarminstellingen te navigeren.</p>
355 <p>Kind regards</p>
356 {{/code}}
357
358 **Site X - Meetpunt offline**
359
360 {{code language="none"}}
361 <p>Hallo,</p>
362 <p>Er is een nieuw alarm opgetreden!</p>
363
364 <p><br /><strong>Wanneer?</strong> </p>
365 <p>Storing opgetreden op: {{#formatInTimeZone}}{{date}},Europe/Brussels,yyyy-MM-dd HH:mm{{/formatInTimeZone}}</p>
366 <p><strong>Wat?</strong></p>
367 <ul>
368 <ul>{{#points}} Object: {{site}} - {{name}} geen data voor meetpunt binnen interval. Laatste datapunt: {{lastDatapoint}}</ul>
369 </ul>
370 <p>&nbsp;</p>
371 <ul>{{/points}}</ul>
372 <p>Zolang het alarm actief is, wordt een herinnering verstuurd om de 2.0 uur. <br />Om dit interval aan te passen, of de overwaking uit te zetten, dient u naar de alarminstellingen te navigeren.</p>
373 <p>Kind regards</p>
374 {{/code}}
375
376 **Site X - Herstel van connectie**
377
378 {{code language="none"}}
379 <p>Hallo,</p>
380 <p>Er is een connectie hersteld!</p>
381
382 <p><br /><strong>Wanneer?</strong> </p>
383 <p>Herstel opgetreden op: {{#formatInTimeZone}}{{date}},Europe/Brussels,yyyy-MM-dd HH:mm{{/formatInTimeZone}}</p>
384 <p><strong>Wat?</strong></p>
385 <ul>
386 <ul>{{#points}} Object: {{site}} - {{name}}. Laatste datapunt: {{lastDatapoint}}</ul>
387 </ul>
388 <p>&nbsp;</p>
389 <ul>{{/points}}</ul>
390 <p>Zolang het alarm actief is, wordt een herinnering verstuurd om de 2.0 uur. <br />Om dit interval aan te passen, of de overwaking uit te zetten, dient u naar de alarminstellingen te navigeren.</p>
391 <p>Kind regards</p>
392 {{/code}}
393
394
395 == **Delete an assessment** ==
396
397
398 (((
399 Click on “viewer management” and click “delete”. This will delete the evaluation
400 )))
401
402
403 [[image:1694470248546-703.png]]
404
405
406
407 == **Edit & view rights** ==
408
409 (((
410 Under the item "viewer management" you can arrange the rights of admins, installers or users.
411 )))
412
413 (((
414
415 )))
416
417 1) Add the user type (e.g. demo building 1 - Admin)
418
419
420 2) Give the correct rights to the user: e.g. edit rights and viewer rights
421
422
423 [[image:alarm management.gif]]
424
425
426 == **View alarm evaluations** ==
427
428 (((
429 Click on “Alarms” in the left menu and go to “Evaluations per type of alarm per building”, then click on the evaluation and click on “VIEW”.
430 )))
431
432
433
434 [[image:1694470271793-869.png]]
435
436
437 (((
438 A table is then shown with the measuring points and the evaluations "last data point" or "min value", "max value", and "alarm window". “value” indicates whether the configuration is evaluated negatively or positively at the time of viewing (so this is not the result of the evaluation of the service to which emails are linked).
439 )))
440
441 “email receivers” is not relevant.
442
443
444 [[image:1694470284033-611.png]]
445
446
447
448
449

Applications

(c) Eniris, 2024