Variables Tab, Archive Request Editor

Use this tab to create variables with default values for the Access Definition.

Selection criteria define a subset of related data from the list of tables in the Access Definition. This subset of data is copied to the Archive File. You can define explicit selection criteria in the Access Definition, or create variables with default values that can be overridden by values specified on the Variables tab in the Archive Request Editor. You can also choose to be prompted for values at runtime.

Note: The Variables tab is available only if the Access Definition required in the Archive Request includes substitution variables. To define variables, click Tools > Edit Access Definition from the menu.

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

Archive Request Editor with Variables as the active tab. The elements of the Variables tab are described as follows.

Grid Details

Information for each variable in the Access Definition is presented in three parts on the grid. The name of the variable 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 used as criteria displays in the bottom.

Variable
The list of variables defined in the Access Definition. The name of the variable displays in italics, unless the default value is overridden by a value 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 from the menu.
Prompt String
Text that prompts for the value at run time. You can modify the prompt string only in the Access Definition Editor. To open the Access Definition Editor, click Tools > Edit Access Definition from the menu.
Value
The value assigned to the variable. You can right-click and select Set Default Value to use the values assigned as defaults in the Access Definition.
Note: A value for each variable is required to perform the Archive 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 SQL syntax.

For example, assume a variable named ST is assigned to a character column containing state abbreviations. The variable delimiter is a colon. If the variable is defined with single quotes in the Access Definition, you must specify the value without single quotes on the Variables tab:

Access Definition Value
= ':ST' CA

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

Access Definition Value
= :ST 'CA'
Note: Values are not validated until run time. Errors during processing may 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 Archive Process is performed, regardless of whether a value has been assigned. Clear the check box to display the prompt string only when a value for a variable has not been assigned.