Domain Services

Services are used to perfom actions that require and/or manipulate entites from a variety of different namespaces.

Creating a service

A service can be created by using the Create capability that is located on the Services overview page.

Services are defined using the following master data:


Property	Description
Type	There is one option available and this is the Domain Service. This field is mandatory.
Local identifier	This is the identifier (name) of the service. 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 services! Furthermore, names may not begin with a digit and the first character must be uppercase. The local identifier can not be changed after creation. This field is mandatory.
Label	This is used to give a short description of the service. This field is mandatory.
Short label	This is used to give an even shorter description of the service. This field is optional.
Notes	This is long description of the service. This field is optional.

You can also use the Open after creation checkbox to open the service for further editing after saving.

Note: Services cannot have the same local identifier as a command or an agent in the same namespace.

Editing a service

Edit master data

You edit the master data of a service by using the Information capability and navigating to the section Master data and using the Edit master data capability or by using the inline and header Edit capability. For a description of the master data, see the section Creating a service. The type and the local identifier cannot be changed. When editing the master data of a service, you can overwrite the values for label, short label and notes. The overwritten values are lost as soon as the editing action has been completed.

Add input entity

It is possible to add an already existing entity (root or entity) or a create a new one and assign it as an input entity to the service by using the Add input entity or Create input entity capability. To add and edit the properties of the input entity, see section Properties.

Add output entity

It is possible to add an already existing entity (root or entity) or a create a new one and assign it as an output entity to the service by using the Add output entity or Create output entity capability. To edit the properties of the input entity, see section Properties.

Add Events

There are two options when adding an event to a service: either to add a new event (see Creating an event) or add an already existing event. Regarding already existing events, a list of all the events that have been created in a solution is shown. It is also possible to search for a specific event using the Search capability. One or more event can be selected in order to be added to the command.

Add Errors

There are two options when adding an error to a service: either to add a new error (see Creating an error) or add an already existing error. Regarding already existing errors, a list of all the error that have been created in a solution is shown. It is also possible to search for a specific error using the Search capability. One or more errors can be selected in order to be added to the command.

Edit Documentation

By using the Edit documentation capability, the documentation of the specific command can be edited. There are three possible sections that can be filled: Precondition(s), Command logic/Flow and Postcondition(s).

Deleting a service

You can delete a service by using the inline or header Delete capability in the services’ overview page or by using the Detail View of a service. Alternativerly, you can use the Information capabilityto access the details view and there you can use the Delete capability.

You will need to confirm the action before the selected service is permanately deleted.