How to Shelve an Alarm
To shelve an alarm, select one alarm or multiple alarms, and a footer will open at the bottom of the table to show the Shelve button. Click the Shelve button and a dropdown will automatically open so you can set a duration to silence the selected alarms. You can set a duration from 5 minutes to 4 hours to shelve selected alarms. Choose the duration and your alarm will immediately be shelved for your selected alarms.
The example below shows two alarms were shelved for one hour.
Viewing Shelved Alarms
To see details for the shelved alarms click Shelved at the top of the Alarm Status Table. The Shelved tab will display the date/time for when the alarm expires. Shelved By and Source Path are also displayed for each alarm event. To return to active alarm, click on Active.
To unshelve alarms, click Shelved at the top of the Alarm Status Table. Select one or multiple alarms, and the footer at the bottom of the table will open with the Unshelved Selected Alarms button. Press the Unshelved Selected Alarms and the alarm will return back to the Alarm Status list.
Mouse over an alarm event and you'll notice a unshelve icon () on the right side of the alarm. You can delete a single alarm event by clicking the Unshelve icon ( ).
After the amount of time expires on a shelved alarm it will be evaluated, and if it is still active, it will automatically return to the Alarm Status list. If the alarm transitions to a cleared state during the time shelved period, the alarm will show up as 'Cleared,Unacknowledged' in the Alarm Status list instead of 'Active, Unacknowledged' as shown in the blue rows in the example below.
Configuring Custom Shelving Duration
The shelving duration values on the Alarm Status Table component can be customized in the Designer. By default, the Alarm Status Table has several preset shelving duration times, but you can add or remove times based on your requirements. One thing to note when modifying the shelving times is that there is no option to set a shelving time indefinitely. Shelving times are meant to temporarily suppress the alarm while you're working on the issue. They are not meant to be long term.
In the Property Editor, there is a property called shelvingTimes. This is where you can add, remove, or change the shelving times for alarms. Shelving time is calculated in seconds.
In the following example, let's add 3 hours to the list of shelving times.
Select the Alarm Status Table component. Under the shelvingTimes property, insert a Value of 10,800 seconds (3 hours).
Replace Step 1 with the following... Select the Alarm Status Table. Under the shelvingTimes property, go to the existing value of 7,200 and right click. Select Structure > Add after > Value (to keep the value in descending order Editor_notes
).Add a new step 3. Enter 10,800 which will show up as 3 hours in the dropdown.
- To verify your new time was entered correctly, go to Preview Mode, select the alarms you want to shelve, and press the Shelve button. A footer will open at the bottom of the table and you should see your new shelve time in the dropdown list (i.e., 3 hours).
Click the shelving time to temporarily silence your alarms.editor_notes