BuildingKPI parameter settings

Written By Natalia Povrozniak (Administrator)

Updated at July 8th, 2024

BuildingKPI setting lists configurable options available on the IBSS platform to be displayed in Roamer home screen.

Parameter Value type Note
BuildingKPI_Order integer The order that the KPI should be shown as.
BuildingKPIId integer Internal number.
Node_Id integer Building node ID.
KPIType string

0 – NumberSlider: number of used/occupied with size/slider, drives the colour change.
1 – TextSlider: textual indication with size/slider, drives the colour change.
2 – NumberOnly: shows the value number only, with no other indicators of size/slider.
3 – TextOnly: textual indication without size/slider.

 

Image
Units string If provided, is shown after the value.
Label string Not used anymore.
MaximumCount string To define the maximum value for the sliders.
Limit1 float

To drive the colour change:

  • Both limits are fractions/decimals,
    i.e. Limit1= 0.25, Limit2= 0.5
  • Limit1: The % value which the "warning" colour will be shown. (0.01 - 0.99)
    Limit2: The % value which the "alarm" colour will be shown. (0.01 - 0.99)
  • x <= Limit1, it will show green (or Text0)
  • Limit1 < x <= Limit2, it will show amber (or Text1)
  • x > Limit2, it will show red (or Text2)
Limit2 float
Text0 string Shown in type 2/4 when value below or equal to Limit1.
Text1 string Shown in type 2/4 when value above Limit1 and below or equal to Limit2.
Text2 string Shown in type 2/4 when value above Limit2.
Value float Stored for initial loading purposes. After the initial load, the value will be maintained both in the table as well as the Redis cache for performance.
ValueURI string Defines where in the system data is taken from.
Icon string Name of the icon used on the tile.
ActionLabel string Title of the KPI tile.
ActionURI string Defines where you want to send users to.

Example of a record

{
 "BuildingKPI_Order": 1,
 "BuildingKPIId": 11107089,
 "Node_Id": 6,
 "KPIType": "TextOnly",
 "Units": "",
 "Label": "desk dynamic",
 "MaximumCount": "150",
 "Limit1": 0.5,
 "Limit2": 0.25,
 "Text0": "",
 "Text1": "",
 "Text2": "",
 "Value": 1,
 "ValueURI": "Space_Work_Type eq 'DeskWork' and Space_IsEnabled eq 1 and (Space_Status eq 'S12' or Space_Status eq 'S14' or Space_Status eq 'S15')",
 "Icon": "desk",
 "ActionLabel": null,
 "ActionURI": "roamer://spaces/search?searchtype=Filter&filter={ValueURI}"
}