Skip to content

Commit e5464b8

Browse files
authored
Small fixes to SubflowRef definition section (#363)
* Small fixes to SubflowRef definition section Signed-off-by: Tihomir Surdilovic <[email protected]> * fix typo Signed-off-by: Tihomir Surdilovic <[email protected]> * fix typo Signed-off-by: Tihomir Surdilovic <[email protected]>
1 parent 87428d6 commit e5464b8

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

specification.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2554,10 +2554,22 @@ to the trigger/produced event.
25542554

25552555
#### SubFlowRef Definition
25562556

2557+
`SubFlowRef` definition can have two types, either `string` or `object`.
2558+
If `string`, it defines the unique id of the sub-workflow to be invoked.
2559+
This can be used as a short-cut definition when you want to use the default value of the `waitForCompletion`,
2560+
which is set to `true`:
2561+
2562+
```json
2563+
"subFlowRef": "mySubFlowId"
2564+
```
2565+
2566+
If you need to define the `waitForCompletion` property value to `false`, you can use its
2567+
`object` type which has the following properties:
2568+
25572569
| Parameter | Description | Type | Required |
25582570
| --- | --- | --- | --- |
2559-
| waitForCompletion | If workflow execution must wait for sub-workflow to finish before continuing (default is `true`) | boolean | yes |
2560-
| workflowId |Sub-workflow unique id | boolean | no |
2571+
| workflowId | Unique id of the sub-workflow to be invoked | boolean | yes |
2572+
| waitForCompletion | If workflow execution must wait for sub-workflow to finish before continuing | boolean | no |
25612573

25622574
<details><summary><strong>Click to view example definition</strong></summary>
25632575
<p>
@@ -2589,6 +2601,8 @@ workflowId: handleApprovedVisaWorkflowID
25892601

25902602
</details>
25912603

2604+
The `workflowId` property defines the unique id of the sub-workflow to be invoked.
2605+
25922606
The `waitForCompletion` property defines if the SubFlow action should wait until the referenced reusable workflow
25932607
has completed its execution. If it's set to "true" (default value), SubFlow action execution must wait until the referenced workflow has completed its execution.
25942608
In this case the workflow data output of the referenced workflow will be used as the result data of the action.

0 commit comments

Comments
 (0)