Input and Output Variables properties

To process any incoming payload, you must declare the Input Variables and Output Variables names, data types and optionally description when modeling the script.

When a script executes in runtime, or when the script is tested, the incoming payload is assigned to the Input Variable name you have declared. You must use that variable name in your code to process the incoming payload.

The result of the script must be passed to the variable name that is declared in the Output Variable name field. This is the output generated from the scripting activity step in the data flows.

Note: ION Scripting does not validate and check if the declared Input and Output Variables are used in the code, either their data type.

Variables Names

Input Variables and Output Variables names must conform to Python variable naming convention.

The Input Variable or the Output Variable names can be any length. They can consist of uppercase and lowercase letters (A-Z, a-z), digits (0-9), and the underscore character (_). An additional restriction is that, although a variable name can contain digits, the first character of a variable name cannot be a digit.

The Input Variable and the Output Variable cannot have the same name.

The variables names are case insensitive, that means that you cannot specify two variables with the same name but different cases.

Variables Data Type

For every single Input an Output Variables you must specify their data type. You can select the data type from this list:

  • String
  • Integer
  • Number
  • Boolean
  • Binary

When defining new variables by default the 'String' data type is assigned to them.

To define the Input Variable and Output Variable properties:

  1. Expand the Scripts right panel.
  2. Expand the Input and Output section.
  3. Click Edit.
  4. Click Add to specify the Input Variables names, data types and optionally description in the Input Variable tab.
  5. Click Add to specify the Output Variables name, data types and optionally description in the Output Variable tab.
  6. Click Update.