Create the structure of scenario inputs or outputs
Before using inputs or outputs, you need to define their structure. When creating the input structure, you can set any parameter as required, which allows you to validate the structure of the input data.
You can also add a description to each input parameter to document the data the parameter contains.
You can add inputs and outputs anytime.
In the editor, click the inputs and outputs icon.
Select the Scenario inputs or Scenario outputs tab and click Add item.
Enter a value in the Name field. This field is mandatory.
You can't use spaces or special characters in the name. You can use letters, numbers, and the underscore symbol. You can only start with a letter or underscore.
In the Type field, select the data type of the item from the dropdown menu.
- If you use the type Select, add options for the dropdown selection in the Options field.
- If you use the type Array, set the type of the array items in the nested Type field.
- If you use the type Collection, you can set the structure of the collection in the Specification field. validates the input data against the specification. If you keep the Specification empty, will accept any collection for the input data.
- If you use the type Dynamic collection, you can map a collection or a JSON string to the output field. The Return output module parses the JSON and returns it as output bundles. You can use the Create JSON module to create a custom data output.
Optional: In the Description field, add information about the input or output item. For example, how is the item used in the or what information the item contains.
Optional: In the Default field, enter the default value that is used if the value is missing in the original input.
Under Required, select whether this input is required or not to start your .
If you have required inputs, your scheduling type must be On demand. For more information, see the scheduling a scenario article.
Under Multi-line, select how you want your text to be displayed if you selected Text, Array, Collection or JSON as the item data type.
Selecting Yes shows multiple lines of text. Selecting No shows only one line of text.
Repeat the process if you need to add more items.
Click Save in the Scenario inputs box and save your .
You can use the inputs and outputs as mappable values in your . You can find them under the Variables tab in the mapping dialog.
To use outputs, you need to add the Scenarios > Return output module. Check the next section.