<varList> Element

The <varList> element is an optional child of the <executionPlan> element and the <inlineSubplan> step. For information about the latter element, see <inlineSubplan> Step. The <varList> element is used to declare a list of variables for use by the steps contained in the plan and any components they reference. The values of the variables are defined at the point of declaration, and cannot be redefined. If specified, this element can only appear one time.

The <varList> element has one required child element, <var>, which is a plan variable declaration. A declaration includes a name and a value. Specify a <var> element for each variable that you want to declare.

<var> Element

The <var> element is a child of the plan <varList> element and is used to declare a plan variable including name and value.

Attributes for the <var> Element

This element has the following attributes:

• name – A required attribute of type identifier, which is the name of the local variable. The name must be unique among every variable in the containing <varList>. Variables associated with the top-level <executionPlan> must also be unique among the plan parameters.

• default – A required attribute that is a string that is the default value of the plan variable. This value can include references to other plan variables that have been declared earlier, to session variables, and to plan parameters. If this plan is a simple plan, you can include references to target host attributes and to installed component variables.