Integration Entities
Create Entities
You can get an overview of the existing entities on the Entities tab on the Overview page of an integration namespace. You create a new entity using the Create capability
In integration namespaces entities do not differ greatly from the entities of domain namespaces. One of the main differences is that root entities and external entities are not allowed in integration namespaces.
Moreover, the entities that are modeled in integration namespaces are used to map the external object that is returned by the external operation to the current solution. Then this entity can be attached as a known entity to an external entity in the domain namespace, thus, mapping the external object to the domain logic.
Define entity master data
Entities are defined using the following master data:
| Property | Description |
| Local identifier |
This is the local identifier (name) of the entity. It is unique within a solution. Please note that only the characters A-z (without special characters), digits and the special character "_" are permitted for naming entities! Furthermore, local identifiers may not begin with a digit and the first character must be uppercase. The local identifier cannot be changed after creation. This field is mandatory. |
| Abstract | This is a check-box field. When checked, it indicates that the entity will be abstract. If the field is checked, no instances of this entity can be created by the Solution Envoy environment. The default value is unchecked. This field is only available for entities and root entities. |
| Label |
This is used to label the entity. This field is mandatory. |
| Short label |
This is used to give an even shorter label. This field is optional. |
| Notes |
This is a long description of the entity and its life-cycle. This field is optional. |
| Parents | This specifies one or more entities from which the new entity is meant to inherit properties and commands. Entities can only add other entities as parents and root entities other root entities. This field is only available for entities and root entities. |
You can also use the Open after creation check-box to open the entity for further editing after saving.
Edit Entities
You edit the master data using the Information capability on the entity instance page. When editing all types of entities, you can overwrite the values for label, short label and notes. It is not possible to overwrite the type and the local identifier.
The overwritten values are lost as soon as the editing action has been completed.
Delete Entities
You can delete an entity by using the inline Delete capability. Alternatively, you can use the Information capability to access the Details view and there you can use the Delete capability.
You will need to confirm the action before the selected response is permanently deleted.