Workflow output parameters

Improve collaboration and streamline workflow reusability by creating output schemas for your workflows. The output schema consists of parameters that clearly define the workflow output data structure once the workflow is executed. To create an output schema add parameters directly to the workflow Exit operator. You also have the option to convert the Exit operator to JSON mode to create a raw JSON output.

Create an output schema

The workflow has a single output schema that is enforced on all Exit operators other than the ones that were converted to JSON mode.

1. To add a parameter to the workflow output schema, add it to an Exit operator in the workflow (see the image above).
   Specify the following information for each parameter:
   • Type: the parameter data type. The default is Short text.
   • Name: the parameter name can be used to reference it in the parent workflow context.
   • Description: (optional) a short description of the parameter.
2. Update the parameter value in any other Exit operators in the workflow. You can use the output Event Preview tab for your convenience. These are the default values according to the parameter type:
   • Short/Long text: empty string
   • JSON: empty
   • Number: 0
   • Boolean: false
   • File: empty

Use the output schema of a nested workflow

The output schema of a nested workflow is available for reference without having to execute it. Design the parent workflow based on what you know you can expect from the output of the nested workflow.

JSON mode

Convert a specific Exit operator to JSON mode to have the workflow output schema not apply to it. When using JSON mode you can provide raw JSON as the output.

1. Select Convert to JSON in the Exit operator properties.
   
2. Select Convert.
3. The Exit operator icon is changed to indicate JSON mode.