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: Automation Server, AS-B, Enterprise Server, AS-P, Virtual Project Servers
Functionalities: Alarms
Product version: 1.9
10/12/2017

Events Substitution Codes

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

Table: Events Substitution Codes for Notification Reports

Code

Description

@(AcknowledgeTime)

Writes the time and date an alarm was acknowledged.

@(AlarmState)

Writes the alarm state.

@(AlarmText)

Writes the alarm message that was added to the alarm.

@(AssignedState)

Writes the assigned state the alarm had. The possible values are: Unassigned, Assigned, and Accepted.

@(AssignedToDomain)

Writes the domain of the user or group that an alarm was assigned to.

@(AssignedToUniqueUserId)

Writes the ID of the user or group that an alarm was assigned to.

@(AssignedToName)

Writes the name of the user or group that an alarm was assigned to.

@(BACnetEventType)

Writes the BACnet alarm that monitored a variable within a BACnet network.

@(BasicEvaluationState)

Writes the basic evaluation state of an alarm. The value True indicates that an alarm was triggered.

@(Category)

Writes the category name.

@(Command)

Writes the executed command.

@(Comment)

Writes the comment that was added to an alarm.

@(ControlSource)

Writes the initials of the controlling I/NET operator.

@(ControlDescr)

Writes the 4 bit I/NET state descriptor.

@(Count)

Writes the number of times an alarm has toggled between the alarm and reset state.

@(Description)

Writes the description.

@(DeviceName)

Writes the name of the I/NET device that generated the event.

@(DisabledCause)

Writes the cause for why the alarm was disabled. An alarm can be disabled by user, shunt variable and/or system (it is disabled by system if the alarm was incorrectly configured).

@(DomainName)

Writes the domain a user belonged to.

@(EvaluationState)

Writes the evaluation state an alarm had. For example, Upper limit alarm is displayed if the monitored value reached the upper alarm limit.

@(CWSId)

Writes the ID of the event on the external system.

@(CWSSourceId)

Writes the ID of the external object that generated the event.

@(FirstName)

Writes the first name of the individual whose key/card was used at the I/NET door point.

@(ForcedValue)

Writes the forced values.

@(GroupName)

Writes the name of the cause note or action note group the user edited.

@(Hidden)

Writes the visible status an object had. False is displayed when an object was shown.

@(IndivNdx)

Writes the individual number of the individual whose key/card was used at the I/NET door point.

@(InetAdr)

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

@(InetEventTypeId)

Writes the I/NET event type.

@(LastName)

Writes the last name of the individual whose key/card was used at the I/NET door point.

@(LinkName)

Writes the name assigned to the link of the device from which the event originated.

@(MessageText)

Writes the text of an I/NET action or dispatch message, if there is one.

@(MonitoredVariable)

Writes the path to the monitored variable.

@(Note)

Writes the event notes.

@(PreviousAlarmState)

Writes the previous alarm state.

@(Priority)

Writes the priority an alarm had.

@(SigmaEventParams)

Writes the Sigma event parameter.

@(SigmaEventType)

Writes the Sigma event type.

@(Source)

Writes the path of the source object.

@(SourceName)

Writes the name of the external object that generated the event.

@(SourceServer)

Writes the server path of the source object.

@(TextField)

Writes the (up to) 4 text characters that represent the text state of a discrete point or the unit description of an analog point.

@(StationName)

Writes the name assigned to the controller from which the event originated.

@(SystemAlarmId)

Writes the alarm ID generated by the system.

@(SystemEventId)

Writes the event 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 an alarm went from normal state to alarm state.

@(TYPE)

Writes the event type.

@(UniqueAlarmId)

Writes the unique alarm ID of an alarm.

@(UniqueUserId)

Writes the ID of a user.

@(ItemName)

Writes the events of which the user has edited checklist, cause note group, or action note group items.

@(UserName)

Writes the name of the user that generated the event.

@(ValueAfter)

Writes the value of an object after it was changed.

@(MonitoredValue)

Writes the value the monitored variable had when the alarm was triggered.

@(ValueBefore)

Writes the value of an object before it was changed.

@(Zone)

Writes the I/NET security zone number associated with a security event (0-63).

See Also

  • Notification Reports
  • Properties and Watch Substitution Codes
  • Trend Logs Substitution Codes