diff --git a/app/alarm/ui/doc/images/configuration_editor.png b/app/alarm/ui/doc/images/configuration_editor.png new file mode 100644 index 0000000000..e78308aa00 Binary files /dev/null and b/app/alarm/ui/doc/images/configuration_editor.png differ diff --git a/app/alarm/ui/doc/images/context_menu.png b/app/alarm/ui/doc/images/context_menu.png new file mode 100644 index 0000000000..33505307f7 Binary files /dev/null and b/app/alarm/ui/doc/images/context_menu.png differ diff --git a/app/alarm/ui/doc/images/context_menu_config.png b/app/alarm/ui/doc/images/context_menu_config.png new file mode 100644 index 0000000000..eadb54afab Binary files /dev/null and b/app/alarm/ui/doc/images/context_menu_config.png differ diff --git a/app/alarm/ui/doc/images/disable_alarm.png b/app/alarm/ui/doc/images/disable_alarm.png new file mode 100644 index 0000000000..d7f8b5b28a Binary files /dev/null and b/app/alarm/ui/doc/images/disable_alarm.png differ diff --git a/app/alarm/ui/doc/index.rst b/app/alarm/ui/doc/index.rst index d6cbde5903..5f5f5b7745 100644 --- a/app/alarm/ui/doc/index.rst +++ b/app/alarm/ui/doc/index.rst @@ -247,6 +247,7 @@ parent components of the alarm hierarchy. A slightly longer text with the content of the guidance, for example a list of telephone numbers, or description of things to try for handling the alarm. + Displays -------- @@ -409,5 +410,43 @@ Where the include component is identified in the inclusion file with a DID decla +Context Menu +------------ + +In the Alarm Tree and the Alarm Table views user may right click on an alarm item to launch a context menu: + +.. image:: images/context_menu.png + :width: 20% + +The top item ("Guidance" in the screenshot) will launch a dialog showing the guidance text for the alarm item. + +With the Disable Alarms menu item (Alarm Tree only) user may disable an alarm item, or all alarms in the sub-tree of a +node. The alarm(s) will stay disabled until explicitly enabled by the user. See also notes below for +more information on how disabled alarms are handled upon import of the alarm configuration XML file. + +Configuration Editor +-------------------- + +In the Alarm Tree and the Alarm Table views user may right click on an alarm item to launch the configuration +editor dialog: + +.. image:: images/context_menu_config.png + :width: 20% + +In this view user may update all settings defined in the alarm configuration XML file: + +.. image:: images/configuration_editor.png + :width: 50% + +**NOTE 1:** Any changes performed in the editor will be overwritten when the associated alarm configuration XML file is +imported again. + +**NOTE 2:** An alarm configured as enabled cannot be disabled using the checkbox in the editor dialog. Instead, user needs to +specify a disable-until date/time. At the specified date/time the alarm will be enabled automatically, +even if configured to be *disabled* by default in the alarm configuration XML file. Further, an alarm configured +to be *enabled* by default in the alarm configuration XML file will be enabled when the file is imported, even if +a disable-until date/time in the future has been set. +.. image:: images/disable_alarm.png + :width: 50%