Labels

Labels are used to categorize and organize entities in the system. Labels can be used to filter the entity list by label, allowing you to view only entities that have a specific label. Labels can be assigned to entities using the Labels field in the Entity List or assigned to Components in the Designer.

Managing the List of Available Labels

To manage the list of available labels, you can use the Labels property in the Entity List. The pen icon to the right of the Labels field opens the Labels modal, where you can add, edit, or delete labels.

The Labels modal, or as it is titled Add New Label, allows you to create a new label by entering a name for the label in the Label Name field. You should also add a description to the label in the Description field.

Once you have entered the label name and description, click the Save button to create the label. If you want to edit an existing label, you can select it from the list of available labels in the Labels modal.

To edit an existing label, click on the pen button next to the label name. This will make the name and description fields editable. After making the changes, click the Save ✓ button to save the changes. To cancel the changes, click the Cancel ✗ button.

To delete a label, click the trash can icon next to the label name. This will remove the label from the list of available labels. If the label is assigned to any entities, its assignment will be removed, so that the entities will no longer have that label. Consider this before deleting labels, as it may affect the organization of your entities.

Permanent Labels

Some labels are permanent and cannot be deleted. These labels are typically installed with the system and assigned to components part of the initial installation or a subsequent update.

Assigning Labels to an Entity

To assign labels to an entity, you can use the Labels field in the Entity List. When you click the drop-down arrow next to the Labels field, a list of available labels will be displayed. You can select one or more labels from this list to assign them to the entity.

Each assigned label will be displayed in the Labels field, and you can remove a label by clicking the small “x” next to the label name. This will remove the label from the entity, but the label itself will not be deleted from the system.

Labels Permanently Assigned to an Entity

Some labels are permanently assigned to an entity and cannot be removed. These labels are typically assigned to components delivered with the system.

Using Labels in the Designer

It is possible to assign labels to components in the Designer. This allows you to categorize components and filter them based on labels. When you assign a label to a component, from the Designer, it will be displayed in the Labels field of the component in the entity list as well.

Details on how to use labels in the Designer can be found in the Designer UserManual.