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 Alarm Decoration Rule

You configure an alarm decoration rule to change the properties that are overridden.

Show More
action_close

If you want to override an alarm configuration for a specific alarm or group of alarms you can use an alarm decoration rule.

An alarm decoration rule is similar to a filter. In the alarm decoration rule, you configure the conditons that have to be met before the alarm decoration rule is executed on an alarm. When configuring the alarm decoration rule, you configure the alarm properties you want the alarm decoration rule to override when an alarm that meets the conditons is triggered.

You can configure the following alarm and alarm styling properties in an alarm decoration rule:

  • Alarm text message

  • Category

  • Prefix for an alarm source name

  • Alarm priority

  • Auto hide

  • Flashing alert

  • Audible alert

  • Disable state-change logging

  • Background color

  • Font color

  • Font

  • Cause note group

  • Action note group

  • Checklist

  • Required user actions

  • Alarm attachment (the new attachment is added to the original attachment)

Important:

If you are logged on to a SmartX server, an attachment used in the the alarm decoration rule has to be stored on that SmartX server.

For example, if you configure the font, font color, and background color in an alarm decoration rule, then an alarm record that matches the alarm decoration rule criteria gets the specified colors in the Alarms pane or an Alarm View.

In the Alarm Decoration view, a preview of the selected conditions is displayed.

You can configure more than one alarm decoration rule and an alarm can meet the conditions of more than one rule. You configure the order in which the alarm decoration rules are executed by moving them up or down in a list. When an alarm that matches the conditions is triggered, the alarm decoration rules are executed from the lowest to the highest number in the list.

When an alarm changes state, the properties configured in the alarm decoration rule are still active. The original configuration can change the alarm message and the priority. If an alarm meets the conditions of a different alarm decoration rule due to a state change, the properties change according to the configuration in this alarm decoration rule. If you have not configured any font or color properties in the alarm decoration rule, the font and color properties defined in the alarm styles are applied. For more information, see Alarm Styles View .

In a multi-server system, you create the alarm decoration rule on the Enterprise Server. The alarm decoration rule is propagated to all the SmartX servers in the EcoStruxure BMS. If you want to create an alarm decoration rule in the Enterprise Central and propagate it to the Enterprise Server and SmartX servers, you must first choose to synchronize the Alarm Control Panel in each Enterprise Server to parent server. For more information, see Synchronizing Alarm Control Panels .

To configure an alarm decoration rule

  1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS server you want to configure.

  2. Click the Control Panel tab.

  3. Under Alarm , click Decoration .

  4. Click Alarm Decoration .

  5. In the list, select the alarm decoration rule you want to configure and then click the Edit decoration

     
    action_zoom_plus_stroke
    button.

  6. Click the Basic Settings tab.

  7. Configure the basic settings:

    Table: Basic Settings Page or Tab

    Property

    Description

    Type

    Displays the object type.

    Name

    Displays the name of the alarm decoration rule.

    Description

    Type to change the description of the alarm decoration rule.

  8. Click the Filter tab.

  9. Configure the filter settings:

    Table: Filter Page or Tab

    Property

    Description

     
    action_zoom_plus_stroke

    Add condition

    Click to add the conditions that have to be met before the alarm decoration rule becomes active and overrides the original configuration of the alarm. For more information, see Add/Remove Conditions Dialog Box .

     
    action_zoom_plus_stroke

    Remove condition

    Click to remove the selected condition.

     
    action_zoom_plus_stroke

    Add row

    Click to add another condition that has to be met before the alarm decoration rule becomes active.

     
    action_zoom_plus_stroke

    Remove row

    Click to remove the selected alarm decoration rule condition.

    Clear all

    Click to clear the selected conditions.

  10. Click the Presentation tab.

  11. Configure the presentation properties:

    Table: Presentation Page or Tab

    Property

    Description

    Override

    Select the boxes for the alarm presentation properties you want to override when the alarm decoration rule conditions are met.

    Alarm text message

    Type the message to display when the alarm is in Alarm state and the alarm decoration rule conditions are met.

    For more information, see Alarm Messages .

    Category

    Enter the category that the alarm belongs to when the alarm decoration conditions are met.

    For more information, see Categories .

    Prefix for alarm source name

    Type a prefix that is added to the beginning of the source name property of an alarm record.

    Priority

    Enter the priority level of the alarm.

    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.

    Disable state-change logging

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

    Background color

    Enter the background color of the row for triggered alarms in the Alarms pane and Alarm Views when the alarm decoration rule conditions are met.

    For more information, see Alarm Styles View .

    Font color

    Enter the font color to use for triggered alarms in the Alarms pane and Alarm Views when the alarm decoration rule conditions are met.

    For more information, see Alarm Styles View .

    Font

    Enter the font to use for triggered alarms in the Alarms pane and Alarm Views when the alarm decoration rule conditions are met.

    For more information, see Alarm Styles View .

  12. Click the User Action tab.

  13. Configure the user action properties.:

    Table: User Action Page or Tab

    Property

    Description

    Override

    Select the boxes for the user action properties you want to override when the alarm decoration rule conditions are met.

    Cause note group

    Enter the cause note group that is used by the alarm when the alarm decoration rule conditions are met.

    For more information, see User Actions .

    Action note group

    Enter the action note group that is used by the alarm when the alarm decoration rule conditions are met.

    For more information, see User Actions .

    Checklist

    Enter the checklist that belongs to the alarm when the alarm decoration rule conditions are met.

    For more information, see User Actions .

    Required User Actions

    Select what actions the user has to perform when any of the listed events occur and when the alarm decoration rule conditions are met.

    For more information, see User Actions .

  14. Click the Attachment tab.

  15. Configure the attachment properties:

    Table: Attachment Page or Tab

    Property

    Description

     
    action_zoom_plus_stroke

    Add attachment

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

     
    action_zoom_plus_stroke

    Remove attachment

    Click to remove the selected attachment from the alarm decoration rule.

     
    action_zoom_plus_stroke

    Navigate to 

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

    Type

    View the object type of the attachment.

    Name

    View the name of the attachment.

    Display on alarm

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

    Path

    View the path of the attachment.

See Also

  • Alarm Decoration
  • Alarm Filters
  • Add/Remove Conditions Dialog Box
  • Alarm Messages
  • Categories
  • Alarm Priority
  • Alarm Styles View
  • User Actions
  • Alarm Attachments
  • Creating an Alarm Decoration Rule