Use this template to define a Data Warehouse Center program. This template is required if the tag language file refers to a Data Warehouse Center program, unless the warehouse program already exists in the Data Warehouse Center control database.
The template also defines the relationship between the warehouse program definition and the Data Warehouse Center program group to which the program belongs.
Table 48 provides information about each token in the
template.
Table 48. VWPProgramTemplate.tag tokens
Token | Description | Allowed values |
---|---|---|
Entity parameters | ||
*VWPProgramTemplateName | The name of the Data Warehouse Center program template.
The name must be unique within the warehouse control database. This token is required. | A text string, up to 80 bytes in length. |
*VWPProgramTemplateDescription | The short description of the Data Warehouse Center program and what it
does.
This token is optional. | A text string, up to 254 bytes in length. |
*VWPProgramTemplateNotes | The long description of the Data Warehouse Center program and what it
does.
This token is optional. | A text string, up to 32700 bytes in length. |
*VWPProgramTemplateExecutableName | The fully qualified program name of the Data Warehouse Center program
that is to run when the step runs.
If the Data Warehouse Center program is installed in the system path, the warehouse program name need not be fully qualified. This token is required. | A text string, up to 240 bytes in length. |
*VWPProgramTemplateType | The type of program.
This token is required. | One of the following values:
|
ISV_PROGRAMTYPECOMMAND
The Data Warehouse Center program is a command file. | ||
ISV_PROGRAMTYPEEXECUTABLE
The Data Warehouse Center program is an executable file. | ||
*VWPProgramTemplateFunctionName | The name of the entry point in the DLL that the Data Warehouse Center is
to invoke if the value of *VWPProgramTemplateType is
ISV_PROGRAMTYPEDLL.
This token is required if the value of *VWPProgramTemplateType is ISV_PROGRAMTYPEDLL. | A text string, up to 80 bytes in length. |
Relationship parameters | ||
*VWPGroup | The name of the group that is to contain the Data Warehouse Center
program.
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. |
*AgentSite | The agent site to use for the source or target.
This token is required. | A text string, up to 80 bytes in length.
Specify ISV_DEFAULTAGENTSITE for the default agent site. |
Table 49 provides example values for each token to illustrate the
kind of metadata that you might provide for each token.
Table 49. Example values for VWPProgramTemplate.tag tokens
Token | Example value |
---|---|
*VWPProgramTemplateName | My ISV program |
*VWPProgramTemplateDescription | This program exports data from an ODBC database. |
*VWPProgramTemplateNotes | This program will export data from an ODBC database, process it, and place it into another database. |
*VWPProgramTemplateExecutableName | c:\ISV\BIN\MYPROG.EXE |
*VWPProgramTemplateType | ISV_PROGRAMTYPEEXECUTABLE |
*VWPProgramTemplateFunctionName | My_Prog_Func_Name |
*VWPGroup | Group of programs for partner tool |
*CurrentCheckPointID++ | 3 |