Data Warehouse Center Application Integration Guide

Appendixes

Appendix A. Template planning worksheet

Use this worksheet to collect the values that your partner application needs to provide.

Write the value of the token in the table. For tokens that have a specific list of allowed values, circle one of the allowed values.

Table 128. Tokens for required metadata in the templates

Token Value
*AgentSite
*AgentSiteContact
*AgentSiteDescription
*AgentSiteNotes
*AgentSiteOSType One of the following values:

ISV_windowsNT
Windows NT
ISV_AIX
AIX
ISV_os2
OS/2
ISV_as400
AS/400
ISV_Solaris
SUN
ISV_MVS
MVS

*AgentSiteTCPIPHostName
*AgentSiteUserid
*ColumnAllowsNulls One of the following values:

ISV_NULLSYES
The column allows null data.
ISV_NULLSNO
The column does not allow null data.

*ColumnDataIsText One of the following values:

ISV_ISTEXTYES
The column contains only text data.
ISV_ISTEXTNO
The column does not contain only text data.

*ColumnDescription
*ColumnEditionType One of the following values:

ISV_ColumnIsEditionColumn
The column is an edition column.
ISV_ColumnIsNormal
The column is a normal column.

*ColumnKeyPosition
*ColumnLength
*ColumnName
*ColumnNativeDataType
One of the following values:

ISV_NATIVE_CHAR
ISV_NATIVE_VARCHAR
ISV_NATIVE_LONGVARCHAR
ISV_NATIVE_VARCHAR2
ISV_NATIVE_GRAPHIC
ISV_NATIVE_VARGRAPHIC
ISV_NATIVE_LONGVARGRAPHIC
ISV_NATIVE_CLOB
ISV_NATIVE_INT
ISV_NATIVE_TINYINT
ISV_NATIVE_BLOB
ISV_NATIVE_SMALLINT
ISV_NATIVE_INTEGER
ISV_NATIVE_FLOAT
ISV_NATIVE_SMALLFLOAT
ISV_NATIVE_DOUBLE
ISV_NATIVE_REAL
ISV_NATIVE_DECIMAL
ISV_NATIVE_SMALLMONEY
ISV_NATIVE_MONEY
ISV_NATIVE_NUMBER
ISV_NATIVE_NUMERIC
ISV_NATIVE_DATE
ISV_NATIVE_TIME
ISV_NATIVE_TIMESTAMP
ISV_NATIVE_LONG
ISV_NATIVE_RAW
ISV_NATIVE_LONGRAW
ISV_NATIVE_DATETIME
ISV_NATIVE_SMALLDATETIME
ISV_NATIVE_SYSNAME
ISV_NATIVE_TEXT
ISV_NATIVE_BINARY

*ColumnNativeDataType (continued)
One of the following values:

ISV_NATIVE_VARBINARY
ISV_NATIVE_LONGVARBINARY
ISV_NATIVE_BIT
ISV_NATIVE_IMAGE
ISV_NATIVE_SERIAL
ISV_NATIVE_DATETIMEYEARTOFRACTION
ISV_NATIVE_DBCLOB
ISV_NATIVE_BIGINT

*ColumnNotes
*ColumnOffsetFromZero
*ColumnOrdinalNumber
*ColumnPositionNumber
*ColumnPrecision
*ColumnUserActions
*CurrentCheckPointID++
*DatabaseContact
*DatabaseDescription
*DatabaseName
*DatabaseNotes
*DatabasePhysicalName
*DatabaseType One of the following values:

ISV_IR_DB2Family
DB2 Family
ISV_IR_Oracle
Oracle
ISV_IR_Sybase
Sybase
ISV_IR_MSSQLServer
Microsoft SQLServer
ISV_IR_Informix
Informix
ISV_IR_GenericODBC
Generic ODBC
ISV_IR_FFLan
Flat File LAN
ISV_IR_VSAM
VSAM
ISV_IR_IMS
IMS

*DatabaseTypeExtended One of the following values:

ISV_IR_DB2400CISC
DB2 UDB for AS/400^(R) for CISC
ISV_IR_DB2400RISC
DB2 UDB for AS/400 for RISC
ISV_IR_FFLanLocalCmd
Local flat file
ISV_IR_FFLanFTPCopy
Local flat file sent using FTP from a remote system

*DatabaseServerName
*DatabaseUserid
*DatabaseVersion
*PostStepName
*ProcessContact
*ProcessDescription
*ProcessName
*ProcessNotes
*ProcessType One of the following values:

ISV_ProcessType_Normal
Process is a normal user process.
ISV_ProcessType_Meta_pub
Process is a metadata publication process.
ISV_ProcessType_Notify
Process is a notification process.

*SecurityGroup ISV_DEFAULTSECURITYGROUP
*StarSchemaContact
*StarSchemaDBName
*StarSchemaDescription
*StarSchemaName
*StarSchemaNotes
*StepCommit One of the following values:

ISV_Step_Incremental_Commit_On
The data is to be incrementaly commited at the target.
ISV_Step_Incremental_Commit_Off
The data is not to be incrementaly commited at the target.

*StepCommitAfterNumberRows
*StepContact
*StepDataNotPresent One of the following values:

ISV_StepDataNotPresent_OK
If data is not present, continue processing.
ISV_StepDataNotPresent_Warning
If data is not present, issue a warning and continue processing.
ISV_StepDataNotPresent_Error
If data is not present, issue an error message and stop processing.

*StepDescription
*StepExternalPopulation One of the following values:

ISV_StepExternalNo
The table will not be externally populated by other means.
ISV_StepExternalYes
The table will be externally populated by other means.

*StepName
*StepNotes
*StepSelectStatement
*StepSelectStatementGenerated One of the following values:

ISV_StepSelectStatementNo
The SELECT statement is not generated, but is included in the *StepSelectStatement.
ISV_StepSelectStatementYes
The SELECT statement is generated, and *StepSelectStatement is ignored.

*StepSQLWarning One of the following values:

ISV_StepSQLWarning_OK
If an SQL warning occurs, continue processing.
ISV_StepSQLWarning_Warning
If an SQL warning occurs, issue a warning and continue processing.
ISV_StepSQLWarning_Error
If an SQL warning occurs, issue an error and stop processing.

*StepType One of the following values:

ISV_StepType_Editioned_Append
The data in the table will be appended when the Step is run.
ISV_StepType_Full_Replace
The data in the table will be replaced when the Step is run.
ISV_StepType_Uneditioned_Append
The data in the table will be appended when the Step is run.
ISV_StepType_VWP_Population
The data in the table is populated by a Data Warehouse Center program.

*SubjectArea
*SubjectAreaContact
*SubjectAreaDescription
*SubjectAreaNotes
*TableBinaryIfFile One of the following values:

ISV_DR_FILE_IS_BINARY
The file is binary.
ISV_DR_FILE_IS_NOT_BINARY
The file is in ASCII or mixed format.

*TableCreatedByDWC One of the following values:

ISV_TableIsToBeCreatedByDWC
The table is to be created by the Data Warehouse Center.
ISV_TableIsNotToBeCreatedByDWC
The table is not to be created by the Data Warehouse Center.

*TableCreateStatement
*TableDelimiterIfFile
*TableDescription
*TableFirstRowNamesIfFile One of the following values:

ISV_DR_ROW_CONTAINS_NAMES
The first row of the file contains column names.

ISV_DR_ROW_DOES_NOT_CONTAIN_NAMES
The first row of the file contains data.
*TableFullName
*TableGenerateCreateStatement One of the following values:

ISV_GenerateCreateTableStmt
The Data Warehouse Center should generate the CREATE TABLE statement.
ISV_DoNotGenerateCreateTableStmt
The Data Warehouse Center should not generate the CREATE TABLE statement.

*TableGrantedToPublic One of the following values:

ISV_GrantTableAccessToPublic
Grant PUBLIC access to this table.
ISV_DoNotGrantTableAccessToPublic
Do not grant PUBLIC access to this table.

*TableIsAnAlias One of the following values:

ISV_TableIsAnAlias
This table is an alias for another table.
ISV_TableIsNotAnAlias
This table is not an alias for another table.

*TableIsADimensionTable One of the following values:

ISV_TableIsADimensionalTable
The table is a dimensional table.
ISV_TableIsNotADimensionalTable
The table is not a dimensional table.

*TableIsAFactTable One of the following values:

ISV_TableIsAFactTable
The table is a fact table.
ISV_TableIsNotAFactTable
The table is not a fact table.

*TableIsAView One of the following values:

ISV_TableIsAView
The table is a view.
ISV_TableIsNotAView
The table is not a view.

*TableIsPersistent One of the following values:

ISV_TableIsPersistent
The table is to be considered persistent.
ISV_TableIsTransient
The table is to be considered transient.

*TableMaximumEditions
*TableNotes
*TableOwner
*TablePhysicalName
*TableTypeIfFile One of the following values:

ISV_DR_REL_TABLE
The table is a relational table.
ISV_DR_COMMA_DELIMITED
The columns in the file are separated by commas.
ISV_DR_FIXED_FORMAT
The columns in the file are in fixed format.
ISV_DR_TAB_DELIMITED
The columns in the file are separated by tabs.
ISV_DR_CHAR_DELIMITED
The columns in the file are separated by the value of *TableDelimiterIfFile.

*VWPGroup
*VWPGroupDescription
*VWPGroupNotes
*VWPProgramInstanceKey
*VWPProgramInstanceParameterData
*VWPProgramInstanceParameterKey
*VWPProgramInstanceParameterName
*VWPProgramInstanceParameterOrder
*VWPProgramInstanceParameterType One of the following values:

ISV_ParameterTypeNone
The parameter type is unknown.
ISV_ParameterTypeCharacter
The parameter type is character.
ISV_ParameterTypeNumeric
The parameter type is numeric.
ISV_ParameterTypePassword
The parameter type is password.

*VWPProgramTemplateDescription
*VWPProgramTemplateExecutableName
*VWPProgramTemplateFunctionName
*VWPProgramTemplateName
*VWPProgramTemplateNotes
*VWPProgramTemplateType One of the following values:

ISV_PROGRAMTYPEDLL
The Data Warehouse Center program is loaded from a dynamic link library (DLL) or is a load module.
ISV_PROGRAMTYPECOMMAND
The Data Warehouse Center program is a command file.
ISV_PROGRAMTYPEEXECUTABLE
The Data Warehouse Center program is an executable file.

*VWPProgramTemplateParameterData
*VWPProgramTemplateParameterKey
*VWPProgramTemplateParameterName
*VWPProgramTemplateParameterOrder
*VWPProgramTemplateParameterType One of the following values:

ISV_ParameterTypeNone
The parameter type is unknown.
ISV_ParameterTypeCharacter
The parameter type is character.
ISV_ParameterTypeNumeric
The parameter type is numeric.
ISV_ParameterTypePassword
The parameter type is password.

Token	Value
`*AgentSite`
`*AgentSiteContact`
`*AgentSiteDescription`
`*AgentSiteNotes`
`*AgentSiteOSType`	One of the following values: ISV_windowsNT Windows NT ISV_AIX AIX ISV_os2 OS/2 ISV_as400 AS/400 ISV_Solaris SUN ISV_MVS MVS
`*AgentSiteTCPIPHostName`
`*AgentSiteUserid`
`*ColumnAllowsNulls`	One of the following values: ISV_NULLSYES The column allows null data. ISV_NULLSNO The column does not allow null data.
`*ColumnDataIsText`	One of the following values: ISV_ISTEXTYES The column contains only text data. ISV_ISTEXTNO The column does not contain only text data.
`*ColumnDescription`
`*ColumnEditionType`	One of the following values: ISV_ColumnIsEditionColumn The column is an edition column. ISV_ColumnIsNormal The column is a normal column.
`*ColumnKeyPosition`
`*ColumnLength`
`*ColumnName`
`*ColumnNativeDataType`	One of the following values: ISV_NATIVE_CHAR ISV_NATIVE_VARCHAR ISV_NATIVE_LONGVARCHAR ISV_NATIVE_VARCHAR2 ISV_NATIVE_GRAPHIC ISV_NATIVE_VARGRAPHIC ISV_NATIVE_LONGVARGRAPHIC ISV_NATIVE_CLOB ISV_NATIVE_INT ISV_NATIVE_TINYINT ISV_NATIVE_BLOB ISV_NATIVE_SMALLINT ISV_NATIVE_INTEGER ISV_NATIVE_FLOAT ISV_NATIVE_SMALLFLOAT ISV_NATIVE_DOUBLE ISV_NATIVE_REAL ISV_NATIVE_DECIMAL ISV_NATIVE_SMALLMONEY ISV_NATIVE_MONEY ISV_NATIVE_NUMBER ISV_NATIVE_NUMERIC ISV_NATIVE_DATE ISV_NATIVE_TIME ISV_NATIVE_TIMESTAMP ISV_NATIVE_LONG ISV_NATIVE_RAW ISV_NATIVE_LONGRAW ISV_NATIVE_DATETIME ISV_NATIVE_SMALLDATETIME ISV_NATIVE_SYSNAME ISV_NATIVE_TEXT ISV_NATIVE_BINARY
`*ColumnNativeDataType` (continued)	One of the following values: ISV_NATIVE_VARBINARY ISV_NATIVE_LONGVARBINARY ISV_NATIVE_BIT ISV_NATIVE_IMAGE ISV_NATIVE_SERIAL ISV_NATIVE_DATETIMEYEARTOFRACTION ISV_NATIVE_DBCLOB ISV_NATIVE_BIGINT
`*ColumnNotes`
`*ColumnOffsetFromZero`
`*ColumnOrdinalNumber`
`*ColumnPositionNumber`
`*ColumnPrecision`
`*ColumnUserActions`
`*CurrentCheckPointID++`
`*DatabaseContact`
`*DatabaseDescription`
`*DatabaseName`
`*DatabaseNotes`
`*DatabasePhysicalName`
`*DatabaseType`	One of the following values: ISV_IR_DB2Family DB2 Family ISV_IR_Oracle Oracle ISV_IR_Sybase Sybase ISV_IR_MSSQLServer Microsoft SQLServer ISV_IR_Informix Informix ISV_IR_GenericODBC Generic ODBC ISV_IR_FFLan Flat File LAN ISV_IR_VSAM VSAM ISV_IR_IMS IMS
`*DatabaseTypeExtended`	One of the following values: ISV_IR_DB2400CISC DB2 UDB for AS/400^(R) for CISC ISV_IR_DB2400RISC DB2 UDB for AS/400 for RISC ISV_IR_FFLanLocalCmd Local flat file ISV_IR_FFLanFTPCopy Local flat file sent using FTP from a remote system
`*DatabaseServerName`
`*DatabaseUserid`
`*DatabaseVersion`
`*PostStepName`
`*ProcessContact`
`*ProcessDescription`
`*ProcessName`
`*ProcessNotes`
`*ProcessType`	One of the following values: ISV_ProcessType_Normal Process is a normal user process. ISV_ProcessType_Meta_pub Process is a metadata publication process. ISV_ProcessType_Notify Process is a notification process.
`*SecurityGroup`	`ISV_DEFAULTSECURITYGROUP`
`*StarSchemaContact`
`*StarSchemaDBName`
`*StarSchemaDescription`
`*StarSchemaName`
`*StarSchemaNotes`
`*StepCommit`	One of the following values: ISV_Step_Incremental_Commit_On The data is to be incrementaly commited at the target. ISV_Step_Incremental_Commit_Off The data is not to be incrementaly commited at the target.
`*StepCommitAfterNumberRows`
`*StepContact`
`*StepDataNotPresent`	One of the following values: ISV_StepDataNotPresent_OK If data is not present, continue processing. ISV_StepDataNotPresent_Warning If data is not present, issue a warning and continue processing. ISV_StepDataNotPresent_Error If data is not present, issue an error message and stop processing.
`*StepDescription`
`*StepExternalPopulation`	One of the following values: ISV_StepExternalNo The table will not be externally populated by other means. ISV_StepExternalYes The table will be externally populated by other means.
`*StepName`
`*StepNotes`
`*StepSelectStatement`
`*StepSelectStatementGenerated`	One of the following values: ISV_StepSelectStatementNo The SELECT statement is not generated, but is included in the `StepSelectStatement.` ISV_StepSelectStatementYes* The SELECT statement is generated, and `*StepSelectStatement` is ignored.
`*StepSQLWarning`	One of the following values: ISV_StepSQLWarning_OK If an SQL warning occurs, continue processing. ISV_StepSQLWarning_Warning If an SQL warning occurs, issue a warning and continue processing. ISV_StepSQLWarning_Error If an SQL warning occurs, issue an error and stop processing.
`*StepType`	One of the following values: ISV_StepType_Editioned_Append The data in the table will be appended when the Step is run. ISV_StepType_Full_Replace The data in the table will be replaced when the Step is run. ISV_StepType_Uneditioned_Append The data in the table will be appended when the Step is run. ISV_StepType_VWP_Population The data in the table is populated by a Data Warehouse Center program.
`*SubjectArea`
`*SubjectAreaContact`
`*SubjectAreaDescription`
`*SubjectAreaNotes`
`*TableBinaryIfFile`	One of the following values: ISV_DR_FILE_IS_BINARY The file is binary. ISV_DR_FILE_IS_NOT_BINARY The file is in ASCII or mixed format.
`*TableCreatedByDWC`	One of the following values: ISV_TableIsToBeCreatedByDWC The table is to be created by the Data Warehouse Center. ISV_TableIsNotToBeCreatedByDWC The table is not to be created by the Data Warehouse Center.
`*TableCreateStatement`
`*TableDelimiterIfFile`
`*TableDescription`
`*TableFirstRowNamesIfFile`	One of the following values: ISV_DR_ROW_CONTAINS_NAMES The first row of the file contains column names.
ISV_DR_ROW_DOES_NOT_CONTAIN_NAMES The first row of the file contains data.
`*TableFullName`
`*TableGenerateCreateStatement`	One of the following values: ISV_GenerateCreateTableStmt The Data Warehouse Center should generate the CREATE TABLE statement. ISV_DoNotGenerateCreateTableStmt The Data Warehouse Center should not generate the CREATE TABLE statement.
`*TableGrantedToPublic`	One of the following values: ISV_GrantTableAccessToPublic Grant PUBLIC access to this table. ISV_DoNotGrantTableAccessToPublic Do not grant PUBLIC access to this table.
`*TableIsAnAlias`	One of the following values: ISV_TableIsAnAlias This table is an alias for another table. ISV_TableIsNotAnAlias This table is not an alias for another table.
`*TableIsADimensionTable`	One of the following values: ISV_TableIsADimensionalTable The table is a dimensional table. ISV_TableIsNotADimensionalTable The table is not a dimensional table.
`*TableIsAFactTable`	One of the following values: ISV_TableIsAFactTable The table is a fact table. ISV_TableIsNotAFactTable The table is not a fact table.
`*TableIsAView`	One of the following values: ISV_TableIsAView The table is a view. ISV_TableIsNotAView The table is not a view.
`*TableIsPersistent`	One of the following values: ISV_TableIsPersistent The table is to be considered persistent. ISV_TableIsTransient The table is to be considered transient.
`*TableMaximumEditions`
`*TableNotes`
`*TableOwner`
`*TablePhysicalName`
`*TableTypeIfFile`	One of the following values: ISV_DR_REL_TABLE The table is a relational table. ISV_DR_COMMA_DELIMITED The columns in the file are separated by commas. ISV_DR_FIXED_FORMAT The columns in the file are in fixed format. ISV_DR_TAB_DELIMITED The columns in the file are separated by tabs. ISV_DR_CHAR_DELIMITED The columns in the file are separated by the value of `*TableDelimiterIfFile`.
`*VWPGroup`
`*VWPGroupDescription`
`*VWPGroupNotes`
`*VWPProgramInstanceKey`
`*VWPProgramInstanceParameterData`
`*VWPProgramInstanceParameterKey`
`*VWPProgramInstanceParameterName`
`*VWPProgramInstanceParameterOrder`
`*VWPProgramInstanceParameterType`	One of the following values: ISV_ParameterTypeNone The parameter type is unknown. ISV_ParameterTypeCharacter The parameter type is character. ISV_ParameterTypeNumeric The parameter type is numeric. ISV_ParameterTypePassword The parameter type is password.
`*VWPProgramTemplateDescription`
`*VWPProgramTemplateExecutableName`
`*VWPProgramTemplateFunctionName`
`*VWPProgramTemplateName`
`*VWPProgramTemplateNotes`
`*VWPProgramTemplateType`	One of the following values: ISV_PROGRAMTYPEDLL The Data Warehouse Center program is loaded from a dynamic link library (DLL) or is a load module. ISV_PROGRAMTYPECOMMAND The Data Warehouse Center program is a command file. ISV_PROGRAMTYPEEXECUTABLE The Data Warehouse Center program is an executable file.
`*VWPProgramTemplateParameterData`
`*VWPProgramTemplateParameterKey`
`*VWPProgramTemplateParameterName`
`*VWPProgramTemplateParameterOrder`
`*VWPProgramTemplateParameterType`	One of the following values: ISV_ParameterTypeNone The parameter type is unknown. ISV_ParameterTypeCharacter The parameter type is character. ISV_ParameterTypeNumeric The parameter type is numeric. ISV_ParameterTypePassword The parameter type is password.

[ Top of Page | Previous Page | Next Page ]