Skip to Content

Wiki source code of Queue custom event

Show last authors
1 {{figure image="queue_task_en.png" clear ="h1"}}
2 Configuration interface for actions of type //Queue custom event//.
3 {{/figure}}
4
5 This endpoint allows to process the actions of a [[custom event>>Formcycle.Designer.Workflow.Events.Custom]]. It can be specified whether the actions should be executed immediately, or only after other waiting events have been processed.
6
7 == Parameters ==
8
9 ; Event to invoke
10 : Selection of a custom event already existing in the current workflow, which will be triggered after the endpoint has been reached.
11 ; Run only after pending processing chains have finished
12 : If this option is enabled, the selected event will be triggered only after the processing of the other processing chains has been completed.
13
14 == Action variables ==
15
16 Actions of type //Queue custom event// provide [[Action variables>>Formcycle.UserInterface.Variables||anchor="HActionvariables"]] which can be used in subsequent actions.
17
18 === Standard action variables ===
19
20 ; [%$<action name>.SUCCESS%]
21 : Return whether action was successfully executed. Returns Boolean (true/false).
22 ; [%$<action name>.RESULT%]
23 : Return all results provided by the action in structured form.
24
25 ; [%$<action name>.ERROR_CODE%]
26 : The error code thrown in case of an error in the action. Empty if no error occurred.
27 ; [%$<action name>.ERROR_MESSAGE%]
28 : The thrown error message in the action's error case. Empty if no error occurred.
29
30 === Action specific action variables ===
31
32 ; [%$<actionname>.ERROR.message%]
33 : Error message returned if the processing chain referenced by the workflow event could not be executed or the workflow event could not be found.