Use the InvokeFlow component

Invoke or call a flow that is available in Workflow Studio by using the InvokeFlow component of RPA Desktop Design Studio. Generate the context ID of the flow and use the ID in other flow designer components to get the execution status and output.

Before you begin

To understand more about flows in Workflow Studio, see Building flows.

Before you use any Flow Designer component, use the Connection Manager to make sure that you're connected to the instance. For more information about how to connect to an instance, Connect to an RPA Hub instance from RPA Desktop Design Studio.

Enable the client callable option on an RPA Hub flow or subflow. For more information, see Enable the client callable option on a flow or subflow in RPA Hub.

Role required: fd_read role. For more information on this role, see User access to Workflow Studio flows.

About this task

The InvokeFlow component returns the context ID of a flow in Workflow Studio so you can use it in other components. For example, you can use the context ID to get the execution status or the output of a flow.

Add the InvokeFlow component to get the context ID of a flow so other Flow Designer components can check its status or obtain its output. To get the context ID of a subflow, use the InvokeSubFlow component.

Procedure

1. In the Toolbox pane, navigate to ServiceNow > Flow Designer.
2. Drag the InvokeFlow component to the Design surface.
3. On the Design surface, select the Configure button of the InvokeFlow component to show the InvokeFlow dialog box.
4. In the Flow name field, enter a minimum of three characters to search and select Enter.

   A list of flows that start with the entered characters is shown from the connected ServiceNow instance.

   Important:

   You can view and select only those flows that have the application scope set to All application scopes. The application scope is set in the Accessible From field in your Workflow Studio instance. When the application scope of the flow is set as This application scope only, the flow isn't available in the drop-down list of the Flow name field.
5. Select the required flow from the search list.
6. Verify the input fields, and select OK.
7. Optional: Configure the properties of the InvokeFlow component.
   For more information, see Properties of the Flow Designer components.

   You can now connect the Context ID port to another Flow Designer component such as GetExecutionStatus or GetOutputs.

8. Optional: To test the component, in the Design tab, click Run.