Input and Output Variable properties

Input and Output Variables define the data that a script receives and returns. Specify variable names, data types, and optional descriptions when modeling a script.

Input Variables represent the incoming payload that a script processes. When a script runs or is tested, the payload is assigned to the declared Input Variable name and can be referenced in the script code.

Output Variables represent the result that the script returns from the scripting activity step in the data flow.

Note:  ION Scripting does not validate whether declared Input Variables or Output Variables are used in the code or whether their data types match the implementation.

Variable names

Input Variable names and Output Variable names must follow Python variable naming conventions.

  • Variable names can be any length.
  • Use uppercase letters (A–Z), lowercase letters (a–z), digits (0–9), and the underscore character (_).
  • A variable name can contain digits but cannot begin with a digit.
  • An Input Variable name and an Output Variable name must not be the same.
  • Variable names are case-sensitive. Do not define two variables with the same name by using different letter cases.

Variable data types

Specify a data type for each Input Variable and Output Variable.

Select one of these data types:

  • String
  • Integer
  • Number
  • Boolean
  • Binary

When you create a new variable, the default data type is String.

Defining Input and Output Variable properties

To define Input 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 Variable name, data type, and optional description in the Input Variable tab.
  5. Click Add to specify the Output Variable name, data type, and optional description in the Output Variable tab.
  6. Click Update.