Linking the alarm
topic of an Alarm Class into the route
action of a JsonAlarmRecipient
will trigger generation of a new json payload each time an alarm is received by that alarm class.
The JsonAlarmRecipient comes with a nested schema whose payload output will depend on the alarms passed through from the parent recipient.
Queries, Bound Objects/Arrays, and/or properties can be used to include present value data from the station in the payload.
There are however some alarm specific data types which can be included, notably the properties from a Niagara Alarm Record BAlarmRecord
By including the unique identifier in an outgoing message, an inbound json payload can acknowledge alarms.
These properties are only supported on the JsonAlarmRecipients Schema.
Each of these added to the schema allows inclusion of the selected Alarm Property in the output. For example the sourceState
, uuid
, alarmClass
etc. As with other json Schema Properties the name is determined by renaming the property, for example AlarmRecordProperty -> timestamp.
This is included to allow user defined alarm data to be extracted from the Niagara alarm database. For example, if an engineer used the Metadata property of an AlarmExt to record the location of a point in the building, this could be fetched using alarmData.location
to include in the payload.