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
There may be certain situations where a specific property of the monitored value needs to listed in the alarm email that is sent out. For example when an alarm is triggered, the value at the time the alarm state changed my need to be documented in the notification email. These are called substitution codes.
Resolution
- The properties of the Email Notification can be set to customize the message that is sent out when an alarm changes states.
- As seen in the properties window of the Email Notification above, the "Subject" and "Text" can be changed to say whatever is desired. There are special codes that can also be entered into these fields to pull actual properties from the value that went into alarm. Below is a table that lists all of the Codes for the different value properties. This same information can also be found on the EcoStruxure Building Operation WebHelp.
Substitution Codes for Notifications
| Code | Description |
|---|---|
| @(AcknowledgedBy) | Writes the user that acknowledged the alarm. |
| @(AcknowledgeTime) | Writes the time the alarm was acknowledged. |
| @(AckRequired) | Writes an indicator if the BACnet alarm requires acknowledgement. |
| @(AlarmState) | Writes the present state of the alarm. |
| @(AlarmText) | Writes the alarm messages that is added to the alarm. |
| @(AssignedID) | Writes the unique ID of the user the alarm is assigned to. |
| @(AssignedState) | Writes the current assigned state the alarm is in. The possible values are Unassigned, Assigned, and Accepted. |
| @(AssignedTo) | Writes the name of the user or group that the alarm is assigned to. |
| @(AssignedToDomain) | Writes the domain of the user or group that the alarm is assigned to. |
| @(BACnetEventType) | Writes the BACnet event type for this alarm. |
| @(BACnetNotificationType) | Writes whether the BACnet notification was an alarm or event. |
| @(BasicEvaluationState) | Writes if the alarm is active or not. |
| @(Category) | Writes the category name of the alarm. |
| @(CommandValue) | Writes the value which was commanded for a BACnet command failure alarm. |
| @(ConfirmedNotification) | Writes an indication whether a BACnet notification was issued as a confirmed or unconfirmed BACnet message. |
| @(Count) | Writes the number of times the alarm has toggled between the alarm and reset states. |
| @(Deadband) | Writes the value of the deadband used for limit checking for BACnet out of range alarms. |
| @(DeviceName) | Writes the name of the I/NET device that generated the event. |
| @(DisabledCause) | Writes the cause of the alarm being disabled. An alarm can be disabled by User, Shunt variable, and System. If the alarm isn't configured correctly it can be disabled by System. |
| @(ErrorLimit) | Writes the difference limit that was exceeded for BACnet floating limit alarms. |
| @(EvaluationState) | Writes the present evaluation state of the alarm. For example, Upper limit alarm is displayed when the monitored value reaches the upper alarm limit. |
| @(EventFromState) | Writes the event state of the object prior to the occurrence of the alarm condition for BACnet alarms. |
| @(CWSid) | Writes the EcoStruxure Web Service identification of the alarm on the external system. |
| @(CWSSourceId) | Writes the EcoStruxure Web Service identification of the external object that generated the alarm. |
| @(ExceededLimit) | Writes the value of the limit that was exceeded for BACnet out of range alarms. |
| @(ExceedingValue) | Writes the value that exceeded a limit for BACnet out of range alarms. |
| @(FeedbackValue) | Writes the value that differs from the commanded value for a BACnet command failure alarm. |
| @(FirstName) | Writes the first name of the individual whose key/card was used at the I/NET door point. |
| @(Hidden) | Writes the visible status of an object. False is displayed when the object is shown. |
| @(IndivNdx) | Writes the individual number of the individual whose key/card was used at the I/NET door point. |
| @(LastName) | Writes the last name of the individual whose key/card was used at the I/NET door point. |
| @(Logging) | Writes whether the alarm should be logged or not. |
| @(MessageText) | Writes the text of an I/NET action or dispatch message, if there is one. |
| @(MonitoredObject->DESCR) | Writes the description property of the monitored object. |
| @(MonitoredObject->NAME) | Writes the name property of the monitored object. |
| @(MonitoredObject->NOTE1) | Writes the note 1 property of the monitored object. |
| @(MonitoredObject->NOTE2) | Writes the note 2 property of the monitored object. |
| @(MonitoredObject->LabelText) | Writes the label text of the monitored object. This requires that a MonitoredVariable is configured. |
| @(MonitoredValue) | Writes the value depending on the alarm states selected under 'Notify on transition to'. |
| @(MonitoredVariable) | Writes the path of the monitored variable. |
| @(NewMode) | Writes the new mode of the monitored object for a BACnet change of value alarm. |
| @(NewState) | Writes the new state of the monitored object for a BACnet change of state or change of life safety alarm. |
| @(NewValue) | Writes the new value of the monitored property for a BACnet change of value alarm. |
| @(NotificationClass) | Writes the distribution information of an alarm notification within a BACnet system. |
| @(OperationExpected) | Writes the next operation requested by the monitored object for a BACnet change of life safety alarm. |
| @(OriginalAlarmText) | Writes the alarm text from the matched alarm. This substitution code is only available for Alarm Decorators. |
| @(PossibleOperatorActions) | Writes the possible actions one can perform on the record, given permissions. |
| @(PreviousAlarmState) | Writes the previous alarm state. |
| @(Priority) | Writes the current priority level of the alarm state. |
| @(ProcessId) | Writes the process identifier configured by the notification for a BACnet alarm. |
| @(ReferencedBitString) | Writes the new value of the monitored bitstring property for a BACnet change of bitstring alarm. |
| @ (Report) |
Writes the name of the report connected to the notification. |
| @(SEQNO) | Writes the sequence number of the record. |
| @(SetpointValue) | Writes the value of the setpoint when the alarm condition occurred for a BACnet floating limit alarm. |
| @(Source) | Writes the path of the source object. |
| @(SourceName) | Writes the name of the source object that generated the alarm. |
| @(SourceObject->DESCR) | Writes the description property of the source object. |
| @(SourceObject->NAME) | Writes the name property of the source object. |
| @(SourceObject->NOTE1) | Writes the note 1 property of the monitored object. |
| @(SourceObject->NOTE2) | Writes the note 2 object of the monitored object. |
| @(SourceServer) | Writes the path to the server where the source object is located. |
| @(StatusFlags) | Writes the status flag of the object. |
| @(SystemAlarmId) | Writes the alarm ID generated by the system. |
| @(TenantNdx) | Writes the tenant number of the individual whose key/card was used at the I/NET door point. |
| @(TimeStamp) | Writes the time and date when the event was generated. |
| @(TriggeredTimestamp) | Writes the time and date of the last state transfer from normal state to alarm state. |
| @(TYPE) | Writes the record type. |
