Common Alarm Page Template Functionality
- Last UpdatedJul 18, 2023
- 4 minute read
The alarm page templates offered as part of the tab style page templates include common graphical user interface (GUI) features for easy operation and consistent appearance.
These include:
Task Panels
The alarm page templates share panels to the left of the alarms list that support the following functionality:
-
Page Tasks
Allows the user to navigate through the list of alarms a page at a time. The Print / Export hyperlink (not available in the hardware alarm page) allows the user to send the alarms on the list to a printer or a file. The output will be presented in a HTML table, and reflects the columns, filter and sort settings that are currently used on the display. There are options to output available alarms (starting from page 1) or specific pages of alarms starting from the current page of the alarm list. The blue box indicates the current page number of the alarm list.
-
Filter Tasks
Allows the user to filter the current list based on date time, alarm name, plant area, alarm category and other criteria. The Reset filter hyperlink clears the effect of the filter criteria specified through the filter form. The blue box indicates the current filter setting. It may display one of the following states:
-
No Filter - no filter is applied
-
Filter Applied - filter criteria specified in the filter form is applied
-
Custom Filter - filter criteria is applied via Cicode function AlarmSetInfo by the user.
-
-
Control Tasks
Offers the option to:
-
Acknowledge alarms on the current page (only available on Active Alarms and Hardware Alarms page)
-
Disable alarms on the current page (only available on Active Alarms page)
-
Enable alarms on the current page (only available on Disabled Alarms page)
-
Silence alarm sound (not available on Hardware Alarms page)
This panel is not featured on the Alarm Summary page.
-
-
View Tasks
Offers the option to:
-
Add new column to the alarm list.
-
Automatically fit the width of columns to show the most content.
-
Reload the column settings according to the alarm format set in parameter [Format]FormatName.
-
Save the current column settings to parameter [Format]FormatName, so that the same settings are used when this page is displayed in the future.
This panel is not featured on the Hardware Alarm page.
-
Interactive Alarm List
The alarm and alarm equipment tree view page templates (except the Hardware Alarms template) feature an interactive alarm list that supports the following functionality:
-
Adjustable Columns
The user can adjust the columns displayed on the alarm list. Options include:
-
Reposition a column by drag-and-drop its column heading to the new position.
-
Delete a column by drag-and-drop its column heading (vertically) beyond the column heading row.
-
Insert or delete a column via a pop-up menu by right-clicking a column heading
-
Adjust the size of a column by dragging the column separator that appears at the right edge of a column heading.
-
-
Selection of Alarms
The user can select single or range of alarms on the alarm list so that the same operation can be applied to multiple selected alarms in one go. Alarm selection works as follows:
-
To select a single alarm: Left-click an alarm that is not already selected to select it.
-
To select a range of alarms: Select a single alarm to mark the start of the selection. Then hold the SHIFT key and left-click another alarm to extend the selection. You can adjust the range of the selection by SHIFT left-clicking another row of alarm.
-
To deselect alarm(s): Left-click any alarm within a selection range to deselect the whole range.
-
-
Context Menu
Right-click on any alarm row to bring up the context menu for alarm operations. Options available in the context menu will vary depending on whether single or multiple items are selected. If you right-click on an alarm that is not already selected, this will select it. Subsequent commands (selected from the context menu) will then only operate on this single alarm. On the other hand, if you right-click on any alarm within a selection range, this will not change the selection. Subsequent commands selected will operate on each alarm within the selection range. Several operation options are available in the context menu:
-
Information: displays the detailed information of a single alarm that has the cursor focus (indicated by surrounded by a white box).
-
Help: displays the Help page of a single alarm that has the cursor focus.
-
Acknowledge: acknowledges selected alarms. This option is restricted by the privilege set by the parameter [Privilege]AckAlarms. This is not available on the Alarm Summary page.
-
Disable: disables selected alarms. This option is restricted by the privilege set by the parameter [Privilege]DisableAlarms. It is not available on the Disabled Alarms page.
-
Enable: enables selected alarms. This option is restricted by the privilege set by the parameter [Privilege]DisableAlarms It is not available on the Active Alarms page.
-
Comment: Add a comment to an event. This option is only available when a single row is selected. This option is restricted by the privilege set by the parameter [Privilege]AckAlarms. This option is available to Alarm Summary and SOE pages only.
Note: The Hardware Alarms template only allows a single alarm to be selected. Its context menu has only the Acknowledge option which is also restricted by the privilege set by parameter [Privilege]AckAlarms.
-