Modules

Global variables

Create fixed values which can be accessed by text entry parameters from all modules.

Description

Create fixed values which can be accessed by text entry parameters from all modules. Use of global variables allows the same value to be used across multiple different modules without the need to explicitly type it. Global variables are accessed with the notation "V{[NAME]}", where "[NAME]" is replaced with the name of the relevant variable. Global variables can be used by any text or numeric parameter.

Parameters

Parameter Description
Add new variable Add a new global variable. Added variables can be removed using the "Remove" button.
Variable name Name of this variable. This is the name that will be used when referring to the variable in place of fixed values. To refer to variables, use the form "V{[VARIABLE_NAME]}", where "[VARIABLE_NAME]" is replaced by the variable name. For example, a variable called "my_var" would be referred to using the text "V{my_var}".
Variable type Controls how the variable is specified:
  • "Boolean" The output variable is assigned either "True" or "False" depending on whether the switch (specified with the "Variable Boolean" parameter) is enabled or disabled, respectively.
  • "Choice" Select the output variable from a pre-determined list of options (specified with the "Variable choices" parameter).
  • "File" Select a specific file on the computer for this variable using the "Variable file" parameter. The variable will be set to the full path to this file. Note: backslash characters will be escaped (i.e. "\" will appear as "\\").
  • "Folder" Select a specific folder on the computer for this variable using the "Variable folder" parameter. The variable will be set to the full path to this folder. Note: backslash characters will be escaped (i.e. "\" will appear as "\\").
  • "Text" Specify a fixed text value for this variable using the "Variable value" parameter.
Variable Boolean Boolean value for the corresponding global variable when "Variable type" is in "Boolean" mode.
Variable value Fixed value for the corresponding global variable when "Variable type" is in "Text" mode.
Variable file Fixed value file location for the corresponding global variable when "Variable type" is in "File" mode.
Variable folder Fixed value folder location for the corresponding global variable when "Variable type" is in "Folder" mode.
Variable choices When "Variable type" is set to "Choice" mode, these are the options that will be presented by the "Variable choice" drop-down parameter. Choices are specified as a comma-separated list.
Variable choice Pre-defined list of choices to select global variable value from when "Variable type" is in "Choice" mode.
Store as metadata item When selected, the variable will be stored as a metadata item. This allows it to be exported to the final spreadsheet.