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

How to


Products: Enterprise Central, Enterprise Server, Esmi Sense FDP
Functionalities: Alarms
12/3/2024

Configuring an Alarm Triggered Notification 

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

Show More
action_close

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.

 
action_zoom_plus_stroke A notification is triggered and sends a notification report using one or more distribution methods
Figure: 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.

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 .

XLSX Reports

XLSX Report is a simplification of the Notification report function. Instead of creating trigger-notification objects and report template objects you create a XLSX Report object. The XLSX Template, which contains an XLSX document, is created for you and stored as a sub object of the XLSX report object.

Reports Job Queue

Ongoing notification reports jobs can be monitored in the Reports Job Queue. Ongoing jobs can also be canceled.

For more information, see Canceling an Ongoing Notification Reports Job .

To configure an alarm triggered notification 
  1. In WorkStation, in the System Tree pane, select the alarm triggered notification you want to configure.

  2. Click the Alarm Triggered Notification tab.

  3. Edit the properties:

    Table: Alarm Triggered Notification

    Property

    Description

    Status

    Select Disabled to deactivate the notification function.

    Activation schedule

    Enter the schedule that contains the value that activates the notification.

    Schedule value when active

    Enter the value, generated by the connected schedule or other multistate variable, that activates the notification.

    Report template

    Enter the path to the report template.

    For more information, see Notification Reports .

    Decimal symbol

    Select the decimal symbol to be used in the notification and the notification report template.

    Localization

    Select a language among the language packs installed on the EcoStruxure BMS server.

    System of measurment

    Select the system of measurements to be used in the notification report.

    Report format

    Select the format of the notification report.

    XLSX template

    Enter the path to the XSLX notification report template.

    Notification text

    Edit the notification text.

    Substitute missing data with

    Enter the text that is displayed when a value is missing. By default, a missing value displays nothing at all.

     
    action_zoom_plus_stroke

    Add

    Click to add a distribution method to the notification.

    For more information, see Notification Distribution Methods .

     
    action_zoom_plus_stroke

    Edit

    Click to configure the selected distribution method in the notification.

    For more information, see Notification Distribution Methods .

     
    action_zoom_plus_stroke

    Remove

    Click to remove the selected distribution method from the notification.

    For more information, see Notification Distribution Methods .

    Notify on transition to

    Select the alarm states that trigger the notification.

     
    action_zoom_plus_stroke

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

     
    action_zoom_plus_stroke

    Click to remove the selected alarm filter conditions for the notification.

     
    action_zoom_plus_stroke

    Clear all

    Click to remove all the alarm filter conditions for the notification.

  4. On the File menu, click Save .

  • Notification Reports
  • Document Signature Certificate
  • Create Object Wizard - Configure Write to File Page
  • Creating an Alarm Triggered Notification
  • Configuring a Variable Triggered Notification
  • Manually Triggering a Notification
  • Signing a PDF Notification Report with a Certificate