Data Warehouse Center Application Integration Guide

Table.tag

You can use this template to define both source and target tables as well as source files and segments that Data Warehouse Center is to access. You can use this template to define source and target tables, files, and segments.

The template defines all the metadata that the Data Warehouse Center requires to define a table in an ODBC data source as well as a DB2 target table. The template also defines the relationships between the table and the database that contains the table.

Tokens

Table 42 provides information about each token in the template.

Table 42. Table.tag tokens

Token Description Allowed values
Entity parameters
*TableFullName The fully qualified name of a relational table or a file.
For a table, this name is the concatenation of the value of the *TableOwner and *TablePhysicalName tokens, separated by a period.
For a file, the *TableOwner value should be left blank, and the *TableFullName and *TablePhysicalName values should be the same.
The name must be unique within the warehouse control database.
This token is required.
A text string, up to 80 bytes in length.
*TableDescription The short description of the table.
This token is optional.
A text string, up to 254 bytes in length.
*TableNotes The long description of the table.
This token is optional.
A text string, up to 32700 bytes in length.
*TableOwner The owner, high-level qualifier, collection, or schema of the table.
This token is required.
A text string, up to 15 bytes in length.
*TablePhysicalName The physical table name as defined to the database manager or file system.
This token is required.
A text string, up to 80 bytes in length.
*TableBinaryIfFile A flag that specifies whether the file contains only binary data if the table represents a file.
This token is optional.
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.

*TableFirstRowNamesIfFile A flag that specifies whether the first row of the file contains column names if the table represents a file.
This token is optional.
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.
*TableTypeIfFile The type of file if the table represents a file.
This token is optional.
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.

*TableDelimiterIfFile The value of the delimiter to separate fields if the file type is ISV_DR_CHAR_DELIMITED.
This token is optional.
A text string, 1 byte in length.
*TableIsAView
A token that specifies whether the table is a view. One of the following values:

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

*TableIsADimensionTable
A token that specifies whether the table is a part of a star schema and contains dimensional data. One of the following values:

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

*TableIsAnAlias
A token that specifies whether the table is actually an alias of another table. 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.

*TableCreatedByDWC
A token that specifies whether the Data Warehouse Center should create and manage this table. 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.

*TableGrantedToPublic
A token that specifies whether the Data Warehouse Center should grant public access to this table when the table is created. This is only valid if the Data Warehouse Center creates the table. One of the following values:

ISV_GrantTableAccessToPublic
The Data Warehouse Center is to grant PUBLIC access to this table.
ISV_DoNotGrantTableAccessToPublic
The Data Warehouse Center is not to grant PUBLIC access to this table.

*TableIsPersistent
A token that specifies whether the data in the table is to persist between executions of the steps that use this table. If the table is not persistent, the data in the table will be deleted after each use. One of the following values:

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

*TableMaximumEditions
The maximum number of editions the table is to have, if the table supports editions. A numeric value.
*TableGenerateCreateStatement
A token that specifies whether the Data Warehouse Center is to generate the create table statement. 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.

*TableIsAFactTable
A token that specifies whether the table is part of a star schema, and the table contains the fact information. One of the following values:

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

*TableCreateStatement
The DDL to create the table.
Use this token only if the ISV_DoNotGenerateCreateTableStmt has been specified.
A text string.
Relationship parameters
*DatabaseName The name of the database that contains the table.
The name must be unique within the warehouse control database.
This token is required.
A text string, up to 80 bytes in length.
*DatabasePhysicalName The physical database name of the database that contains the table.
This token is required.
A text string, up to 40 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.

Token	Description	Allowed values
Entity parameters
`*TableFullName`	The fully qualified name of a relational table or a file. For a table, this name is the concatenation of the value of the `TableOwner` and `TablePhysicalName` tokens, separated by a period. For a file, the `TableOwner` value should be left blank, and the `TableFullName` and `*TablePhysicalName` values should be the same. The name must be unique within the warehouse control database. This token is required.	A text string, up to 80 bytes in length.
`*TableDescription`	The short description of the table. This token is optional.	A text string, up to 254 bytes in length.
`*TableNotes`	The long description of the table. This token is optional.	A text string, up to 32700 bytes in length.
`*TableOwner`	The owner, high-level qualifier, collection, or schema of the table. This token is required.	A text string, up to 15 bytes in length.
`*TablePhysicalName`	The physical table name as defined to the database manager or file system. This token is required.	A text string, up to 80 bytes in length.
`*TableBinaryIfFile`	A flag that specifies whether the file contains only binary data if the table represents a file. This token is optional.	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.
`*TableFirstRowNamesIfFile`	A flag that specifies whether the first row of the file contains column names if the table represents a file. This token is optional.	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.
`*TableTypeIfFile`	The type of file if the table represents a file. This token is optional.	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`.
`*TableDelimiterIfFile`	The value of the delimiter to separate fields if the file type is ISV_DR_CHAR_DELIMITED. This token is optional.	A text string, 1 byte in length.
`*TableIsAView`	A token that specifies whether the table is a view.	One of the following values: ISV_TableIsAView The table is a view. ISV_TableIsNotAView The table is not a view.
`*TableIsADimensionTable`	A token that specifies whether the table is a part of a star schema and contains dimensional data.	One of the following values: ISV_TableIsADimensionalTable The table is a dimensional table. ISV_TableIsNotADimensionalTable The table is not a dimensional table.
`*TableIsAnAlias`	A token that specifies whether the table is actually an alias of another table.	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.
`*TableCreatedByDWC`	A token that specifies whether the Data Warehouse Center should create and manage this table.	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.
`*TableGrantedToPublic`	A token that specifies whether the Data Warehouse Center should grant public access to this table when the table is created. This is only valid if the Data Warehouse Center creates the table.	One of the following values: ISV_GrantTableAccessToPublic The Data Warehouse Center is to grant PUBLIC access to this table. ISV_DoNotGrantTableAccessToPublic The Data Warehouse Center is not to grant PUBLIC access to this table.
`*TableIsPersistent`	A token that specifies whether the data in the table is to persist between executions of the steps that use this table. If the table is not persistent, the data in the table will be deleted after each use.	One of the following values: ISV_TableIsPersistent The table is to be considered persistent. ISV_TableIsTransient The table is to be considered transient.
`*TableMaximumEditions`	The maximum number of editions the table is to have, if the table supports editions.	A numeric value.
`*TableGenerateCreateStatement`	A token that specifies whether the Data Warehouse Center is to generate the create table statement.	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.
`*TableIsAFactTable`	A token that specifies whether the table is part of a star schema, and the table contains the fact information.	One of the following values: ISV_TableIsAFactTable The table is a fact table. ISV_TableIsNotAFactTable The table is not a fact table.
`*TableCreateStatement`	The DDL to create the table. Use this token only if the ISV_DoNotGenerateCreateTableStmt has been specified.	A text string.
Relationship parameters
`*DatabaseName`	The name of the database that contains the table. The name must be unique within the warehouse control database. This token is required.	A text string, up to 80 bytes in length.
`*DatabasePhysicalName`	The physical database name of the database that contains the table. This token is required.	A text string, up to 40 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 43 provides examples of values for each token to illustrate the kind of metadata that you might provide for each token.

Table 43. Example values for Table.tag tokens

Token Example value
*TableFullName DB2ADMIN.GEOGRAPHY
*TableDescription Contains geography information
*TableNotes This table contains all the information about geographies serviced by our company
*TableOwner DB2ADMIN
*TablePhysicalName GEOGRAPHY
*TableBinaryIfFile ISV_DEFAULTVALUE
*TableFirstRowNamesIfFile ISV_DEFAULTVALUE
*TableTypeIfFile ISV_DEFAULTVALUE
*TableDelimiterIfFile ISV_DEFAULTVALUE
*TableIsAView
ISV_TableIsAView
*TableIsADimensionTable
ISV_TableIsNotADimensionTable
*TableIsAnAlias
ISV_TableIsAnAlias
*TableCreatedByDWC
ISV_TableIsToBeCreatedByDWC
*TableGrantedToPublic
ISV_GrantTableAccessToPublic
*TableIsPersistent
ISV_TableIsTransient
*TableMaximumEditions
12
*TableGenerateCreateStatement
ISV_GenerateCreateTableStmt
*TableIsAFactTable
ISV_TableIsAFactTable
*TableCreateStatement
Create table xyz
*DatabaseName Finance warehouse
*DatabasePhysicalName FINANCE
*CurrentCheckPointID++ 7

Token	Example value
`*TableFullName`	DB2ADMIN.GEOGRAPHY
`*TableDescription`	Contains geography information
`*TableNotes`	This table contains all the information about geographies serviced by our company
`*TableOwner`	DB2ADMIN
`*TablePhysicalName`	GEOGRAPHY
`*TableBinaryIfFile`	ISV_DEFAULTVALUE
`*TableFirstRowNamesIfFile`	ISV_DEFAULTVALUE
`*TableTypeIfFile`	ISV_DEFAULTVALUE
`*TableDelimiterIfFile`	ISV_DEFAULTVALUE
`*TableIsAView`	ISV_TableIsAView
`*TableIsADimensionTable`	ISV_TableIsNotADimensionTable
`*TableIsAnAlias`	ISV_TableIsAnAlias
`*TableCreatedByDWC`	ISV_TableIsToBeCreatedByDWC
`*TableGrantedToPublic`	ISV_GrantTableAccessToPublic
`*TableIsPersistent`	ISV_TableIsTransient
`*TableMaximumEditions`	12
`*TableGenerateCreateStatement`	ISV_GenerateCreateTableStmt
`*TableIsAFactTable`	ISV_TableIsAFactTable
`*TableCreateStatement`	Create table xyz
`*DatabaseName`	Finance warehouse
`*DatabasePhysicalName`	FINANCE
`*CurrentCheckPointID++`	7

[ Top of Page | Previous Page | Next Page ]