Run process flow shape
Introduction
The run process flow shape is used to call one process flow from another, so you can run process flows in a chain. For example, you might have a process flow that receives data from a webhook, applies filters and then hits a run process flow shape to call another flow with that data.
The default behaviour is for the payload from the end of the calling process flow to be sent into the called process flow for onward processing. However, when configuring a run process flow shape you can add a manual payload - in this case, your manual payload will be sent into the called process flow.
The run process flow shape also allows you to choose whether any variables associated with the called process flow should be applied.
Need to know
A called process flow will only run if it is enabled.
A called process flow is always added to your run queue for processing - even if the parent flow is triggered manually.
A called process flow does NOT inherit the queue priority of its parent - you should set the priority of these process flows individually.
If you don't configure a manual payload in the run process flow shape, the final payload from the calling process flow is always sent into the called process flow.
If multiple payloads are passed into the run process flow shape, the called process flow will run once for each payload - these runs take place in parallel.
When a payload is passed to a 'child' process flow, meta variables are included.
You cannot create a recursive process flow loop - for example, if Process Flow A calls Process Flow B, you cannot then call Process Flow A from Process Flow B.
Adding & configuring a run flow shape
Step 1 In your process flow, add the run process flow shape in the usual way:
Step 2 Click in the flow field and select the process flow that you want to run:
If you have a lot of process flows, you can search for the one you want to use here.
If you select a process flow that is not enabled, an error will be displayed when you attempt to save these settings. In this case, you should access the process flow you want to call and enable it, then come back to save this shape.
Step 3 Move down to the settings section and choose which version of the selected process flow to call:
Available options are summarised below:
Latest deployed version
Always run the latest deployed version of this process flow. So, if the called process flow is edited and re-deployed at any point, the latest deployed version will always be called.
Latest draft version
Always run the latest draft version of this process flow. So, if the called process flow is edited at any point, the latest edited (draft) version will always be called.
Specific version
Select a version from the dropdown list. With this approach, keep in mind that this version is always called - do if you update this process flow subsequently, you will NOT be running the latest draft or deployed version.
Step 4 If your selected process flow is associated with any process variables, these are shown - you can choose to enable or disable these:
Step 5 If you want to pass a manual payload into this process flow, toggle the specify payload manually option ON and paste the required payload into the supplied payload field:
The manual payload can be any format - JSON, XML, plain text, etc.
Step 6 Save the shape. The configured shape is added to the canvas with the sub-flow available as a link - for example:
Click this link to open the sub-flow in a new browser tab.
Last updated
