Use the InvokeSubFlow component

  • Release version: Washingtondc
  • Updated February 1, 2024
  • 1 minute to read

    • The InvokeSubFlow component returns the context ID of a subflow 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 subflow.

    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, see 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 an RPA Hub flow or subflow.

    Role required: fd_read. For more information on this role, see User access to Flow Designer.

    About this task

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

    Procedure

    1. In the Toolbox pane, navigate to ServiceNow > Flow Designer.
    2. Drag the InvokeSubFlow component to the Design surface.
    3. On the Design surface, select the Configure button Configure icon. of the InvokeSubFlow component to show the InvokeSubFlow dialog box.
    4. Enter a minimum of three characters to search and select the subflow from the Subflow name field.
      Important:
      You can view and select only those subflows 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 subflow is set as This application scope only, the subflow isn’t available in the drop-down list of the Subflow name field.
    5. Verify the input fields, and select OK.
    6. Optional: Configure the properties of the InvokeSubFlow component.
      For more information, see Properties of the Flow Designer components.

      You can now connect the Context ID parameter with other Flow Designer components such as GetExecutionStatus or GetOutputs.

    7. Optional: To test the component, in the Design tab, select Run.