Help
  • Explore Community
  • Get Started
  • Ask the Community
  • How-To & Best Practices
  • Contact Support
Notifications
Login / Register
Community
Community
Notifications
close
  • Forums
  • Knowledge Center
  • Events & Webinars
  • Ideas
  • Blogs
Help
Help
  • Explore Community
  • Get Started
  • Ask the Community
  • How-To & Best Practices
  • Contact Support
Login / Register
Sustainability
Sustainability

Join our "Ask Me About" community webinar on May 20th at 9 AM CET and 5 PM CET to explore cybersecurity and monitoring for Data Center and edge IT. Learn about market trends, cutting-edge technologies, and best practices from industry experts.
Register and secure your Critical IT infrastructure

Substitution Codes for alarm email notifications so different properties of an alarm can be sent

Building Automation Knowledge Base

Schneider Electric Building Automation Knowledge Base is a self-service resource to answer all your questions about EcoStruxure Building suite, Andover Continuum, Satchwell, TAC…

cancel
Turn on suggestions
Auto-suggest helps you quickly narrow down your search results by suggesting possible matches as you type.
Showing results for 
Show  only  | Search instead for 
Did you mean: 
  • Home
  • Schneider Electric Community
  • Knowledge Center
  • Building Automation Knowledge Base
  • Substitution Codes for alarm email notifications so different properties of an alarm can be sent
Options
  • Bookmark
  • Subscribe
  • Email to a Friend
  • Printer Friendly Page
  • Report Inappropriate Content
Invite a Co-worker
Send a co-worker an invite to the portal.Just enter their email address and we'll connect them to register. After joining, they will belong to the same company.
You have entered an invalid email address. Please re-enter the email address.
This co-worker has already been invited to the Exchange portal. Please invite another co-worker.
Please enter email address
Send Invite Cancel
Invitation Sent
Your invitation was sent.Thanks for sharing Exchange with your co-worker.
Send New Invite Close

Related Forums

  • Intelligent Devices Forum

Previous Next
Contributors
  • DavidChild
    DavidChild
  • Cody_Failinger
    Cody_Failinger
  • Dave_Shore
    Dave_Shore
  • DavidFisher
    DavidFisher
  • Benji
    Benji
  • sesa177673
    sesa177673
  • Product_Support
    Product_Support

Invite a Colleague

Found this content useful? Share it with a Colleague!

Invite a Colleague Invite
Back to Building Automation Knowledge Base
Options
  • Bookmark
  • Subscribe
  • Email to a Friend
  • Printer Friendly Page
  • Report Inappropriate Content
1 Like
3909 Views

Link copied. Please paste this link to share this article on your social media post.

Trying to translate this page to your language?
Select your language from the translate dropdown in the upper right. arrow
Translate to: English
  • (Français) French
  • (Deutsche) German
  • (Italiano) Italian
  • (Português) Portuguese
  • (Русский) Russian
  • (Español) Spanish

Substitution Codes for alarm email notifications so different properties of an alarm can be sent

Picard Product_Support
‎2018-09-11 04:47 AM

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.
Labels (1)
Labels:
  • EcoStruxure Building Operation
Tags (6)
  • Find more articles tagged with:
  • 13539
  • DavidShore19
  • emailing
  • temperature
  • wild
  • wildcard
Was this article helpful? Yes No
100% helpful (1/1)

Link copied. Please paste this link to share this article on your social media post.

To The Top!

Forums

  • APC UPS Data Center Backup Solutions
  • EcoStruxure IT
  • EcoStruxure Geo SCADA Expert
  • Metering & Power Quality
  • Schneider Electric Wiser

Knowledge Center

Events & webinars

Ideas

Blogs

Get Started

  • Ask the Community
  • Community Guidelines
  • Community User Guide
  • How-To & Best Practice
  • Experts Leaderboard
  • Contact Support
Brand-Logo
Subscribing is a smart move!
You can subscribe to this board after you log in or create your free account.
Forum-Icon

Create your free account or log in to subscribe to the board - and gain access to more than 10,000+ support articles along with insights from experts and peers.

Register today for FREE

Register Now

Already have an account? Login

Terms & Conditions Privacy Notice Change your Cookie Settings © 2025 Schneider Electric

This is a heading

With achievable small steps, users progress and continually feel satisfaction in task accomplishment.

Usetiful Onboarding Checklist remembers the progress of every user, allowing them to take bite-sized journeys and continue where they left.

of