Alarms list
Alarms interface is a table that lists active or historic alarms. These lists can be configured with filters. Interface allows you to customize a list of displayed columns with Presets. You can comment alarms.
Displayed table with applied filters and presets can be exported.
Alarms list can be opened with the button on the views panel.
Active alarms
Active alarms window shows a list of all current problems:
You can open any of the parent objects of the entity with an alarm by clicking on their names in the Path column. If the multi-parent mode is active on any level of the hierarchy, the object name of this level is highlighted in bold. Clicking on such object will display a list of all parent objects with links to them is opened:
| Objects' links follow to the objects' simplified default view. |
The Acknowledgement mark allows you to separate viewed alarms from the new ones. To acknowledge the alarm, select the corresponding item in the context menu of the alarm. The name of the user, date and time of the confirmation will be added automatically. You can also add comments to alarm in the similar way.
Clearing active alarms
Alarms can be cleared and moved to the list of historical alarms:
-
automatically by the clear conditions,
-
manually with selecting Clear or Clear and remove options from the context menu.
In the Status column, the table displays whether the alarm was cleared or removed. If the alarm is cleared, this column will display the CLEARED message. Alarms that are to be removed are marked with the symbol in the Status column.
Alarm is not deleted immediately. First, alarm is marked as deleted. When the server moves it to the alarm history, it is deleted permanently permanently without the ability to restore it instead.
| Clearing and removing an alarm are two separate actions. To fully cancel the Clear and remove action, perform two actions in the context menu – Undo clear and Undo remove. |
When an incident is CLEARED, it is moved from Active alarms to Alarm history in two minutes by default. If necessary, this timeout can be changed with the incident_timeout parameter in the section Server of the server configuration file. Its value is equal to the timeout in milliseconds:
...
"server" : {
...
"incident_timeout": 3600000,
...
},
...Alarm history
Alarm history contains alarms that were cleared and moved by system to the history list after a period of time specified in configuration (by default – 2 minutes).
Records from the history can be removed without the possibility to restore them. To do this, use the Remove item in the alarm context menu.
You can sort alarm history list by any column, except Path.
You can open any of the parent objects of the entity with an alarm via the Path column. If the multi-parent mode is active on any level of the hierarchy, the object name of this level is highlighted in bold. When you click on such an object the list of all parent objects with links to them is opened:
| Links to objects open their information in the simplified display mode. |
You can also view the comments list, but you can’t add new comments.
Columns
Alarm list contains the following columns:
| Column | Description |
|---|---|
Registered time |
Timestamp of when an alarm was registered on the server. |
Occurred time |
Timestamp of when an alarm occurred on the device. |
Cleared time |
Timestamp of when an alarm was cleared. Empty if alarm wasn’t cleared yet. |
Object/link |
Entity that generated an alarm. |
Path |
Path from the root object to entity that generated an alarm. |
Status |
Current status of the alarm. Displays whether this alarm has been CLEARED |
Severity |
Alarm severity. |
Text |
Alarm’s description or message from the device. |
Acknowledged by |
Information about acknowledgement of this alar. Contains the name of the user who acknowledged the alarm and the timestamp of the acknowledgement. |
Comment |
Alarm’s last comment. |
You can configure display of the columns by right-clicking the table header and selecting the columns you need from a drop down.
You can save the current column layout as a preset.
Filters
Filter allows to display the list of alarms, according to the selected criteria. Conditions of the created filter can be combined using operators AND and OR.
| When selecting alarms by parent, the list will display alarms of all nested objects and links of the specified object from all nesting levels. |
The following criteria are related to their values with comparison operators:
-
property;
-
text;
-
field comparison;
-
comment.
Mathematical comparison operators are used for numeric values; textual operators are used for numeric and text values, case-insensitive.
The operators = and ≠ can also be used with text values, case-sensitive.
You can also use regular expressions with textual comparison operators such as matches.
The following parameter have the time range as the criteria:
-
registered time;
-
occurred time;
-
transition time;
-
cleared time.
The filter can be saved for future use after entering all the necessary criteria and the filter name by clicking the button near the filter name.
Presets
Preset is the individual filling of the columns in the alarm window. Right-clicking on the title of any section opens the pop-up window with the list in which the displayed columns are ticked. To add or delete a column, click on the corresponding name in the pop-up window. You can change the order of the columns by dragging the columns.
After making all necessary changes, enter preset name and click the button.
The button allows to view all of the previously created presets.
Property Fields
The Property Fields dropdown list contains all available properties of all existing system objects. The values of the ticked properties are displayed in the incidents table in the corresponding columns, if objects with incidents have these values.
If necessary, it is possible to add fields from incident properties, values of which will be displayed on the active and historical alarms lists. For this, the required incident properties must be specified in the Incidents section of the client configuration file.
| Incident properties can be added/modified or deleted with REST API. |
Export
You can export lists of active and historic alarms to a local file using a button in the top right corner of the screen. For a list of active alarms the export button – – exports the list in the XLSX format. For a list of all historic alarms the export button – – exports the list as a CSV format.
| Alarm list is exported with currently applied filters. |
You can find detailed instruction on the Export active alarms and Export historic alarms pages.
Alarm comments
Users can comment active alarms.
To leave a comment, right click an active alarm and select "Comment" in the context menu.
This opens a list of comments:
|
Comments support Markdown. You can see the syntax of the used flavor in the Showdown documentation. You can see how the comment will look in the "Preview" tab. |
The last comment is shown in the alarm row:
