Data Warehouse Center Application Integration Guide

Column.tag

Use this template to define a column in a table, or a field in a segment or file. You can use this template to define columns or fields for both sources and targets.

The template defines the relationship between the column or field and the table, segment, or file that contains the column or field. You must include this template if you defined sources or targets by using the Table.tag template (see page "Table.tag").

Tokens

Table 16 provides information about each token in the template.

Table 16. Column.tag tokens

Token	Description	Allowed values
Entity parameters
*ColumnName	The name of the column or field. The name must be unique within a table or field. This token is required.	A text string, up to 80 bytes in length.
*ColumnDescription	The short description of the column or field. This token is optional.	A text string, up to 254 bytes in length.
*ColumnNotes	The long description of the column or field. This token is optional.	A text string, up to 32700 bytes in length.
*ColumnOffsetFromZero	The offset in bytes from the start of the file to where the data for this field starts.	A numeric value or 0.
*ColumnOrdinalNumber	The ordinal position of the column. Usually the same as the *ColumnPositionNumber.	A numeric value or 0.
*ColumnUserActions	The actions that a user can perform on this column or field. This token is optional.	A text string, up to 254 bytes in length.
*ColumnLength	The length of the column or field being created. This token is required.	A numeric value.
*ColumnPrecision	The precision of the column or field for columns or fields with a decimal data type. This token is required.	A numeric value or 0.
*ColumnKeyPosition	If this column is part of a key, the column's position within the key. This token is required.	A numeric value. If there is no precision value, specify 0.
*ColumnPositionNumber	A number, starting with 0, that indicates the order of the column within the row. This token is required.	A numeric value.
*ColumnAllowsNulls	A flag that specifies whether the column or field allows null data. This token is required.	One of the following values: ISV_NULLSYES The column allows null data. ISV_NULLSNO The column does not allow null data.
*ColumnDataIsText	A flag that specifies whether the column or field contains only text data for character types. This token is required.	One of the following values: ISV_ISTEXTYES The column contains only text data. ISV_ISTEXTNO The column does not contain only text data.
*ColumnEditionType	Identifies whether the column holds Data Warehouse Center edition information.	One of the following values: ISV_ColumnIsEditionColumn The column is an edition column. ISV_ColumnIsNormal The column is a normal column.
*ColumnNativeDataType	The data type of the column or field as defined to the database manager or file system. This token is required.	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
*ColumnNativeDataType (continued)	The data type of the column or field as defined to the database manager or file system. This token is required.	One of the following values: 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 ISV_NATIVE_VARBINARY ISV_NATIVE_LONGVARBINARY ISV_NATIVE_BIT ISV_NATIVE_IMAGE ISV_NATIVE_SERIAL ISV_NATIVE_DBCLOB ISV_NATIVE_BIGINT
	ISV_NATIVE_DATETIMEYEARTOFRACTION
Relationship parameters
*CurrentCheckPointID++	An index, starting with 0, that increases each time it is substituted in a token. This token is required.	A numeric value.
*DatabaseName	The business name of the warehouse source or warehouse target. This token is required.	A text string, up to 40 bytes in length.
*TablePhysicalName	The physical name of the table or file that contains the column as defined to the database manager or file system. This token is required.	A text string, up to 80 bytes in length.
*TableOwner	The owner, high-level qualifier, collection, or schema of the table that contains the column. This token is required.	A text string, up to 15 bytes in length.
*CurrentCheckPointID++	An index, starting with 0, that increases each time it is substituted in a token. This token is required.	A numeric value.

Examples of values

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

Table 17. Example values for Column.tag tokens

Token	Example value
*ColumnName	Country_code
*ColumnDescription	This column contains the country code
*ColumnNotes	The valid values for this column can be found in the Geography reference manual
*ColumnOffsetFromZero	0
*ColumnOrdinalNumber	0
*ColumnUserActions	User cannot directly view a single column
*ColumnLength	10
*ColumnPrecision	0
*ColumnKeyPosition	0
*ColumnAllowsNulls	ISV_NULLSNO
*ColumnDataIsText	ISV_ISTEXTYES
*ColumnNativeDataType	ISV_NATIVE_CHAR
*DatabasePhysicalName	FINANCE
*TableOwner	DB2ADMIN
*TablePhysicalName	GEOGRAPHY
*CurrentCheckPointID++	8