Product documentation

04. Boolean

This custom attribute type is meant to append one attribute or a list of attributes from a predefined list to the asset. Like for example to described in which departments an asset can be used.

FieldDescriptionPossible values
typeThe type of the custom attributeATTRIBUTE_WITH_BOOLEAN
rootVenueScopeIdThe ID of the root venueA specific integer
nameThe name of the custom attribute Any text (has to be unique)

For example:

  • “Full”
  • “Clean”
  • “Occupied”
descriptionThe description of the custom attribute Any text

For example:

  • “This describes if the asset is full (true) or empty (false).”
  • “This describes if the asset is clean (true) or not (false).”
  • “This describes if the asset is occupied (true) or not (false).”
mandatoryIf the custom attribute is required for the assigned assets True or false.

If the custom attribute is mandatory, every assigned asset will have to have a value for this custom attribute.

defaultValueIf no value has been specified, and the defaultValue is not empty, then the assigned asset will  have the default value for this custom attribute. True or False
colors

If this is set, the assets will be styled according to their custom attribute value in the Viewer. For example the markers on the map.

Color of the map marker in Hex format. For example #94B512
iconsAny React Material Icon
attributeOrderThis define the priority of the custom attributes for the rendering of the styles in the Viewer. If two different custom attributes have styles applied, then the first one in the attributeOrder (lowest value) will be shown by default in the Viewer.Any integer
localizedAttributeValueThis is an array containing an object per available language with the label and the value of the custom attribute which will be used for the rendering in Favendo’s Modular RTLS suite (Viewer, Tagger, Robot, …).
[
  {
    "language": "en",
    "label": "Clean"
  },
  {
    "language": "de",
    "label": "Sauber"
  }
]