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: AS-B, Enterprise Central, Enterprise Server, AS-P, Project Configuration Tool
Functionalities: Alarms
Product version: 3.2, 3.3, 2022
10/15/2020

Creating a Matching Text String Alarm

You create a matching text string alarm to trigger an alarm when a variable is equal to one or more text strings.

To create a matching text string alarm
  1. In WorkStation, in the System Tree pane, select the folder or EcoStruxure BMS server where you want to create the alarm.

  2. On the File menu, point to New and then click Alarm .

  3. In the Create Object wizard, in the object type list, select Matching Text String Alarm .

  4. In the Name box, type a name for the alarm.

  5. In the Description box, type a description for the alarm.

  6. Click Next .

  7. In the Alarm Trigger page, under Trigger alarm when variable is , in the equals to box, type the text string that has to match with the monitored variable text output to trigger the alarm.

    Note:
    • The text string is case sensitive and must be written exactly as the monitored variable text output.

    • Wildcards cannot be used in the text string.

  8. Click the Add row button

     
    action_zoom_plus_stroke
    to add another text string.

  9. In the Monitored variable box, enter the variable that the alarm monitors.

  10. In the Disable alarm box, select to create the alarm in disabled mode.

  11. In the Alarm delay box, enter the time delay before the alarm is triggered.

  12. In the Reset delay box, enter the time delay before the alarm is reset.

  13. Select Invert to have the alarm enabled when the first shunt variable is active.

  14. In the Shunt variable 1 box, enter the binary variable that enables or disables the alarm.

  15. In the Operator list, select AND or OR to add logic between the first shunt variable and the second shunt variable.

  16. Select Invert to have the alarm enabled when the second shunt variable is active.

  17. In the Shunt variable 2 box, enter the binary variable that enables or disables the alarm

  18. Click Next .

  19. In the Presentation page, in the Alarm message box, enter the message to display when the monitored variable goes with or is equal to the alarm limits.

  20. In the Reset message box, enter the message to display when the alarm is reset.

  21. In the Category box, enter the category the alarm belongs to.

  22. In the Category 2 box, enter the second category the alarm belongs to..

  23. In the Prefix for alarm source name box, type a prefix that is added to the beginning of the source name property of an alarm record.

    Note:

    You can add alarm substitution codes to a prefix for the alarm source name. For more information, see Alarms Substitution Codes .

  24. In the Alarm priority box, enter the priority of the alarm when the monitored variable triggers the alarm.

  25. Select Same priority to let all priorities inherit the value in the Alarm priority box.

  26. In the Reset priority box, enter the priority of the alarm when it is reset.

  27. Select Auto hide to automatically hide the alarm from the Alarms pane or Alarm View.

  28. Select Flashing alert to make the alarm flash in the Alarms pane and Alarm Views when it is triggered.

  29. Select Audible alert to make the alarm sound when it is triggered.

  30. In the Custom audio box, enter the path to the custom audio file you want to play when the alarm is triggered.

    Note:

    If you have selected Audible alert but not selected any custom audio file, the default alarm sound is played when the alarm is triggered.

  31. Select Disable state-change logging to prevent an alarm state change from creating an event.

  32. Click Next .

  33. In the User Action page, select how the user has to acknowledge the alarm:

    • Select No when the alarm does not need to be acknowledged.

    • Select Single when the alarm needs to be acknowledged once, either in the alarm state or reset state.

    • Select Extended when the alarm needs to be acknowledged in both the alarm state and the reset state.

  34. In the Cause note group box, select the cause note group that you want to connect to the alarm.

  35. In the Action note group box, select the action note group that you want to connect to the alarm.

  36. In the Checklist box, select the checklist that you want to connect to the alarm.

  37. Select When acknowledging an alarm: Comment to force the user to add a comment to the alarm before the alarm can be acknowledged.

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

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

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

  41. Under Required user actions , select the actions for Comment , Cause note , and Action note to force the user to act on the listed actions.

  42. Click Next .

  43. In the Attachment page, click the Add attachment button

     
    action_zoom_plus_stroke
    .

  44. In the Select Object dialog box, select the object you want to attach to the alarm and then click Select .

  45. In the Attachment page, in the Display on alarm column, select the check box to automatically open the attachment when the alarm is triggered.

  46. Click Create .

  • Removing an Attachment from an Alarm
  • Create Matching Text String Alarm Wizard – Alarm Trigger Page
  • Create Alarm Wizard – Presentation Page
  • Create Alarm Wizard – User Action Page
  • Create Alarm Wizard – Attachment Page
  • Matching Text String Alarms
  • Alarm States
  • Custom Audible Alarm Alerts
  • Alarms Substitution Codes
  • Alarm Categories