Managing Commands
Commands are used to either create a new instance or manipulate an already existing instance of a root entity. Only root entities can have commands. A command can be added by the instance page of a root entity by using the Add Command capability which is positioned in the Associated Commands at this Level section.
Creating a command
Select type of command
There are two types of commands:
| Type | Description |
| Factory command | This type of command will be used to create new instances of the root entity to which it is assigned. |
| Instance command | This type of command is used to manipulate the current state of a specific, already existing, instance of the root entity to which it is assigned. |
Add a command
Commands are defined using the following master data:
| Property | Description |
| Local identifier |
This is the identifier (name) of the command. 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 commands! 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 command. This field is mandatory. |
| Short label |
This is used to give an even shorter description of the command. This field is optional. |
| Notes |
This is long description of the command. This field is optional. |
Editing a command
Within the command instance page, which is accessed by using the link capability of the previously created command, it is possible to edit a command.
Edit master data
You edit the master data using the Information capability and navigating to the section Master data. For a description of the master data, see the section Creating a commandCreating New Entities. The Type and the Local identifier cannot be changed. When editing the master data of a command, 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 or a create a new one and assign it as an input entity to the command by using the Add input entity or Create input entity capability. To add and edit properties of the input entity, see section Properties.
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).
Add Events
There are two options when adding an event to a command: 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 command: 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.
Delete a command
You can delete a command by using the Delete capability in the Associate Commands at this Level section of the root entity’s overview page or by using the Detail View of a command. Alternativerly, you can use the Information capabilityto access the details view and there you can use the Delete capability.