alarm-TextCustomizer

This component creates a customized alarm source name using a BFormat string that obtains values from objects. This feature is primarily for developers.

Figure 2. Source Name properties

To access these properties, expand Config > Drivers > NiagaraNetwork > NiagaraStation > Alarms and double-click Source Name.

Property Value Description

drop-down list

Property	Value	Description
Op	drop-down list	Selects where to apply `Text`. `Use Existing` ignores `Text`. `Prepend` prefaces the name with `Text`. `Append` places Text as a suffix to the name. `Replace` replaces the name altogether with Text.
Text	BFormat	Defines the format string as normal text with embedded scripts denoted by the percentage symbol (%). The driver maps calls within the script to an object’s methods. You can chain using the dot operator (.). To insert a percentage character itself, use two percentage symbols (%%). Several special functions are available: “%time()%” formats the current time as BAbsTime. “%lexicon(mobile:key)%” gets the specified lexicon text.

Selects where to apply Text.

Use Existing ignores Text.

Prepend prefaces the name with Text.

Append places Text as a suffix to the name.

Replace replaces the name altogether with Text.

Text

BFormat

Defines the format string as normal text with embedded scripts denoted by the percentage symbol (%). The driver maps calls within the script to an object’s methods. You can chain using the dot operator (.). To insert a percentage character itself, use two percentage symbols (%%).

Several special functions are available:

“%time()%” formats the current time as BAbsTime.

“%lexicon(mobile:key)%” gets the specified lexicon text.

Examples

“my parent’s name is %parent.displayName%” formats the display name of an object’s parent using calls to the getParent ( ) and getDisplayName ( ) methods.

“%value% {%status.flagsToString%} @ %status.priority%” retrieves the specified lexicon text.

More information is available in the class documentation for BFormat.