Data Warehouse Center Application Integration Guide

OBJECT

Defines the attributes for an object type or identifies an object type.

Context

This tag is required immediately following:

ACTION.OBJTYPE
ACTION.OBJINST

Syntax



:OBJECT.TYPE(type) CATEGORY(category) EXTNAME(ext_name)
         PHYNAME(table_name) ICOFILE( )
            ICWFILE(Windows_ICON_file_name)

Different OBJECT tag keywords are required or valid depending on the type of ACTION tag the OBJECT tag follows.

ACTION.OBJTYPE(ADD) or ACTION.OBJTYPE(MERGE)

Adding or merging object types

Context

Figure 59. Using the OBJECT tag when adding object types

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

Figure 60. Using the OBJECT tag when merging object types

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

Keywords

TYPE
Specifies the name of an object type.

Required keyword.

type
Defines and identifies the short name for a specific object type.

The value of type must be unique to an object type across all related information catalogs that contain the same object type. This ensures that objects of this object type can be shared among the related information catalogs. If the value of type already exists, it is used as a search argument.

The maximum length for the value is 8 characters. The value is stored in uppercase characters. 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.

After you create the object type, you cannot change the value of type.

CATEGORY
Specifies which category this object type belongs to.

Required keyword.

category
Specifies an Information Catalog Manager object category. This value can be one of the following:
GROUPING
ELEMENTAL
SUPPORT
CONTACT
DICTIONARY

You cannot specify PROGRAM or ATTACHMENT as the category for a new object type.

You cannot change the information on this keyword after the object type is defined.

EXTNAME
Specifies a longer, descriptive name for the object type. Required keyword.

ext_name
Specifies an extended, descriptive name for the object type. The maximum length for ext_name is 80 characters.

This name must be unique within related information catalogs.

The value of ext_name is stored in mixed case.

You can change the information on this keyword after the object type is defined.

PHYNAME
Specifies the name to use when creating the database table that contains information about this object type.

Optional keyword.

table_name
Specifies the name to use when creating the database table that contains object type information.

The maximum length of the name is defined when the Information Catalog Manager is installed. The table_name value must be unique within the information catalog and cannot contain any SQL reserved words.

By default, table_name is the type that is specified for the TYPE keyword. This value is not case sensitive; you can specify this value with uppercase or lowercase characters.

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.

After the table is created, you cannot change its name.

ICWFILE
Specifies the file that contains the Windows icon that is associated with the object type.

Optional keyword.

Windows_ICON_file_name
Specifies the name of the Windows icon file to associate with the object type. The maximum length of Windows_ICON_file_name is 254 characters. However, this name, combined with the icon path (ICOPATH), can have a maximum length of 259, so the true maximum length depends on the length of the icon path. This file can have any extension. This value is not case sensitive; you can specify this value by using uppercase or lowercase characters.

You cannot specify the drive and path information that identifies where the icon file resides using this keyword. You must specify this information as an input parameter for the FLGImport API call (see the Information Catalog Manager Programming Guide and Reference), the import function on the user interface (see Importing a tag language file from the command line), or the IMPORT option of the DGUIDE command (see Importing a tag language file from the command line).

You can change this value after the object type is created by using ACTION.OBJTYPE(UPDATE). After you specify an icon file to associate with an object type, you can change the associated icon, but the object type must always be associated with an icon.

ACTION.OBJTYPE(APPEND)

Context

Figure 61. Using the OBJECT tag when adding properties to object types

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

Keywords

TYPE
Specifies the name (type) of an object type.

Required keyword.

type
Identifies a specific object type by its 8-character short name.

ACTION.OBJTYPE(DELETE) or ACTION.OBJTYPE(DELETE_EXT)

Deleting an existing object type.

Context

Figure 62. Using the OBJECT tag when deleting object types

:ACTION.OBJTYPE(DELETE)
:OBJECT.TYPE()

Figure 63. Using the OBJECT tag when deleting object types and all objects of that type

:ACTION.OBJTYPE(DELETE_EXT)
:OBJECT.TYPE()

Keywords

TYPE
Specifies the name (type) of an object type.

Required keyword.

type
Identifies a specific object type by its 8-character short name.

ACTION.OBJTYPE(UPDATE)

Updating object type information.

Context

Figure 64. Using the OBJECT tag when updating object types

:ACTION.OBJTYPE(UPDATE)
:OBJECT.TYPE() EXTNAME() ICOFILE() ICWFILE()

Keywords

TYPE
Specifies the name (type) of an object type.

Required keyword.

type
Identifies a specific object type by its 8-character short name. You cannot update this value.

EXTNAME
Specifies a descriptive name for the object type. Optional keyword.

ext_name
Specifies an extended, descriptive name for the object type. The maximum length for ext_name is 80 characters.

You can update this value.

This name must be unique within related information catalogs.

The value of ext_name is stored in mixed case.

ICWFILE
Specifies the file that contains the Windows icon that is associated with the object type.

Optional keyword.

Windows_ICON_file_name
Specifies the name of the Windows icon file to associate with the object type.

You can update this value.

The maximum length of Windows_ICON_file_name is 254 characters. You cannot use this keyword to specify the drive and path information that identifies where the ICON file resides. You must specify this information as an input parameter for the FLGImport API call, the import function on the user interface, or the IMPORT option of the Information Catalog Manager command.

ACTION.OBJINST

Adding, updating, deleting, or merging objects

Context

Figure 65. Using the OBJECT tag when adding objects

:ACTION.OBJINST(ADD)
:OBJECT.TYPE()
:INSTANCE.short_name()

Figure 66. Using the OBJECT tag when merging objects

:ACTION.OBJINST(MERGE)
:OBJECT.TYPE()
:INSTANCE.short_name()

Figure 67. Using the OBJECT tag when updating objects

:ACTION.OBJINST(UPDATE)
:OBJECT.TYPE()
:INSTANCE.SOURCEKEY(UUI_short_name()...) short_name()

Figure 68. Using the OBJECT tag when deleting objects

:ACTION.OBJINST(DELETE)
:OBJECT.TYPE()
:INSTANCE.SOURCEKEY(UUI_short_name()...)

Keywords

TYPE
Specifies the name (type) of an object type.

Required keyword.

type
Identifies a specific object type by its 8-character short name.


[ Top of Page | Previous Page | Next Page ]