1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
|
.. task:: Confirm
Confirm task
------------
This :ref:`wait task <task-type-wait>` blocks a workflow until a user
confirms that the workflow can continue.
Users who can confirm are either the creator of the work request/parent
workflow, or owners of the workspace.
This task is equivalent to a confirmation prompt in a traditional user
interface.
The ``task_data`` for this task may contain the following keys:
* ``auto_confirm_if_no_failure`` (boolean, defaults to False): when this
parameter is set, the wait task is immediately marked as successful if all
its dependencies are successful. It is useful to generate a confirmation
prompt only when something has gone wrong and we want to offer the
possibility to recover from it, instead of aborting the rest of the
dependency chain.
* ``deny_action`` (string, defaults to 'abort-workflow'): allowed values are
'fail', 'abort', 'abort-workflow'. For 'fail', the wait work request is
completed with result set to FAILURE. For 'abort', the wait work request
is "terminated" with status set to ABORTED. For 'abort-workflow', the root
workflow is aborted.
* ``confirm_label`` (string, defaults to "Continue the workflow"): the label
to show in the "Confirm" button
* ``deny_label`` (string, defaults to "Abort the workflow"): the label to
show in the "Deny" button.
|
