The Subflow Control step executes once per record. Illustrated in the below image is an example of a flow of how the Subflow Control step is used.
Salesforce is used as a source step to populate data. The data is shown in the example below.
Fields from the dataset are being filtered using a Super Mapper and then stored in a Buffer (this is the buffer used as a source step in the subflow.) The Super Mapper step is shown in the image below.
Adding the Subflow Control step
To add a Subflow Control step in a flow, follow the below instructions:
1. Click on the highlighted icon as shown in the below image.
2. The below page will appear. Select or search for a Control step. Click on the Control tab and select Subflow as shown in the image below.
Configuring a Subflow Control step
Provide a title and description (optional). Once saved, open the control step to access more configuration options as shown in the image below.
The Swap Control Step field is used to swap to another Control step. The Subflow Control step can only be swapped with the ForEach Control step.
Using the Subflow Control Step
The Subflow step is added to a flow to process each element in the array. To configure the step, click on the highlighted icon in the below image.
The below page will appear. The Break on Error checkbox will break on any errors in the Subflow when selected. The Record by Reference section checkbox will pass the record by reference instead of creating a copy when selected.
Illustrated in the below image is the output in the Subflow.
Additional information
Returns
The options below let you define how you want the data to be returned from the Sub-flow. To access Returns, click on the Returns button as shown illustrated in the image below.
Return Type
Select the option type you want the Sub-flow value to be returned as one of the following:
None - No return. This is equivalent to void in traditional programming
Current - The default of the subflow being called
Array - Converts the output to an array
Object - Converts the output to an object
String - Converts the output to a string
Binary - Converts the output to a binary representation
Base64 - Converts the output to base64
Return Source
Selects what value types to return from the flow you are calling.
Auto - Auto detects the appropriate output
Record - Returns the current record processed by the subflow.
Output - Returns the output of the Writer Step (if any) in the subflow.
Result - Returns the output of the Destination Step (if any) in the subflow.