1. Overview
2. Property Settings

Overview

Entities are a set of elements within Commander™ Portal with which a user can build out an Entity Tree to host the solution(s) required. Entities offer a wide range of capabilities, ranging from displaying a live value from a device by linking to a specific gateway path, to triggering an alarm based off of specified logic.

Property Settings

The following properties are common for most of the entities, and are described below:

Figure 1 - Entity Properties

1. Entity ID: This is a unique code for this entity, no other entity in this tree structure will have the exact same unique identifier. This property is autogenerated on the creation of the entity.
2. Entity type: This is the specific entity you have chosen to use in your tree structure.
3. Name: This is the name you will give your specific entity. It can be edited at any time after creation.
4. Blueprint tags: The user can select from a list of existing blueprints on the tenant to apply a blueprint. This area will also display any blueprints that are currently tagged to the entity selected.
5. Digital twin tags: The user can select from a list of existing digital twin tags. Digital Twin tags can only be applied to Site or Group entities.
6. Description: This feature allows the user to add a short description of the entity’s functionality.
7. View children count: This feature will bring up a window with information about entities created under the selected entity as children, such as the tally of children entities and/or their entity type. Please note that this is only available on Site and Group entities.
8. Delete: This button will delete the selected entity. If the entity has children, the system will prompt the user to confirm the delete command.
9. Save: This button will update and save any edits to the properties made for the selected entity.

Blueprint tags can be applied to most entities, however, it is recommended to be used only on Site or Group entities that have telemetry (in the form of endpoints or functions) or alarms as children. When applying from a tag, the user will be able to select from a list of pre-made blueprints on the tenant to tag to the entity. Please see more about blueprints for more information.

When linking a Digital Twin tag to a Site or Group entity, the system will overwrite the Site or Group’s structure to fit that of the Digital Twin template that has been tagged and applied.

There are fourteen different entities currently in Commander™ Portal and they are described in full, with configuration guides and use case examples in the documentation provided: