Issue
How to display custom text and properties of an alarm in the email notification.
Product Line
EcoStruxure Building Operation
Environment
- Email Notification
- Substitution Codes
Cause
To enhance the clarity and relevance of alarm email notifications, EcoStruxure Building Operation supports the use of substitution codes. These codes allow dynamic insertion of alarm-specific properties—such as the value at the time of the alarm trigger—into the email subject or body.
Resolution
To customize alarm email content:
- Navigate to the Email Notification object in the system.
- In the Properties pane, locate the Subject and Text fields.
- Enter desired message, incorporating substitution codes where needed.
Example:
Subject: Alarm Triggered - %AlarmName%
Text: The alarm '%AlarmName%' was triggered at %TimeStamp%. Value at trigger: %Value%.
In scenarios where detailed context is required (e.g., documenting the exact value that caused an alarm state change), substitution codes enable automated inclusion of such data in the notification message. This is particularly useful for operational audits, troubleshooting, or real-time monitoring
Available Substitution Codes
Below is a list of commonly used substitution codes:
Code | Description |
---|---|
%AlarmName% |
Name of the alarm |
%TimeStamp% |
Time the alarm was triggered |
%Value% |
Value of the monitored point at trigger |
%Priority% |
Alarm priority level |
%Source% |
Source object of the alarm |
For a complete list of supported codes: Alarms Substitution Codes