Entities

The entities in integration namespaces do not differ much from the entities in 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 modelled in integration namespaces are used to map the external object that is returned by the API operation to the current project. 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.

Create entities

You can create new entities on the Entities tab of an integration namespace's Overview page.

entities are defined using the following master data:

  • Type: Integration namespaces only support type entities

  • Local Identifier: This is the local identifier (name) of the entity. It is unique within a namespace. 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 (required)

  • Abstract: This is a checkbox 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 name the entity (required)

  • Short Label: This is used to give an even shorter label (optional)

  • Notes: This is a long description of the entity and its lifecycle (optional)

  • Parents: This specifies one or more entities from which the new entity will inherit properties and commands. entities can only add other entities as parents.

You can also use the Open after creation check-box to open the entity for further editing after saving.

Associate Properties

Associating properties to an entity in an integration namespace follows the same rules as in domain Namespaces. See associate properties to entities for further details.

Edit entities

You can edit the master data of an entity by using the Information capability on an entity's instance page, navigating to the Master Data section and using the Edit capability. Alternatively, you can use the Edit capability at each row of the table on the Entities tab of an integration namespace's Overview page.

You can only edit the following fields:

  • Abstract

  • Label

  • Short Label

  • Notes

Note: It is not possible to change the Type and the Local Identifier for an entity.

Delete entities

You can delete an entity by using the Information capability on an entity's instance page, navigating to the Master Data section and using the Delete capability. Alternatively, you can use the Delete capability at each row of the table on the Entities tab of an integration namespace's Overview page.

Attention: You can only delete an entity if it is not in use.You can check the usages of an entity by using the Information capability and navigating to the Usages section. You will need to confirm the action before the selected entity is permanently deleted.