Variables Tab

Use the Variables tab to assign substitution variables for selection criteria or SQL statements in an Access Definition. Additionally, you can use any defined variables when creating Extract or Restore Archive Actions.

For detailed information about selection criteria, SQL, or Archive Actions, refer to Table Specifications.

By assigning variables, you provide values for the variables each time the Access Definition is processed. As an option, you can provide default values for substitution variables. The variables are saved with the Access Definition.

Note: You can also specify or override variables (programatically or in batch) referenced in an Archive, Extract, or Restore Request using the command line interface. For detailed information about the command line interface, refer to the Archive User Manual or the Move User Manual .
access definition editor variables tab showing variable names, default values and prompt strings

Name

Enter a name for the variable (1 to 12 characters). The name is embedded in the selection criteria or SQL. Logical naming conventions help identify variables.

Default

Enter an optional default value for the variable to be used when no value is specified for the variable at run time.

Default values must be of the appropriate data type and size for the column and must conform to SQL syntax. For example, assume a variable name is ST (state), the variable delimiter is a colon ( : ), and the column requires character data.

Note: Default values are not validated until run time. If a value is the incorrect data type or size for the column or does not conform to SQL syntax, processing errors may result.

Prompt String

Enter the text that prompts for the variable value at run time. Type the prompt string exactly as you want it to appear in the process request dialog (up to 50 characters). This prompt is displayed before you execute the request.