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

Concept


Products: AS-B, Edge Server, Enterprise Central, Enterprise Server, AS-P, Virtual Project Servers
Functionalities: Alarms
Product version: 2024, 7.0
10/29/2024

Alarms Substitution Codes

arrow1_rotationAlarm Messages

Alarms substitution codes represent the information you want to display when a notification report is triggered. The information is dynamically filled in from the alarms that are included in the notification report.

Table: Alarms Substitution Codes for Notification Reports

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.

@(ActionMessage)

Writes the message discribing the action.

@(ActiveAlarmEnrollment)

Writes the information about activation of the alarm enrollment.

@(AlarmState)

Writes the present state of the alarm.

@(AlarmText)

Writes the alarm messages that are 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.

@(Category2)

Writes the second 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.

@(CustomAudio)

Write information about customised audio input.

@(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.

@(DisabledBy)

Writes the name of the user who disabled the alarm.

@(​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.

@(DispatchMsg)

Writes the message about the alarm dispatch.

@(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 occurence 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.

@(FireZone)

Writes the number of the zone from which the alarm originates. Writes 0 if no zone is configured.

@(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.

@(InetAddr)

Writes the system address of the I/NET point, or station address of the I/NET host or controller, that generated the event.

@(LastComment)

Writes the last comment that has been added to the alarm.

@(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. This requires that a MonitoredVariable is configured.

@(MonitoredObject->NAME)

Writes the name property of the monitored object. This requires that a MonitoredVariable is configured.

@(MonitoredObject->NOTE1)

Writes the note 1 property of the monitored object. This requires that a MonitoredVariable is configured.

@(MonitoredObject->NOTE2)

Writes the note 2 property of the monitored object. This requires that a MonitoredVariable is configured.

@(MonitoredObject->LabelText)

Writes the label text of the monitored object. This requires that a MonitoredVariable is configured.

@(MonitoredValue)

Writes the value that caused the alarm to become active or inactive.

@(​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.

@(ReferencedValue)

Writes the referenced value when the alarm condition occurred for a BACnet floating limit 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 occured for a BACnet floating limit alarm.

@(SigmaEventType)

Writes the type "Sigma" of the event.

@(SigmaEventParams)

Writes the parameters of the sigma event.

@(​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 source object.

@(SourceObject->NOTE2)

Writes the note 2 property of the source object.

@(​SourceServer)

Writes the path to the server where the source object is located.

@(StationName)

Writes the name of the name assigned to the I/NET controller from which the event originated.

@(StatusFlags)

Writes the status flag of the object.

@(SystemAlarmCategory)

Writes the category of the fire detection system alarm.

@(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 state transfer from normal state to alarm state.

@(TYPE)

Writes the record type.

Alarm Messages

​When configuring the alarm, you can write a message that displays in the Alarms pane, Events pane, Alarm Views, and Event Views when an alarm is triggered or reset.

For more information, see Alarm Messages .

See Also

  • Notifications
  • Notification Reports
  • Events Substitution Codes
  • Groups Substitution Codes
  • Multi Log List Substitution Codes
  • Properties and Watch View Properties Substitution Codes
  • Trend Log Records Substitution Codes
  • Users Substitution Codes
  • Alarm Functions
  • Alarms Overview
  • Alarm Messages
  • Alarm Decoration