Variables tab

Selection criteria define the subset of related data to extract from the list of tables in the Access Definition. You can define explicit selection criteria in the Access Definition, or create variables with default values that can be overridden by values that are specified on the Variables tab in the Extract Request Editor. You can also choose to be prompted for values at run time.

The flexibility that is provided by using variables allows you to use the same Access Definition for different processes.

Example of the Variables tab on Extract Request Editor

Grid details

Information for each variable in the Access Definition is presented in three parts on the grid. The variable name is shown in the left column. The grid cell in the right column is divided in two. The prompt string for the variable displays in the top half of the cell and the value that is used as criteria displays in the bottom.

Variable
The list of variables that are defined in the Access Definition. The name of the variable displays in italics, unless the default value is overridden by a value that is entered on the Variables tab. You can modify the name of the variable in the Access Definition Editor only. To open the Access Definition Editor, click Tools > Edit Access Definition.
Prompt String
Text that prompts for a value at run time. You can modify the prompt string in the Access Definition Editor only. To open the Access Definition Editor, click Tools > Edit Access Definition.
Value
The value that is assigned to the variable. You can right-click and select Set Default Value to use the values that are assigned as defaults in the Access Definition.
Note: A value for each variable is required to do the Extract Process. If a default value is not specified in the Access Definition and no value is provided on the Variables tab, you are prompted for a value at run time.

Specify Values

Assigned values must be the appropriate data type and size for the column and must conform to the SQL syntax. For example, assume a variable that is named ST is assigned to a character column that contains state abbreviations. The variable delimiter is a colon. If the variable is defined with single quotation marks in the Access Definition, you must specify the value without single quotation marks on the Variables tab:

Access Definition Value
':ST' CA

If the variable is defined without single quotation marks in the Access Definition, you must specify the value with single quotation marks on the Variables tab:

Access Definition Value
:ST 'CA'
Note: Values are not validated until run time. Errors during processing might result if the value is an incorrect data type or size for the column, or the resulting specification does not conform to SQL syntax.

Always Prompt for Values at Run Time

Select the Always Prompt for Values at Run Time check box to display the prompt string before each Extract Process is performed, regardless of whether a value was assigned. Clear the check box to display the prompt string only when a value for a variable was not assigned.



Feedback