Managing Events
Business events are used to inform the system that something has happened. They are meant to describe business occurrences and not technical. Additionally, they can trigger a change when they are caught by Agents (see Managing Agents). Events can be triggered cross aggregate and domain boundaries. Moreover, commands, services and agents can all throw events which in turn are published within an event topic (see Event Topics). Events are created by using the Create capability in the events overview page or when editing commands and services (see Editing a command and Editing a service).
Creating an event
Events are defined using the following master data:
| Property | Description |
| Local identifier |
This is the identifier (name) of the event. 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 events! 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 event.
This field is mandatory. |
| Short label |
This is used to give an even shorter description of the event.
This field is optional. |
| Topic |
These are the event topics in which the event is published. The possible options are all the event topics that were created in the infrastructure page. When no event topics were created, then there is only one option: “Default”.
This field is mandatory. |
| Notes |
This is long description of the event.
This field is optional. |
You can also use the Open after creation checkbox to open the event for further editing after saving.
Add event payload
It is possible to add an already existing entity or a create a new one and assign it as a payload to the event by using the Add payload entity or Create payload entity capability. To edit the properties of the payload entity, see section Defining Properties.
Editing an event
You can edit the master data of an event by using the Information capability and navigating to the section Master data and using the Edit master data capability or by using the inline or header Edit capability. For a description of the master data, see the section Create an event. The Local identifier cannot be changed. When editing the master data of an event, you can overwrite the values for label, short label, topic and Notes. The overwritten values are lost as soon as the editing action has been completed.
Deleting an event
You can delete an event by using the inline or header Delete capability in the events’ overview page. Alternativerly, 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 event is permanately deleted.