Services

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

Create services

A service can be created by using the Create service capability on the Services tab of the domain namespace's Overview page.

Services are defined using the following master data:

Type: There is one option available and this is the Domain Service (required)
Local Identifier: Identifier of the service. This value must be unique within the namespace. Please note that only the characters A-z (without special characters), digits and the special character "_" are permitted for naming fields! Furthermore, identifiers may not begin with a digit (required)
Label: Label of the service (optional)
Short Label: Short label of the service (optional)
Notes: Useful information regarding the service definition (optional)

Warning:

Services cannot have the same Local Identifier as a service or an agent in the same namespace.

Edit services

Edit master data

Editing the master data of a service is available, by using the Edit capability of each table row on the Services tab of a domain namespace's Overview page. The fields that can be edited are Local Identifier, Label, Short Label and Notes.

Edit service details

Service details can be edited by clicking the Edit service details button in the Service Details section on the service's instance page.The fields that can be edited are Local Identifier, Label, Short Label and Notes.

Note:

It's not possible to edit the Type of a service.

Add input entity

It is possible to assign an Input entity to a service by either clicking on Create new private entity or Select existing entity in the Input section of the service's instance page. To add properties to the input entity click on the Add capability and choose

Create new property
Associate existing property

See Domain Properties for further details on creating properties.

Add output entity

It is possible to assign an Output entity to a service by either clicking on Create new private entity or Select existing entity in the Output section of the service's instance page. To add properties to the input entity click on the Add capability and choose

Create new property
Associate existing property

See Domain Properties for further details on creating properties.

Add business events

To add a Business Event to a service that will get published each time the service is executed, click on Add event in the Business Events section of the service's instance page. There are two options when adding an Event to a service:

Add new event
Add existing event

Regarding already existing events, a list of all the events that have been created in a project is shown. It is also possible to search for a specific event using the Search capability. One or more events can be selected in order to be added to the service.

Add business errors

To add a Business Error to a service that will get returned each time the service cannot be executed, click on Add error in the Business Errors section of the service's instance page. There are two options when adding an Error to a service:

Add new error
Add existing error

Regarding already existing errors, a list of all the errors that have been created in a project 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 service.

Delete services

You can delete a service by clicking the Delete service button in the upper right corner of the service instance page. Alternatively, you can use the Delete capability of each table row on the Services tab of a domain namespace's Overview page.