Run process flow shape

Introduction

The run 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 flow shape to call another flow with that data.

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 flow shape you have the option to add a manual payload - in this case, your manual payload will be sent into the called process flow.

The run flow shape also allows you to choose whether any variables associated with the called process flow should be applied.

Need to know

  • 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.

  • A process flow can be called irrespective of whether it's enabled and/or deployed.

  • 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 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 that you want to use here.

Step 3 Choose the required version of your selected process flow to run:

By default, the latest version is selected but ALL versions are available for selection, irrespective or deployment status.

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 supplied payload field:

The manual payload can be any format - JSON, XML, plain text, etc.

Step 6 Save the shape.

Last updated