The Flow Module block

The Flow Module block references a flow from your workspace and outputs the flow's result. This powerful block enables you to use the logic of multiple other flows in your current flow. By accepting input data and referencing other flows, Flow Module blocks can work like code functions.

Suppose you have two flows: flow A and flow B. Flow A checks the availability of meeting rooms in your office based on input data such as location, time, and room preference. It then outputs whether a room is available. Flow B can use a Flow Module block to send input data to flow A and retrieve its result (room availability), then use that result in its own logic (for example, to decide to send an API call that reserves the room).

The Flow Module block can reference any flow in your workspace that has at least one snapshot. Snapshots are saved versions of a flow. To learn more, see Version flows with snapshots.

Inputs

By default, the Flow Module block has one Run input port and one input port for each input present in the Start block of the modular flow. When the Run port receives data, it triggers the Flow Module block. If it's not connected, the Flow Module block will trigger when its host flow runs.

If the referenced flow has a Start block with inputs, the Flow Module block will also have input ports that correspond with the Start block's inputs. For example, if a Flow Module block references a flow with three inputs defined in its Start block, the Flow Module block will have three input ports with the same names and data types as the Start block's inputs. Data sent to the Flow Module block's input ports will be passed to the corresponding Start block inputs in the referenced flow.

When the referenced flow has Start block inputs, the Flow Module block must receive data in each of its corresponding input ports to trigger the referenced flow.

Outputs

The Flow Module block has one output port for each input port in the referenced flow's Output block. Each output port sends the value received by its corresponding input port in the referenced flow's Output block.

The Flow Module block also has a Done output port that sends a boolean true signal when the referenced flow has completed.

Setup

When you add a Flow Module block, it prompts you to select a flow to reference. The Flow Module block can only reference flows in your workspace that have one or more snapshots.

To set up a Flow Module block, do the following:

1. Create a flow and add a Flow Module block. A list of flows you can reference appears.

   If the list is empty, make sure the flow you want to reference has at least one snapshot.

2. Select a flow from the list. The Flow Module block appears with the same title as the referenced flow. The latest snapshot number appears next to the title. When a newer version of the snapshot is available, the Snapshots icon turns purple.

Select a different snapshot

When you add a Flow Module block, it automatically selects the latest snapshot of the referenced flow. To select a different snapshot, do the following:

1. In the Flow Module block, select Snapshots.

2. Select a snapshot from the dropdown list. The Flow Module block will use the selected snapshot of the referenced flow.

Related blocks

• Start
• Output