earth_america
user_standard Log on
action_search_stroke
earth_america
Log on to rate and give feedback 1 2 3 4 5 Log on to rate
0
How to

How to


Products: Automation Server, AS-B, Enterprise Central, Enterprise Server, AS-P, Virtual Project Servers
Functionalities: Alarms
Product version: 2.0, 2.1, 3.0, 3.1
5/7/2021

Configuring an Enumeration Alarm

You configure the properties of an enumeration alarm to meet the unique needs of your site.

Show More
action_close

​An enumeration is a variable with labeled values; different variables have different enumerations. When configuring an enumeration alarm, you configure the variable and its enumerations to monitor.

For example, you create an enumeration alarm that monitors the reliability variable of an I/O point. The alarm is configured to trigger when the reliability variable has an enumeration that indicates the value generated by the I/O point is unreliable.

Enumeration alarms can be configured using shunt variable and time delay. For more information, see Alarm Functions .

To configure an enumeration alarm

  1. In WorkStation, in the System Tree pane, select the enumeration alarm you want to configure.

  2. On the File menu, click Properties .

  3. Edit the basic settings:

    Table: Basic Settings Page or Tab

    Property

    Description

    Type

    Displays the alarm type of the alarm.

    Name

    Displays the name of the alarm.

    Description

    Type to change the description of the alarm.

  4. Edit the alarm trigger properties:

    Table: Alarm Trigger Page or Tab

    Property

    Description

    Trigger alarm when variable is

    Select the enumeration values that trigger the alarm.

    Montiored variable

    Enter the variable together with the enumeration to monitor.

    Disable alarm

    Select to disable the alarm, for example, before deployment.

    Alarm state

    ​Displays the present state of the alarm. For more information, see Alarm States .

    Disabled cause

    Select to disable the alarm, for example, before deployment.

    Alarm delay (s)

    ​Enter the time, in seconds, the alarm has to be within the reset criteria before the alarm state is changed from alarm to reset.

    Reset delay (s)

    ​Enter the time, in seconds, the alarm has to be within the alarm criteria before the alarm is triggered.

    Shunt variable 1

    ​Enter the shunt variable that is used to enable or disable the alarm. For more information, see Shunt Variables .

    Invert

    Select to invert the shunt value, that is, enable the alarm when the shunt value is active and disable the alarm when the shunt value is inactive. For more information, see Shunt Variables .

    Operator

    Select AND or OR to add logic between the first and the second shunt variable. For more information, see Shunt Variables .

    Shunt variable 2

    ​Enter the second shunt variable that is used to enable or disable the alarm. For more information, see Shunt Variables .

    Invert

    Select to invert the shunt value, that is, enable the alarm when the shunt value is active and disable the alarm when the shunt value is inactive. For more information, see Shunt Variables .

  5. Edit the presentation properties:

    Table: Presentation Page or Tab

    Property

    Description

    Alarm message

    Type the message to display when the alarm in in Alarm state.

    For more information, see Alarm Messages .

    Reset message

    Type the message to display when the alarm is reset.

    Category

    Enter the category the alarm belongs to.

    For more information, see Alarm Categories .

    Category 2

    Enter the second category the alarm belongs to.

    For more information, see Alarm Categories .

    Prefix for alarm source name

    Add a substitution code or type a prefix that is added to the beginning of the source name property of an alarm record.

    For more information, see Alarm Substitution Codes .

    Alarm priority

    Enter the priority level of the alarm.

    For more information, see Alarm Priority .

    Reset priority

    Enter the priority level of the alarm when it is reset.

    For more information, see Alarm Priority .

    Same priority

    Select to set all priorities to the same value.

    For more information, see Alarm Priority .

    Auto hide

    Select to automatically hide the alarm in the Alarms pane or Alarm View.

    Flashing alert

    Select to make the alarm row flash in the Alarms pane and Alarm Views when the alarm is triggered.

    Audible alert

    Select to make the alert audible when the alarm is triggered.

    For more information, see Custom Audible Alarm Alerts .

    Custom audio

    Enter the path to the custom audio file you want to play when the alarm is triggered.

    For more information, see Custom Audible Alarm Alerts .

    Disable state-change logging

    Select to prevent an alarm state change from creating an event.

    For more information, see Alarm State-Change Logging .

  6. Edit the user action properties:

    Table: User Action Page or Tab

    Property

    Description

    Acknowledgement type

    ​Select the type of acknowledgement for the alarm.

    Cause note group

    ​Enter the cause note group that is used by the alarm.

    Action note group

    ​Enter the action note group that is used by the alarm.

    Checklist

    ​Enter the checklist that belongs to the alarm.

    Required User Actions

    ​Select what actions the user has to perform when any of the listed events occur.

  7. Edit the attachment properties:

    Table: Attachment Page or Tab

    Property

    Description

     
    action_zoom_plus_stroke

    Add attachment 

    Click to add an attachment to the alarm. For more information, see Alarm Attachments .

     
    action_zoom_plus_stroke

    Remove attachment  

    Click to remove an attachment.

     
    action_zoom_plus_stroke

    Navigate to 

    Click to open the attachment that is selected in the attachment list.

    Display on alarm

    Select to display the attachment when the alarm is going from Normal to Alarm state. 

  8. Click OK .

See Also

  • Enumeration Alarms
  • Alarm Functions
  • Alarm States
  • Shunt Variables
  • Alarm Messages
  • Alarm Categories
  • Alarm Substitution Codes
  • Alarm Priority
  • Custom Audible Alarm Alerts
  • Alarm State-Change Logging
  • User Actions
  • Alarm Attachments