Data Warehouse Center Application Integration Guide

ACTION.OBJINST

Identifies the action to be performed on the object that is described with the tags that follow the ACTION tag.

Context

ACTION.OBJINST is used to create, delete, or maintain Information Catalog Manager objects.

ACTION.OBJINST is followed by one or more OBJECT and INSTANCE tags, which define the object to act on.

Syntax

:ACTION.OBJINST(option)

Options

The following options are valid for ACTION.OBJINST:

ADD

DELETE

DELETE_TREE_ALL

DELETE_TREE_REL

MERGE

UPDATE

ACTION.OBJINST(ADD)

Adds an object.

Context

Figure 33. Using the ACTION.OBJINST tag when adding objects

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

Rules

• The object must not already exist.
• Both the OBJECT tag and the INSTANCE tag must follow the ACTION.OBJINST(ADD) tag.
  • The OBJECT tag identifies the object type for the new object.
  • The INSTANCE tag specifies the property values for the new object.
• One or more INSTANCE tags can follow a single OBJECT tag, if the objects are for the same object type.
• One or more sets of an OBJECT tag with INSTANCE tags can follow an ACTION.OBJINST(ADD) tag to describe objects of different object types to add.

ACTION.OBJINST(DELETE)

Deletes an object.

Context

Figure 34. Using the ACTION.OBJINST tag when deleting objects

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

Rules

• The specified object must already exist.
• Both the OBJECT tag and the INSTANCE tag must follow the ACTION.OBJINST(DELETE) tag.
  • The OBJECT tag identifies the object type for the object to be deleted.
  • The INSTANCE tag specifies the UUI property values for the object to be deleted.
• One or more INSTANCE tags can follow a single OBJECT tag, if the objects are for the same object type.
• One or more sets of an OBJECT tag with INSTANCE tags can follow an ACTION.OBJINST(DELETE) tag to describe objects of different object types to delete.
• If the object to delete is a Grouping object, it cannot contain another object. If it does, the delete fails. Use ACTION.OBJINST(DELETE_TREE_ALL) instead.

ACTION.OBJINST(DELETE_TREE_ALL)

Deletes a Grouping category object, all Comments objects that are attached to it, and all ATTACHMENT, CONTACT, and LINK relationships in which it participates. Deletes all objects that are contained in the Grouping category object, all Comments objects attached to them, and all ATTACHMENT, CONTACT, and LINK relationships in which they participate.

Context

Figure 35. Using the ACTION.OBJINST tag when deleting Grouping category objects and contained objects

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

Rules

• The specified object must already exist and be a Grouping category object.
• Both the OBJECT tag and the INSTANCE tag must follow the ACTION.OBJINST(DELETE_TREE_ALL) tag.
  • The OBJECT tag identifies the object type for the object to delete.
  • The INSTANCE tag specifies the UUI property values for the object that is being deleted.
• One or more INSTANCE tags can follow a single OBJECT tag, if the objects are for the same object type.
• One or more sets of an OBJECT tag with INSTANCE tags can follow an ACTION.OBJINST(DELETE_TREE_ALL) tag to describe objects of different object types to be deleted.

ACTION.OBJINST(DELETE_TREE_REL)

Deletes a Grouping category object, all Comments objects attached to it, and all ATTACHMENT, CONTACT, CONTAIN, and LINK relationships in which it participates.

Context

Figure 36. Using the ACTION.OBJINST tag when deleting Grouping category objects and relationships

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

Rules

• The specified object must already exist and be a Grouping category object.
• Both the OBJECT tag and the INSTANCE tag must follow the ACTION.OBJINST(DELETE_TREE_REL) tag.
  • The OBJECT tag identifies the object type for the object being deleted.
  • The INSTANCE tag specifies the UUI property values for the object being deleted.
• One or more INSTANCE tags can follow a single OBJECT tag, if the objects are for the same object type.
• One or more sets of an OBJECT tag with INSTANCE tags can follow an ACTION.OBJINST(DELETE_TREE_REL) tag to describe objects of different object types to be deleted.

ACTION.OBJINST(MERGE)

Searches for the input object's UUI in the information catalog to see whether the input object exists.

If the object exists, the Information Catalog Manager updates the property values of the object in the information catalog. If the object does not exist, the Information Catalog Manager creates a new object.

Context

Figure 37. Using the ACTION.OBJINST tag when merging objects

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

Rules

• If the object exists, the Information Catalog Manager updates the property values of the object in the information catalog. If the object does not exist, the Information Catalog Manager creates a new object.
• Both the OBJECT tag and the INSTANCE tag must follow the ACTION.OBJINST(MERGE) tag.
  • The OBJECT tag identifies the object type for the object being merged.
  • The INSTANCE tag specifies the property values for the object being merged.
• You must have an ACTION.OBJTYPE(MERGE) tag for a given object type earlier in the tag language file than the ACTION.OBJINST(MERGE) tag for the same object type. This ensures that the object type exists in the information catalog that you are importing to before the Information Catalog Manager can add or update (merge) objects.

  You cannot use ACTION.OBJTYPE(MERGE) for an object type that belongs to the Program or Attachment categories, because you cannot create new Program or Attachment object types. However, you can use ACTION.OBJINST(MERGE) with Program objects, without specifying the ACTION.OBJTYPE(MERGE) first.

ACTION.OBJINST(UPDATE)

Updates the value of an object.

Context

Figure 38. Using the ACTION.OBJINST tag when updating objects

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

Rules

• The specified object must already exist.
• Both the OBJECT tag and the INSTANCE tag must follow the ACTION.OBJINST(UPDATE) tag.
  • The OBJECT tag identifies the object type for the object being updated.
  • The INSTANCE tag specifies the UUI property values, which identify the object to be updated, and the property values that are being updated.
  Only the property values specified on the INSTANCE tag are updated.