Shelve alarms
- Last UpdatedJul 16, 2024
- 2 minute read
You can shelve alarms to temporarily hide them from displays for a fixed period. Alarms continue to be historized, even when they are shelved.
Shelving typically is used to reduce alarm "noise", or to temporarily suppress alarms that might be triggered during system modifications or repairs, allowing you to focus on correcting other more urgent alarms.
Shelving is similar to silencing an alarm, but shelved alarms differ from silenced alarms in the following ways:
-
Shelved alarms have a built-in associated time-out period. Shelved alarms are automatically unshelved when the configured shelving period expires. You can also manually unshelve alarms and return them to an active, displayed state.
-
Alarm shelving must be enabled at an area level, but shelving applies only to individual alarms. You cannot shelve a hierarchy of alarms for an entire area or for an entire object. You cannot propagate alarm shelving through the Model View hierarchy.
-
The system enforces role-based limitations on permission to shelve alarms, alarm severity levels that can be shelved, and the total number of alarms a user can shelve.
The system tracks who shelved the alarm, from what workstation, the reason for shelving the alarm, when shelving began, and when shelving will expire. Shelved alarms aggregate in similar fashion to silenced alarms. For information about alarm aggregation, see Aggregated alarm information.
A set of seven attributes provide runtime alarm shelving information and control:
|
AlarmShelveCmd |
User writeable. Use this attribute to shelve or unshelve an alarm. Default values: Duration = 0, Reason = "" |
|
AlarmShelved |
Read-only, Boolean value. Shows True if alarm is shelved, False if alarm is unshelved. Default value: False |
|
AlarmShelveStartTime |
A read-only date/time stamp indicating when alarm shelving began, based on the engine time when the shelving request was received, Default value: Blank |
|
AlarmShelveStopTime |
A read-only date/time stamp equal to the AlarmShelveStartTime plus the duration for which the alarm is to be shelved. Default value: Blank |
|
AlarmShelveReason |
A read-only string value providing the reason for which the alarm was shelved or un-shelved by the Alarm Shelve command. Default value: Blank (See AlarmShelveCmd attribute.) |
|
AlarmShelveUser |
Read-only, the name of the user who most recently shelved or un-shelved the alarm with the Alarm Shelve command. Default value: Blank |
|
AlarmShelveNode |
Read-only, the name of the computer node from which the user most recently shelved or un-shelved the alarm with the Alarm Shelve command. If the node is hosted in a Terminal Server client session, the node and the TSE ID are both identified. Default value: Blank |