Learning CoB

# $instanceLabel and $instanceDescription - Label and Description Fields

The $instanceLabeland $instanceDescription keywords are used to easily identify Instances on search result listings. They signal the columns that appear in the listing of a definition.

# $instanceLabel

The $instanceLabel keyword serves as the Instance main identifier. Each Definition must have ONLY ONE field with this keyword and its value must be UNIQUE (non-repeating). Whenever we do a search query for an instance on the CoB platform, the main data element shown in the results is the value of the field that has the $instanceLabel keyword.

If a definition does not have a field with the $instanceLabel keyword, the ID field is the instance main identifier.

# $instanceDescription

The $instanceDescription keyword, on the other hand, is assigned to definition fields which we want to act as additional instance identifiers. The values assigned to fields built with this keyword will be shown by default in search results whenever the user searches for an instance of that definition. One definition can have more than one field configured with the $instanceDescription keyword.

# Examples:




WARNING

If a definition does not have a field built with the $instanceLabel keyword, any search results for instances of this definition will present the id of each instance in bold as the instance main identifier instead of the value of a field.

The video included below shows the example included in the screenshots working in real-time:

← $ref() - Fields Referencing Other Fields →