Set Flow Output Data
  • 28 Nov 2022
  • 2 Minutes to read
  • Dark
    Light

Set Flow Output Data

  • Dark
    Light

Article Summary

Overview

Like Flow Input Data is configured on the Start step to pass data into a Flow, Flow Output Data can be configured to pass data out of a Flow. This data can be reached in another Flow or via an API call.

The following document demonstrates how to set Output Data and use it as Input for a separate Flow. 



Set Flow Output Value 

The Set Flow Output Value step can be used with the same functionality as mapping Output Data on the End step, except this step ensures that data is always sent as an output when a Flow is called via API. This allows the service to return data regardless of what happens inside the Flow. This step can be found in the Flow Designer Step Catalog and configured the same way in the following example.



Example

This example will walk through Flow Output Data in another Flow and via a GET URL. 

  1. Select the CREATE FLOW button from a Designer Project from the top Action bar.
    1. Select Flow, provide a Name, then click CREATE
  2. Connect the Start step to the End step.
  3. Select the End to step to navigate to its Properties tab. 
    1. Under DATA > Output, select SHOW EDITOR
  4. From the Data Definitions window, configure two String [Text] Type Data Definitions; one with the Name "Name", and one named "Email Address". 
    1. Constant map an Input value for each then click CLOSE
  5. Save the Flow. 



Output Data Via API

  1. From the Flow Designer, click the Configure Integration link.
  2. Under SETTINGS > Integration Type, select API Service.
  3. Click the VIEW button. 
    Selecting the View button will open the Integration Details for the Flow in a separate window. 

  4. Scroll down to Call via GET and click Execute GET Request
    Selecting the Execute GET Request button will display the Output data's Constant mapped values. 



Output Data Via Flow

  1. From a Designer Project, CREATE a new Flow via the CREATE FLOW button in the top Action bar. 
  2. From the FAVORITE STEPS category of the Toolbox tab, attach a Run Sub Flow step to the Start step. 
  3. Select the Sub Flow step to navigate to its Properties tab.
    1. Select PICK OR CREATE FLOW, then PICK the Flow used in the initial example. 
      Selecting this Flow should add the pre-existing Flow as a Sub Flow with the same Output Data as previously configured. 
  4. Attach a Show Form step from FAVORITE STEPS to the Run Sub Flow step. 
  5. Navigate to the Show Form step's Properties tab and select PICK OR CREATE FORM, then CREATE a new Form
  6. Design a Form that contains two Text Box components and a Button; then, Save and close the Form with X
    Name and Label the Text Boxes: "Name" and "Email Address"; these boxes will act as recipients of the Output data from the Sub Flow.

    Label the Button component "OK".

  7. Connect the Show Form step to the End step. 
  8. From the Show Form step's Properties tab, map each respective Output from the Sub Flow to the Form step. 
  9. Save the Flow, then close if desired. 

Debug

  1. From the Flow Designer, select the Debug link. 
  2. Click START DEBUGGING.
    Debugging the Flow will run the Flow and display the Output Data of the Sub Flow in the Form. 
  3. Click the OK button.
  4. View the Input/Output Data on the Form step. 
    The Input/Output Data shows that the Output from the Sub Flow being used as the Input of the Form, and in turn being Output by the Form. 


Was this article helpful?

What's Next