Log on to rate and give feedback    1 2 3 4 5 Log on to rate
0
How to How to 2/17/2021
Products: AS-B, Enterprise Central, Enterprise Server, AS-P, Project Configuration Tool
Functionalities: Alarms
Product version: 3.2, 3.3

Creating an Alarm Triggered Notification

You create an alarm triggered notification to notify users when an alarm condition is met.

Hide
Show More

Notifications are used for notifying users or user groups that a certain alarm or other event, such as a schedule or an application condition, has occurred in the system. ​The notification contains a prewritten message that can be displayed as a popup message, sent as an email, sent to an SNMP manager, or written to a text file.

There are two types of notifications:

  • alarm triggered notifications

  • variable triggered notifications

Alarm triggered notifications are based on alarm filter conditions that have to be met before the notification is triggered.

Variable triggered notifications are based on a variable whose condition (true, false, or both) has to be met before the notification is triggered. You can also trigger notifications manually by using the trigger notification command.

Note:
  • You have to have permissions to the alarm that triggered the notification to receive an alarm triggered notification as a client notification or via email.

A notification is triggered and sends a notification report using one or more distribution methods

A notification is triggered and sends a notification report using one or more distribution methods

When setting up the notification, you configure the message text and the conditions that trigger the notification. When configuring the notification message text, you can use substitution codes to add current system information. For more information, see Alarm Substitution Codes 

If you want a schedule condition to be met before the notification is enabled, you can add a schedule to the notification. For example, you only want an email to be sent on weekends. You configure the active value to match the value of a multistate schedule when the notification is to be active. This only applies for alarm triggered notifications.

In a multi-server system, a notification object created on the Enterprise Server or on the Enterprise Central notifies on alarms triggered in the child servers. The advantage of creating the notification object on the Enterprise Server or on the Enterprise Central is that you do not need to create separate notification objects for each child server server.

You can configure the notification so that it is localized to any language for which a language pack is available on the server. The default language is US English. If you choose to localize the notification, enumerations and display names are translated with the correlating names available in the language pack.

You can configure the notification to use any of the following decimal separators:

  • '.' (period)

  • ',' (comma)

By default, the decimal separator is '.' (period).

Alarm Substitution Codes

Alarm substitution codes represent the information you want to dynamically add to alarm messages and notifications when an alarm is triggered.

For more information, see Alarms Substitution Codes .

Notification Distribution Methods

There are four different ways to distribute a notification to a recipient:

  • Client

  • Email

  • SNMP

  • Write to File

For more information, see Notification Distribution Methods .

Notification Reports

You can configure notification reports to include important information on the EcoStruxure BMS. Notification reports are distributed when a notification is triggered.

For more information, see Notification Reports .

Notification Workflow

Use the notification workflow to create a notification including a notification report template.

For more information, see Notification Report Workflow .

Date and Time Formatting

You can customize how date and time are presented in a notification text or a notification report text.

For more information, see Date and Time Formatting  .

Text Formatting

You can customize the presentation of decimals, value types, width, and alignment in a notification text or a notification report text.

For more information, see Text Formatting .

To create an alarm triggered notification
  1. In WorkStation, in the System Tree pane, click the folder where you want to add the alarm triggered notification.

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

  3. In the Create Object wizard, at the Choosing the Type and Naming the Object page, in the object type list, select Alarm Triggered Notification .

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

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

  6. Click Next .

  7. At the Configure Alarm Triggered Notification page, in the Status box, select Disabled to deactivate the notification function.

  8. In the Activation schedule box, enter the schedule that contains the value that activates the notification.

  9. In the Schedule value when active box, enter the value, generated by the connected schedule in the value property, that activates the notification. For more information, see Schedule Types .

  10. To add a notification report the notification, in the Report template box, enter the path to the notification report template. For more information, see Notification Reports .

  11. In the Decimal symbol box, select the decimal symbol to be used in the notification and notification report.

  12. To localize the notification, in the Localization box, select a language among the language packs installed on the EcoStruxure BMS server.

  13. In the System of measurements , select the system of measurements to be used in the notification report.

  14. In the Report format , select the format of the notification report.

  15. In the XLSX template box, enter the path to the XSLX notification report template.

  16. In the Notification text box, enter and edit the notification text.

    Note:

    You can use substitution codes, blank spaces, blank rows, and all printable characters in the notification text.

  17. From the list of substitution codes, drag the substitution codes you want to use in the notification text to the Notification text box.

  18. In the Substitute missing data with box, type the text that is displayed when a value is missing.

  19. In the Distribution method pane, click the Add button to open the Create Object dialog box and add a notification distribution method for the notification.

    Note:

    You can distribute the same notification in more than one way.

  20. To add a Client distribution method, in the Create Object dialog box, select Client and complete the following steps:

    • In the Name box, type a name for the distribution method.

    • In the Description box, type a description for the distribution method.

    • Click Create .

  21. To add an Email distribution method, in the Create Object dialog box, select Email and complete the following steps:

    • In the Name box, type a name for the distribution method.

    • In the Description box, type a description for the distribution method.

    • Click Next .

    • In the Subject box, type a subject that is displayed in the 'Subject' row of the email.

    • In the To users and groups box, enter the EcoStruxure Building Operation users or user groups to whom the email notification is to be sent. For more information, see Users and Groups Dialog Box .

    • In the To email address box, type the email address of an alternative recipient.

    • Select Send as attachment to send the notification as an attachment to the email.

    • In the Attachment filename box, type the name of the attachment file.

    • Click the Configure button to configure a reference for a dynamic attachment file name.

    • In the Convert to PDF box, select True to convert your notification report to PDF format.

    • Select Sign PDF box to sign your PDF. Sign PDF requires a license. If no valid license is available, the PDF is generated, but not signed.

    • In the PDF paper size box, select the size of the paper you want to use for display and print.

    • In the PDF paper orientation box, select the orientation of the page in display and print.

    • Click Create .

    Important:
    • A user account can have two email addresses: home and work. Only the work email address is used for email distribution of notifications. However, email notifications are sent only when the account has a work email address.

    • The email cannot be sent if the user does not have permission to the triggered alarm.

  22. To add an SNMP distribution method, in the Create Object dialog box, select SNMP and complete the following steps:

    • In the Name box, type a name for the distribution method.

    • In the Description box, type a description for the distribution method.

    • In the Address box, type the address to the SNMP manager that receives the notification.

    • Click Next .

    • In the Port box, type the port that is used by the SNMP manager that receives the notification.

    • In the User name box, type the user name of the user on the SNMP manager that receives the notification.

    • In the Security level box, select the security level.

    • In the Authentication protocol box, select the authentication level.

    • In the Authentication password box, enter the password of the user on the SNMP manager that is to receive the notification.

    • In the Confirm password box, type the password again.

    • In the Privacy encryption protocol box, enter the privacy encryption protocol of the user on the SNMP manager that is to receive the notification.

    • In the Privacy password box, enter the privacy password used to encrypt the message being sent.

    • In the Confirm password box, type the password again.

    • Click Create .

  23. To add a Write to file distribution method, in the Create Object dialog box, select Write to file and complete the following steps:

    • In the Name box, type a name for the distribution method.

    • In the Description box, type a description for the distribution method.

    • Click Next .

    • In the File name box, type a name for the file.

    • Click the Configure button to configure a reference for a dynamic file name.

    • In the Uniqueness box, select whether to append or prepend a timestamp to the file name, or generate the file without any timestamp.

    • In the Timestamp format box, type the format of date and time that you want to use.

    • In the Overwrite box, select True to overwrite the file when a new file is generated.

    • In the Convert to PDF box, select True to convert your notification report to PDF format.

    • Select Sign PDF box to sign your PDF. Sign PDF requires a license. If no valid license is available, the PDF is generated, but not signed.

    • In the PDF paper size box, select the size of the paper you want to use for display and print.

    • In the PDF paper orientation box, select the orientation of the page in display and print.

    • Click Create .

  24. In the Notify on transition to boxes, select the alarm states that trigger the notification.

  25. Click the Add button to add an alarm filter condition for the notification. For more information, see Alarm Filters .

  26. Click Create .

Community Content

Product version

Language