1. Home
  2. Tridium Niagara 4 & AX
  3. Niagara 4 BFormat Quick Reference

Niagara 4 BFormat Quick Reference

A quick reference chart detailing the BFormat ‘codes’ you can use with creating PX pages in Niagara 4.

BFormat Description chart

BFormatDescription
%.%Value + Status of the Out slot
%out.value%Value of the Out slot
%out.status%Status of the Out slot
%Hours%Get the total elapsed time in hours
%Minutes%Get the total elapsed time in minutes
%displayName%Display Name of the component
%displayName.substring(0,3)%Display Name of the component showing only the part from the first to the third character
%displayName.substring(-2)%Display Name of the component showing only the end part from the second-last character
%name%Name of the component
%parent.displayName%Display Name of the parent component(1 level up)
%parent.name%Name of the parent component(1 level up)
%parent.parent.name%Name of the parent of the parent component(2 levels up)
%parent.proxyExt.device.name%Name of the device in which a proxy point resides(no matter how many levels above the point)
%parent.proxyExt.network.name%Name of the network in which a proxy point resides(no matter how many levels above the point)
%proxyExt.topic%On an MQTT point, returns the “topic” text
%user()%Returns the username of the user logged in(use “ord” “station:|slot:/”)
%time()%Returns the current time(use “ord” “station:|slot:/”)
%alarmData.sourceName%(to use on Alarm Extension Text)Returns the “Source Name” within the Fault, Offnormal or Normal text of an alarm
%alarmData.highLimit%(to use on Alarm Extension Text)Returns the “High Limit” within the Fault, Offnormal or Normal text of an alarm
%alarmData.lowLimit%(to use on Alarm Extension Text)Returns the “Low Limit” within the Fault, Offnormal or Normal text of an alarm
%out.prevDay%Using the “CurrentTime” block available from the kitControl palette, these bFormat examples will take the full date and time of the previous day, month or year according to the current time
%out.prevMonth%
%out.prevYear%
%out.Hour%Using the “CurrentTime” block available from the kitControl palette, these bFormat examples will take the individual Hour, Minute, Day, Month or Year data of the current time
%out.Minute%
%out.Day%
%out.Month%
%out.Year%
Updated on August 9, 2022

Was this article helpful?

Related Articles

Existing Customer?
Need some technical support from the One Sight team?
CONTACT SUPPORT