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
12/18/2018

Creating an Alarm Decoration Rule

You create an alarm decoration rule to override one or several properties of an alarm when the conditions of the alarm decoration rule are met.

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 create 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. In the Alarm Decoration view, click the Add decoration button

     
    action_zoom_plus_stroke
    .

  5. In the Create Object wizard, in the Name box, type a name for the alarm decoration rule.

  6. In the Path box, view the path to the location where the alarm decoration rule is stored.

  7. In the Description box, type a description for the alarm triggered notification.

  8. Click Next .

  9. Click Add condition

     
    action_zoom_plus_stroke
    to add the conditions that have to be met before the alarm decoration rule becomes active.

  10. In the Add/Remove Conditions dialog box, select the conditions.

  11. Click OK .

  12. In the Presentation page, select the Override boxes for the alarm presentation properties you want to override when the alarm decoration rule conditions are met.

  13. Complete the following steps:

    • In the Alarm text message box, type the message to display when the alarm decoration rule conditions are met.

    • In the Category box, type the path to the category the alarm is to belong to when the alarm decoration rule conditions are met.

    • In the Prefix for alarm source name box, type a prefix that is to be added to the alarm source name when the alarm decoration rule conditions are met.

    • In the Priority box, enter the priority of the alarm state when the alarm decoration rule conditions are met.

    • Select the Auto hide box to automatically hide the alarm in the Alarms pane or Alarm Views when the alarm decoration rule conditions are met.

    • Select the Flashing alert box, to make the alarm flash in the Alarms pane and Alarm Views when the alarm is triggered and when the alarm decoration rule conditions are met.

    • Select the Audible alert box, to make the alarm sound when it is triggered and when the alarm decoration rule conditions are met.

    • Select the Disable state-change logging box, to prevent an alarm state change from creating an event when the alarm is triggered and when the alarm decoration rule conditions are met.

    • In the Background color box, 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.

    • In the Font color box, enter the font color to use for triggered alarms in the Alarms pane and Alarm Views when the alarm decoration rule conditions are met.

    • In the Font box, enter the font to use for triggered alarms in the Alarms pane and Alarm Views when the alarm decoration rule conditions are met.

  14. Click Next .

  15. In the User Action page, select the Override boxes for the user action properties you want to override when the alarm decoration rule conditions are met.

  16. In the Cause note group box, enter the path to a cause note group that you want to connect to the alarm when the alarm decoration rule conditions are met.

  17. In the Action note group box, enter the path to an action note group that you want to connect to the alarm when the alarm decoration rule conditions are met.

  18. In the Checklist box, enter the path to a checklist that you want to connect to the alarm when the alarm decoration rule conditions are met.

  19. Select W hen acknowledging an alarm : Comment to force the user to add a comment to the alarm before the alarm can be acknowledged.

  20. Select When acknowledging an alarm : Cause note to force the user to edit the connected cause note before the alarm can be acknowledged.

  21. Select When acknowledging an alarm : Action note to force the user to edit the connected action note before the alarm can be acknowledged

  22. Select When acknowledging an alarm : Checklist to force the user to go through the connected checklist before the alarm can be acknowledged

  23. Select the actions for Comment , Cause note , and Action note ​to specify how the user should respond to the actions when the alarm decoration rule conditions are met.

  24. Click Next .

  25. Click the Add attachment button

     
    action_zoom_plus_stroke
    to add an 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.

  26. In the Select Object dialog box, select the attachment and then click Select .

  27. Click Create .

The properties defined in the alarm decoration rule are applied on the alarm when an alarm that meets the conditions of the alarm decoration rule changes state.

See Also

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