Data Warehouse Center Application Integration Guide

VWPProgramTemplateParameter.tag

Use this template to define a parameter that the Data Warehouse Center is to pass to a Data Warehouse Center program.

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

Use this template with the VWPProgramTemplate.tag file ("VWPProgramTemplate.tag"). This template defines the relationship between the parameter and its Data Warehouse Center program definition (VWPProgramTemplate.tag).

Tokens

Table 50 provides information about each token in the template.

Table 50. VWProgramTemplateParameter.tag tokens
Token Description Allowed values
Entity parameters
*VWPProgramTemplateParameterName The name or description of a parameter that is to be passed to a Data Warehouse Center program.

The name must be unique within the Data Warehouse Center program.

This token is required.

A text string, up to 80 bytes in length.
*VWPProgramTemplateParameterOrder A number, starting with 0, that indicates the order of the parameter in the parameter list.

This token is required.

A numeric value.
*VWPProgramTemplateParameterData 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.
*VWPProgramTemplateParameterKey A key that uniquely identifies this program parameter template. The key must be unique from all other keys in the interchange file.
Tip:Finish processing the VWPProgramTemplateParameter.tag template before increasing the value of the key.

This token is required.

A numeric value.
*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
*VWPProgramTemplateName The name of the Data Warehouse Center program that is to use this parameter.

This token is required.

A text string, up to 80 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

Table 51 provides example values for each token to illustrate the kind of metadata that you might provide for each token.

Table 51. Example values for VWPProgramTemplateParameter.tag tokens
Token Example value
*VWPProgramTemplateParameterName DB2 UDB user ID
*VWPProgramTemplateParameterOrder
1
*VWPProgramInstanceKey 070000
*VWPProgramTemplateParameterData my_userid
*VWPProgramTemplateParameterKey 012994
*VWPProgramInstanceParameterType
ISV_ParameterTypePassword
*VWPProgramTemplateName My ISV program
*CurrentCheckPointID++ 4


[ Top of Page | Previous Page | Next Page ]