AlarmRecipient

Linking the alarm topic of an alarm class into the route action of a JsonAlarmRecipient triggers the generation of a new payload each time the alarm class receives an alarm.

The JsonAlarmRecipient comes with a nested schema whose payload output depends on the alarms passed through from the parent recipient.

Queries, bound objects and arrays, and/or properties can include present value data from the station in the payload.

There are, however, some alarm-specific data types you can include, notably the properties from a Niagara Alarm Record: BAlarmRecord

By including the unique identifier in an outgoing message, an inbound payload can acknowledge alarms.

Alarm Record Property

Only the JsonAlarmRecipient’s schema supports these alarm-related properties. Adding each of these to the schema allows inclusion of the selected alarm property in the output.

For example, the sourceState, uuid, alarmClass etc. As with other schema properties the name is determined by renaming the property, for example AlarmRecordProperty becomes timestamp.

BFormat Property

This property defines the 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.