Data Warehouse Center Application Integration Guide

VWPProgramInstanceParameter.tag

Use this template to add or change a parameter that the Data Warehouse Center passes to an instance of a Data Warehouse Center program for a specific step. For example, you set a default value for a host name parameter in the VWPProgramTemplateParameter.tag file (see page "VWPProgramTemplateParameter.tag"). You use this template to change the value that is passed to the Data Warehouse Center program when this particular step runs.

This template is required if the Data Warehouse Center program requires the Data Warehouse Center to pass parameters to it. You can specify that the Data Warehouse Center pass multiple parameters to the program by including this template for each parameter.

The template also defines the relationship between the parameter and its program instance.

Tokens

Table 46 provides information about each token in the template.

Table 46. VWPProgramInstanceParameter.tag tokens

Token	Description	Allowed values
Entity parameters
*VWPProgramInstanceParameterName	The unique name or description of a parameter that is to be passed to a Data Warehouse Center program. This token is required.	A text string, up to 80 bytes in length.
*VWPProgramInstanceParameterOrder	A number, starting with 0, that indicates the order of the parameter in the parameter list. This token is required.	A numeric value.
*VWPProgramInstanceParameterData	The data that is passed to the Data Warehouse Center program as the value of the parameter. This token is required.	A text string or a numeric value up to 240 bytes in length.
*VWPProgramInstanceParameterKey	A key that uniquely identifies this program parameter instance. The key must be unique from all other parameter keys in the interchange file. Tip: Finish processing the VWPProgramInstanceParameter.tag template before increasing the value of the key. This token is required.	A text value, up to 10 bytes in length.
*VWPProgramInstanceParameterType	The type of value that this parameter contains. For example, character, numeric, or password data.	One of the following values: ISV_ParameterTypeNone The parameter type is unknown or not applicable. ISV_ParameterTypeCharacter The parameter type is character. ISV_ParameterTypeNumeric The parameter type is numeric. ISV_ParameterTypePassword The parameter type is password.
Relationship parameters
*VWPProgramInstanceKey	A key that uniquely identifies this program instance. The key must be unique from all other keys in the interchange file. Tip: Finish processing the VWPProgramInstance.tag template before increasing the value of the key. This token is required.	A text value, up to 10 bytes in length
*CurrentCheckPointID++	An index, starting with 0, that increases each time that it is substituted in a token. This token is required.	A numeric value.

Examples of values

The following table provides example values for each token to illustrate the kind of metadata that you might provide for each token.

Table 47. Example values for VWPProgramInstanceParameter.tag tokens

Token	Example value
*VWPProgramInstanceParameterName	DB2 UDB user ID
*VWPProgramInstanceKey	070000
*VWPProgramInstanceParameterOrder++	1
*VWPProgramInstanceParameterData	my_userid
*VWPProgramInstanceParameterKey	012994
*VWPProgramInstanceParameterType	ISV_ParameterTypeNumeric
*VWPProgramInstanceKey	070001
*CurrentCheckPointID++	12