alarm-AlarmConsoleOptions
This component configures the alarm console options. You access these options in Workbench by clicking .
The component is stored under the /users/{user}/options directory.
| Property | Value | Description |
|---|---|---|
| Notes Required On Ack | true (default) or false | Configures the requirement
to add a note when the operator acknowledges an alarm. true opens the Notes window when the operator initiates an alarm acknowledgment from the alarm console. false does not require a note. |
| Sounds Enabled | true or false | true causes a sound to accompany an alarm. You can also set this value under the Alarms menu in the Workbench main menu when the Alarm Console view is active. |
| Default Sound File | file path | Sets the path to the default sound file. |
| Continuous Alarm | true or false | true causes an alarm to repeat continually until it is acknowledged or cleared. This option works together with the Continuous Alarm Delay property. You can also set this value under the Alarms menu in the Workbench main menu when the Alarm Console view is active. |
| Continuous Alarm Delay | hours minutes seconds | true interrupts the sound of the alarm for a time equal to the value of this property. |
| Low Priority Color | color | Defines the color to use for the least important alarms. Alarm priorities are numbered from 1–255. The system assigns colors to alarm priorities that fall between priority levels on a color-scale along a path defined by the three assigned colors. |
| Mid Priority Color | color | Defines the color to use for an alarm of medium importance. Alarm priorities are numbered from 1–255. The system assigns colors to alarm priorities that fall between priority levels on a color-scale along a path defined by the three assigned colors. |
| High Priority Color | color | Defines the color to use for the highest priority (priority 1). Alarm priorities are numbered from 1–255. The system assigns colors to alarm priorities that fall between priority levels on a color-scale along a path defined by the three assigned colors. |
| Time Zone Display | ConsoleSource | Displays the alarm record timestamp in the time zone of the alarm console view (Console) or in the time zone of the alarm source (Source). |
| Alarm Class Mapping | additional options | Opens the Alarm Class Mapper window, which allows you to add alarm classes and map them. |
| Alarm Ack Responses | Creates one or more text entries that you can use to populate the Notes window when acknowledging an alarm. When Notes Required on Ack is set to true, the Notes window displays an additional option list containing any entries you create with this property. To add, edit, or remove response options, use the >> button to open the associated Edit window. When Notes Required on Ack is set to false, these Alarm Ack Responses are not visible. | |
| View Instructions | true or false | true causes the alarm Instructions pane to display across the bottom of the Alarm Console. Instructions display in the pane for any single selected alarm that has associated instructions. |