Status and Actions Panel
Alarm status and actions panel (“the SAP”) is a subinterface that shows current alarms along with some of their metadata. Current alarms include:
- alarms that are currently active,
- alarms that are currently inactive but have not been acknowledged since their last activation,
- alarms that have been shelved, regardless of their activation status
see State for details.
The SAP also provides tools that can be used to address the alarms.
SAP Elements
The SAP is a tabular interface that has the following columns:
Time
Datetime of the last recorded activation of the alarm.
Name
For user-definedCreated or imported by a user. alarms, shows the name of the alarm as configured in the metadata. System-generated alarms are auto-assigned a name, see Special Categories.
If an HMI link was added in the metadata, it will appear beside the name as
Subcount badge (13), if present, shows how many times this particular alarm has been triggered without acknowledgment, including cases where it has been self-resolved (deactivated).
Message
For user-defined Created or imported by a user. alarms, shows the message as configured in the metadata. System-generated alarms come with a preset message that indicates the type of the alarm, see Special Categories.
State
Color-coded state of the alarm as determined by a combination of three boolean values:
- Does the alarm test positive for its condition(s)?
- Has the alarm been acknowledged since its last activation?
- Has the alarm been shelved?
Five alarm states are distinguished:
-
Condition test negative; acknowledged since last activationState transition due to positive condition test or never activated. -
Condition test positive; not acknowledged since the last activation; not shelved. -
Condition test positive; acknowledged since the last activation; not shelved. -
Condition test negative; not acknowledged since the last activation; not shelved. -
Shelved; condition test and acknowledgement status do not apply.
Each alarm state is color-coded as shown above; the color codes apply across all alarm-related interfaces and throughout this documentation.
The HMI version has a color code guide for convenience, which can be found in the footer:
Note the omission of : alarms in this state are not shown on the SAP.
Priority
For user-definedCreated or imported by a user. alarms, shows the static priority value set in the metadata. For system-generated alarms, the priority is always High
.
Category
For user-definedCreated or imported by a user. alarms, shows the category selected in the metadata. System-generated alarms are always in the Systems category.
Actions
Available responses to the alarm. Appropriate user permissions are required, see Category Permissions.
Confirm that the alarm has been seen. May require a comment depending on user's permission level. Cannot be reverted. Acknowledged alarms will remain on the list as long as they are active.
Hide the alarm; it will remain visible under but will no longer count towards the number of active alarms as displayed in the HMI or on the Portal. Unshelving reverts such removal.-
Read and/or post comments on the alarm. Count badge indicates the total number of comments. Authors can edit and/or delete their comments. Datetime next to the author's name refers to the last edit; comments are sorted by from the newest to the oldest.Fig. 1. Comment popup as seen in the HMI.
SAP Versions
The SAP has two versions: one can be found on the Portal and another one in the HMI. While the interface and its composition is nearly identical in the two versions, there are minor differences:
Scope of Data
The Portal version consolidates alarms from all or selected projects where the user has the required access level, while the HMI version is restricted to alarms from its single project. Accordingly, the Portal version indicates the projects currently selected for display.
Sort and Filter
On the Portal,
- Timespan can be used to apply temporal filtering. does not have a filter;
- , , , have optional string filters.
- and have dropdown menus where one or more items can be selected to filter out alarms that do not match the selection.
When filtering by State, Was activated
corresponds to Inactive, unacknowledged
. Filters do not apply to
Additionally, clicking on any column header except
will sort the alarms by value in that column and toggle between ascending and descending. ↑ and ↓ in the column header label the sorting column and indicate the order.By default, alarms are sorted by Time from the newest to the oldest, and no sorting indicator is displayed.
In the HMI, tabs above the SAP provide state-specific alarm counts; switch between tabs to filter alarms by state. Note that alarms that have been acknowledged and are not active anymore will disappear from the list, hence no such filter or state. The HMI only allows selecting either all states or one state; no other parameter can be used for filtering.
Default temporal sorting in descending order applies; no other sorting options are available.
Batch Actions
The HMI version features checkboxes can be used to select and acknowledge, shelve, or unshelve multiple alarms at a time with one of the buttons above; checkbox in the header selects/deselects all current alarms.
Any such batch action should be applicable to all alarms in the selection. For example, shelving multiple alarms is not possible if at least one alarm in the selection is already shelved. Inapplicable actions are greyed out.
The Portal version does not support batch actions.