Data Warehouse Center Application Integration Guide

PROPERTY

Defines a property that belongs to an object type.

This tag is required following these ACTION tags:

:ACTION.OBJTYPE(ADD)

:ACTION.OBJTYPE(MERGE)

:ACTION.OBJTYPE(APPEND)

Syntax

:PROPERTY.EXTNAME(ext_name) DT(data_type) DL(data_length) SHRTNAME(short_name) NULLS(Y | N) UUISEQ(UUI_number)

Context

Figure 69. Using the PROPERTY tag when adding object types

:ACTION.OBJTYPE(ADD) :OBJECT.TYPE() CATEGORY() EXTNAME() PHYNAME() ICOFILE() ICWFILE() :PROPERTY.EXTNAME() DT() DL() SHRTNAME() NULLS() UUISEQ()

Figure 70. Using the PROPERTY tag when merging object types

:ACTION.OBJTYPE(MERGE) :OBJECT.TYPE() CATEGORY() EXTNAME() PHYNAME() ICOFILE() ICWFILE() :PROPERTY.EXTNAME() DT() DL() SHRTNAME() NULLS() UUISEQ()

Figure 71. Using the PROPERTY tag when adding properties to object types

:ACTION.OBJTYPE(APPEND) :OBJECT.TYPE() :PROPERTY.EXTNAME() DT() DL() SHRTNAME() NULLS() UUISEQ()

Keywords

EXTNAME

Specifies a descriptive name for the property.

Required keyword.

ext_name

Specifies an extended descriptive name.

The maximum length of ext_name is 80 characters. The ext_name must be unique within the object type. ext_name is stored in mixed case.

DT

Specifies the data type for the property.

Required keyword.

data_type

The data type for the property. You can specify this value in either uppercase or lowercase. Valid values are:

C

Character

V

Variable character

L

Long variable character

T

Timestamp

DL

Specifies the data length or maximum data length for the property.

Required property.

data_length

The data length or maximum data length for the property. Valid values for data_length depend on the data_type that is defined for this property:

data_type

Maximum value for data_length

C (character)

Maximum length is 254

V (variable character)

Maximum length is 4000

L (long variable character)

Maximum length is 32700

T (timestamp)

Always 26 characters

SHRTNAME

Specifies the property short name.

Required keyword.

short_name

The short name for the property. The short_name value can be up to 8 characters long. This value can contain only SBCS characters.

This value is stored as uppercase characters; any lowercase characters are converted to uppercase.

This value can start with the characters A - Z, @, #, or $, and can contain any of these characters, plus 0 - 9 and _. No leading blanks or embedded blanks are allowed.

This value cannot be any of the SQL reserved words for the database that is used for the information catalog. Do not specify the property short names of the following required properties for every Information Catalog Manager object type: OBJTYPID, INSTIDNT, UPDATIME, or UPDATEBY.

NULLS

Specifies whether a value for the property is required for every object. This value can be specified in uppercase or lowercase.

Required keyword.

Y indicates that this value can be null. When appending a new property with the ACTION.OBJTYPE(APPEND) tag, you must specify NULLS(Y), because appended properties must be optional.

N indicates that a value for this property is required. If no data exists for a required property when an object is added to the information catalog, a not-applicable symbol is entered for the required value for data types of CHAR, VARCHAR, and LONG VARCHAR. For a required value with a data type of TIMESTAMP, the following value is entered: 9999-12-31-24.00.00.000000

UUISEQ

Identifies the properties that are used in the UUI.

Optional keyword; the default value is 0. The UUISEQ keyword is optional for properties that are not part of the UUI. The UUI is a set of properties that are defined by the administrator as the key that uniquely identifies each object.

UUI_number

Specifies the position of the property in the UUI sequence. Valid values are 0, 1, 2, 3, 4, and 5. The value 0 means that the property is not part of the UUI. A nonzero value for UUI_number indicates that the property is part of the UUI.

All object types defined in the tag language file must have at least one property that is part of the UUI. The UUI can consist of up to 5 properties.

At least one property must be defined as part of the UUI.

When assigning UUI_number values to more than one property, the numbers of the UUI properties must range from 1 to the number of properties in the UUI. For example, if three properties are defined as part of the UUI, the UUI_number values must be 1, 2, and 3. You cannot skip numbers in the sequence. The UUI_number values do not need to be in the same order that the properties are specified.

Rules

• You can define the reserved property NAME as part of the UUI when you add a new object type or merge object types. Figure 72 shows the general syntax for identifying NAME as a UUI property.

  Figure 72. Example of specifying the NAME property as part of the UUI
  

  :ACTION.OBJTYPE(ADD) :OBJECT.TYPE() CATEGORY() EXTNAME() PHYNAME() ICOFILE() ICWFILE() :PROPERTY.SHRTNAME(NAME) UUISEQ()

  Empty parentheses in this figure denote values that you must provide in a tag language file.

• The maximum length of the UUI fields is 254 bytes.