Configuration of events
An example is used to explain how mail creation can be configured when saving and changing company data.
(1) New, Delete, Edit, Cancel: Event treatments can be created, deleted and edited.
(2) Search: Search and reset the search.
(3) List: Definitions found
Begin test: The test functionality can be called via this button. See Tests.
New and Edit opens the following editing view:
(1) New, Delete, Edit, Cancel: The event handling can be created, deleted, copied and stored in the database.
(2) Owner: The owner of the event handling.
(3) Name: Event handling name.
(4) Description: Free text to briefly describe what this event handling should do.
(5) Priority: Event handlings are executed in descending order according to their priority. I.e. a handling with priority 1000 is executed before a handling with priority 900.
(6) Enabled: Only when this checkbox is selected, this event definition is checked in the system.
(7) Rule matching: Specifies the moment in time a rule is to be checked.
On arrival of the event: The rule is checked even before the event is handled. If a higher priority event handling manipulates the affected object, this is not taken into account in the rule check.
Prior to execution: The rule is checked before the treatment is to be executed according to its priority. If a higher priority event handling manipulates the affected object, this will be taken into account during the rule check.
(8) Event actions: To edit the triggering events, the rule and the event actions, you can switch to this tab.
Editing event actions
Event handlings are configured by using a workflow graph.
The configuration is shown both in the outline (2) and on the right side as a directed graph (1). The outline provides a more compact overview of the configuration.
Triggering events are displayed in area (3).
The Validating rule can be edited in area (4) with the Rule editor.
In area (5), the actions triggered when the set of rules from (4) returns the value 'true' are configured.
There is also a search function in the outline (2):
Triggering event configuration
When you click on (1), a selection menu (2) is displayed, which categorizes the possible triggering events.
To remove an existing triggering event, click on the delete icon (3) for the corresponding event.
Rule set configuration
Here we refer to the documentation of the Rule editor.
Actions on passed rule configuration
Clicking on (1) displays a selection menu with the possible event actions (2).
Clicking on one of the 'Plus' buttons (3) of an existing event action can also call up the menu for adding an action.
An existing event action can be removed with a click on (4). Cutting and copying is also possible.
This menu also provides the help for the event action.
Access values
There are some subroutines (e.g. rules or actions) that expect parameters. These parameters can usually be specified statically or as value resolver. Such value resolvers can, as the name suggests, resolve values dynamically.
For example, the "Object field" value resolver can be used to access the field of an object directly.
Descriptions
Descriptions can be added to rules and actions of the event handling. This function can be accessed via the menu icon of the respective action or rule, under the item #Description.
For better clarity, described rules or actions can be recognized by a small red triangle in the upper right corner (2). In addition, the description is displayed as soon as the mouse cursor is positioned over the corresponding display field (1).
Labels
In addition to descriptions, labels can also be added to event handling actions. This function can be reached in the same way via the menu icon under the item #Description.
The label will then alternatively appear under the action name when the action is visible in the collapsed view.
