BFormatProperty (B Format String)

This property defines alarm data to extract from the Niagara alarm database. For example, if an engineer uses the Metadata property of an AlarmExt to record the location of a point in a building, alarmData.location could fetch this information and include it in the payload.
Figure 67.   BFormatProperty
Image

To use this property, expand the Alarm node in the palette and drag a BFormatProperty to a schema’s object folder.

Property Value Description
Format B Format String Defines the BFormat string. For example:
"%idKey%" : "x",
"%valueKey%" : y,
"%slotNameKey%" : "slotName"
Attempt Type Conversion true (default) or false Converts Booleans and numbers in a formatted string to native JSON Booleans and numbers.

true performs the conversion.

false leaves Booleans and numbers as they are.

Error Substitute drop-down list, defaults to Blank Controls the role of an error substitute.

Ignore does nothing.

Key Only substitutes using the location ID.

Blank substitutes nothing.