Skip to content

Commit 4921978

Browse files
committed
Adding documentation on the alarm config editor
1 parent bac3f06 commit 4921978

File tree

4 files changed

+25
-0
lines changed

4 files changed

+25
-0
lines changed
64.7 KB
Loading
29.5 KB
Loading
44.2 KB
Loading

app/alarm/ui/doc/index.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -247,6 +247,7 @@ parent components of the alarm hierarchy.
247247
A slightly longer text with the content of the guidance, for example a list of
248248
telephone numbers, or description of things to try for handling the alarm.
249249

250+
250251
Displays
251252
--------
252253

@@ -409,5 +410,29 @@ Where the include component is identified in the inclusion file with a DID decla
409410
</component>
410411
</config>
411412
413+
Configuration Editor
414+
-------------------
415+
416+
In the Alarm Tree and the Alarm Table views user may right click on an alarm item to launch the configuration
417+
editor dialog:
418+
419+
.. image:: images/context_menu.png
420+
:width: 20%
421+
422+
In this view user may update all settings defined in the alarm configuration XML file:
423+
424+
.. image:: images/configuration_editor.png
425+
:width: 50%
426+
427+
**NOTE 1:** Any changes performed in the editor will be overwritten when the associated alarm configuration XML file is
428+
imported again.
429+
430+
**NOTE 2:** An alarm configured as enabled cannot be disabled using the checkbox in the editor dialog. Instead, user needs to
431+
specify a date/time when the alarm item is put back automatically into enabled state. At the specified date/time the alarm will be enabled,
432+
even if configured to be *disabled* by default in the alarm configuration XML file. Further, an alarm configured
433+
to be *enabled* by default in the alarm configuration XML file will be enabled when the file is imported, even if
434+
the alarm has been disabled in the editor by setting a date/time in the future.
412435

436+
.. image:: images/disable_alarm.png
437+
:width: 50%
413438

0 commit comments

Comments
 (0)