IBM Content Manager, Version 8.5

IBM Content Manager event formats

Each IBM® Content Manager event has its own event format and event code.

IBM Content Manager supports the following event codes:

301: Event code for creating an item.
302: Event code for updating an item.
303: Event code for deleting an item.
306: Event code for reindexing an item.
307: Event code for adding an item to a folder (auto-enabled or manual).
308: Event code for removing an item from a folder (auto-enabled or manual).
309: Event code for checking in an item.
310: Event code for checking out an item.
311: Event code for reindexing an item when the reindex operation is monitored against the source item type.

IBM Content Manager events have the following formats:

Create item event format

The following event format is for an event that occurs when an item is created:

ICMEMSTART;ETYPE=ITEM;EACTION=CREATE;ECODE=301;
ITEMID=<item_id>;ITEMTYPE=<item_type_name>;
PID=<pid_string>;NCOMPTYPE=<number_of_comp_type>;
COMPTYPE=<comp_type_name>;COMPNUMBER=<comp_number>;
NATTRS=<num_attrs>;ATTRNAME=<attr_name>;
ATTRGROUP=<attr_group_name>;
ATTRLEN=<attr_length>;ATTRTYPE=<attr_type>;
ATTRVAL=<attr_value>;...;
COMPTYPE=<comp_type_name>;COMPNUMBER=<comp_number>;
NATTRS=<num_attrs>;ATTRNAME=<attr_name>;
ATTRGROUP=<attr_group_name>;
ATTRLEN=<attr_length>;ATTRTYPE=<attr_type>;
ATTRVAL=<attr_value>;...;
ETIME=<time_stamp>;
NPROCESS=<number_of_process>;
PROCESS=<process_name>;PVERSION=<process_version>;
PTYPE=<process_type>;
NMAPATTRNAME=<number_of_mapping_attr>;
MAPATTRNAME=<mapping_attr_name>; 
CMATTRNAME=<cm_attr_name>;
MAPATTRNAME=<mapping_attr_name>;
CMATTRNAME=<cm_attr_name>;...;
PROCESS=<process_name>;PVERSION=<process_version>;
PTYPE=<process_type>;
NMAPATTRNAME=<number_of_mapping_attr>;
MAPATTRNAME=<mapping_attr_name>;
CMATTRNAME=<cm_attr_name>;
MAPATTRNAME=<mapping_attr_name>;
CMATTRNAME=<cm_attr_name>;...;
ICMEMEND

Update item event format

The following event format is for an event that occurs when an item is updated:

ICMEMSTART;ETYPE=ITEM;EACTION=UPDATE;ECODE=302;
ITEMID=<item_id>;ITEMTYPE=<item_type_name>;
OLDVERSION=<old_version>;
VERSION=<new_version>;
PID=<pid_string>;NCOMPTYPE=<number_of_comp_type>;
COMPTYPE=<comp_type_name>;COMPNUMBER=<comp_number>;
NATTRS=<num_attrs>;ATTRNAME=<attr_name>;
ATTRGROUP=<attr_group_name>;
ATTRVAL=<new_attr_value>;...;
COMPTYPE=<comp_type_name>;COMPNUMBER=<comp_number>;
NATTRS=<num_attrs>; ATTRNAME=<attr_name>;
ATTRGROUP=<attr_group_name>;
ATTRVAL=<new_attr_value>;...;
ETIME=<time_stamp>;
NPROCESS=<number_of_process>;
PROCESS=<process_name>;PVERSION=<process_version>;
PTYPE=<process_type>;
NMAPATTRNAME=<number_of_mapping_attr>;
MAPATTRNAME=<mapping_attr_name>; 
CMATTRNAME=<cm_attr_name>;
MAPATTRNAME=<mapping_attr_name>;
CMATTRNAME=<cm_attr_name>;...;
PROCESS=<process_name>;PVERSION=<process_version>;
PTYPE=<process_type>;
NMAPATTRNAME=<number_of_mapping_attr>;
MAPATTRNAME=<mapping_attr_name>;
CMATTRNAME=<cm_attr_name>;
MAPATTRNAME=<mapping_attr_name>;
CMATTRNAME=<cm_attr_name>;...;
ICMEMEND

Delete item event format

The following example shows the event format for an event that occurs when an item is deleted:

ICMEMSTART;ETYPE=ITEM;EACTION=DELETE;ECODE=303;
ITEMID=<item_id>;ITEMTYPE=<item_type_name>;
VERSION=<version>;
ETIME=<time_stamp>;
NPROCESS=<number_of_process>;
PROCESS=<process_name>;PVERSION=<process_version>;
PTYPE=<process_type>;
PROCESS=<process_name>;PVERSION=<process_version>;...;
ICMEMEND

Reindex item event format

The following event format is for an event that occurs when an item is reindexed:

ICMEMSTART;ETYPE=FOLDER;EACTION=REINDEX;ECODE=306;
ITEMID=<item_id>;OLDITEMTYPE=<old_item_type_name>;
OLDVERSION=<version>;
ITEMTYPE=<new_item_type_name>;
VERSION=<new_version>;
PID=<pid_string>;NCOMPTYPE=<number_of_comp_type>;
COMPTYPE=<comp_type_name>;COMPNUMBER=<comp_number>;
NATTRS=<num_attrs>;ATTRNAME=<attr_name>;
ATTRGROUP=<attr_group_name>;
ATTRLEN=<attr_length>;
ATTRTYPE=<attr_type>;
ATTRVAL=<attr_value>;...;
COMPTYPE=<comp_type_name>;COMPNUMBER=<comp_number>;
NATTRS=<num_attrs>;ATTRNAME=<attr_name>;
ATTRGROUP=<attr_group_name>;
ATTRLEN=<attr_length>;
ATTRTYPE=<attr_type>;
ATTRVAL=<attr_value>;...;
ETIME=<time_stamp>;
NPROCESS=<number_of_process>;
PROCESS=<process_name>;PVERSION=<process_version>;
PTYPE=<process_type>;
NMAPATTRNAME=<number_of_mapping_attr>;
MAPATTRNAME=<mapping_attr_name>; 
CMATTRNAME=<cm_attr_name>;
MAPATTRNAME=<mapping_attr_name>;
CMATTRNAME=<cm_attr_name>;...;
PROCESS=<process_name>;PVERSION=<process_version>;
PTYPE=<process_type>;
NMAPATTRNAME=<number_of_mapping_attr>;
MAPATTRNAME=<mapping_attr_name>;
CMATTRNAME=<cm_attr_name>;
MAPATTRNAME=<mapping_attr_name>;
CMATTRNAME=<cm_attr_name>;...;
ICMEMEND

Add item to folder event format

The following event format is for an event that occurs when an item is added to a folder:

ICMEMSTART;ETYPE=FOLDER;EACTION=ADD;ECODE=307;
ITEMID=<folder_item_id>;ITEMTYPE=<folder_item_type_name>;
VERSION=<folder_version>;
CHILDITEMID=<child_item_id>;CHILDITEMTYPE=<child_item_type_name>;
CHILDVERSION=<child_version>;
PID=<pid_string>;
CHILDPID=<child_pid_string>;
NCOMPTYPE=<number_of_comp_type>;
COMPTYPE=<comp_type_name>;COMPNUMBER=<comp_number>;
NATTRS=<num_attrs>;ATTRNAME=<attr_name>;
ATTRGROUP=<attr_group_name>;
ATTRLEN=<attr_length>;ATTRTYPE=<attr_type>;
ATTRVAL=<attr_value>;...;
COMPTYPE=<comp_type_name>;COMPNUMBER=<comp_number>;
NATTRS=<num_attrs>;ATTRNAME=<attr_name>;
ATTRGROUP=<attr_group_name>;
ATTRLEN=<attr_length>;ATTRTYPE=<attr_type>;
ATTRVAL=<attr_value>;...;
ETIME=<time_stamp>;
NPROCESS=<number_of_process>;
PROCESS=<process_name>;PVERSION=<process_version>;
PTYPE=<process_type>;
NMAPATTRNAME=<number_of_mapping_attr>;
MAPATTRNAME=<mapping_attr_name>; 
CMATTRNAME=<cm_attr_name>;
MAPATTRNAME=<mapping_attr_name>;
CMATTRNAME=<cm_attr_name>;...;
PROCESS=<process_name>;PVERSION=<process_version>;
PTYPE=<process_type>;
NMAPATTRNAME=<number_of_mapping_attr>;
MAPATTRNAME=<mapping_attr_name>;
CMATTRNAME=<cm_attr_name>;
MAPATTRNAME=<mapping_attr_name>;
CMATTRNAME=<cm_attr_name>;...;
ICMEMEND

Remove item from folder event format

The following event format is for an event that occurs when an item is removed from a folder:

ICMEMSTART;ETYPE=FOLDER;EACTION=REMOVE;ECODE=308;
ITEMID=<folder_item_id>;ITEMTYPE=<folder_item_type_name>;
VERSION=<folder_version>;
CHILDITEMID=<child_item_id>;CHILDITEMTYPE=<child_item_type_name>;
CHILDVERSION=<child_version>;
PID=<pid_string>;
CHILDPID=<child_pid_string>;
NCOMPTYPE=<number_of_comp_type>;
COMPTYPE=<comp_type_name>;COMPNUMBER=<comp_number>;
NATTRS=<num_attrs>;ATTRNAME=<attr_name>;
ATTRGROUP=<attr_group_name>;
ATTRLEN=<attr_length>;ATTRTYPE=<attr_type>;
ATTRVAL=<attr_value>;...;
COMPTYPE=<comp_type_name>;COMPNUMBER=<comp_number>;
NATTRS=<num_attrs>;ATTRNAME=<attr_name>;
ATTRGROUP=<attr_group_name>;
ATTRLEN=<attr_length>;ATTRTYPE=<attr_type>;
ATTRVAL=<attr_value>;...;
ETIME=<time_stamp>;
NPROCESS=<number_of_process>;
PROCESS=<process_name>;PVERSION=<process_version>;
PTYPE=<process_type>;
NMAPATTRNAME=<number_of_mapping_attr>;
MAPATTRNAME=<mapping_attr_name>; 
CMATTRNAME=<cm_attr_name>;
MAPATTRNAME=<mapping_attr_name>;
CMATTRNAME=<cm_attr_name>;...;
PROCESS=<process_name>;PVERSION=<process_version>;
PTYPE=<process_type>;
NMAPATTRNAME=<number_of_mapping_attr>;
MAPATTRNAME=<mapping_attr_name>;
CMATTRNAME=<cm_attr_name>;
MAPATTRNAME=<mapping_attr_name>;
CMATTRNAME=<cm_attr_name>;...;
ICMEMEND

Checkin item event format

The following event format is for an event that occurs when an item is checked in:

ICMEMSTART;ETYPE=ITEM;EACTION=CHECKIN;ECODE=309;
ITEMID=<item_id>;ITEMTYPE=<item_type_name>;
VERSION=<version>;
PID=<pid_string>;
CHECKINUID=<checkin_userid>;
CHECKINTIME=<checkin_time>;
CHECKOUTUID=<checkout_userid>;
CHECKOUTTIME=<checkout_time>;
OPERATIONTYPE=<operation_type>;
NCOMPTYPE=<number_of_comp_type>;
COMPTYPE=<comp_type_name>;COMPNUMBER=<comp_number>;
NATTRS=<num_attrs>;ATTRNAME=<attr_name>;
ATTRGROUP=<attr_group_name>;
ATTRLEN=<attr_length>;ATTRTYPE=<attr_type>;
ATTRVAL=<attr_value>;...;
COMPTYPE=<comp_type_name>;COMPNUMBER=<comp_number>;
NATTRS=<num_attrs>;ATTRNAME=<attr_name>;
ATTRGROUP=<attr_group_name>;
ATTRLEN=<attr_length>;ATTRTYPE=<attr_type>;
ATTRVAL=<attr_value>;...;
ETIME=<time_stamp>;
NPROCESS=<number_of_process>;
PROCESS=<process_name>;PVERSION=<process_version>;
PTYPE=<process_type>;
NMAPATTRNAME=<number_of_mapping_attr>;
MAPATTRNAME=<mapping_attr_name>; 
CMATTRNAME=<cm_attr_name>;
MAPATTRNAME=<mapping_attr_name>;
CMATTRNAME=<cm_attr_name>;...;
PROCESS=<process_name>;PVERSION=<process_version>;
PTYPE=<process_type>;
NMAPATTRNAME=<number_of_mapping_attr>;
MAPATTRNAME=<mapping_attr_name>;
CMATTRNAME=<cm_attr_name>;
MAPATTRNAME=<mapping_attr_name>;
CMATTRNAME=<cm_attr_name>;...;
ICMEMEND

Checkout item event format

The following event format is for an event that occurs when an item is checked out:

ICMEMSTART;ETYPE=ITEM;EACTION=CHECKOUT;ECODE=310;
ITEMID=<item_id>;ITEMTYPE=<item_type_name>;
VERSION=<version>;
PID=<pid_string>;
CHECKOUTUID=<checkout_userid>;
CHECKOUTTIME=<checkout_time>;
OPERATIONTYPE=<operation_type>;
NCOMPTYPE=<number_of_comp_type>;
COMPTYPE=<comp_type_name>;COMPNUMBER=<comp_number>;
NATTRS=<num_attrs>;ATTRNAME=<attr_name>;
ATTRGROUP=<attr_group_name>;
ATTRLEN=<attr_length>;ATTRTYPE=<attr_type>;
ATTRVAL=<attr_value>;...;
COMPTYPE=<comp_type_name>;COMPNUMBER=<comp_number>;
NATTRS=<num_attrs>;ATTRNAME=<attr_name>;
ATTRGROUP=<attr_group_name>;
ATTRLEN=<attr_length>;ATTRTYPE=<attr_type>;
ATTRVAL=<attr_value>;...;
ETIME=<time_stamp>;
NPROCESS=<number_of_process>;
PROCESS=<process_name>;PVERSION=<process_version>;
PTYPE=<process_type>;
NMAPATTRNAME=<number_of_mapping_attr>;
MAPATTRNAME=<mapping_attr_name>; 
CMATTRNAME=<cm_attr_name>;
MAPATTRNAME=<mapping_attr_name>;
CMATTRNAME=<cm_attr_name>;...;
PROCESS=<process_name>;PVERSION=<process_version>;
PTYPE=<process_type>;
NMAPATTRNAME=<number_of_mapping_attr>;
MAPATTRNAME=<mapping_attr_name>;
CMATTRNAME=<cm_attr_name>;
MAPATTRNAME=<mapping_attr_name>;
CMATTRNAME=<cm_attr_name>;...;
ICMEMEND

Reindex from item event format

The following event format is for an event that occurs when an item is reindexed and the reindex operation is monitored against the source item type:

ICMEMSTART;ETYPE=ITEM;EACTION=REINDEXFROM;ECODE=311;
ITEMID=<item_id>;
TOITEMTYPE=<to_item_type_name>;
TOVERSION=<to_version>;
ITEMTYPE=<item_type_name>;
VERSION=<version>;
PID=<pid_string>;
NCOMPTYPE=<number_of_comp_type>;
COMPTYPE=<comp_type_name>;COMPNUMBER=<comp_number>;
NATTRS=<num_attrs>;ATTRNAME=<attr_name>;
ATTRGROUP=<attr_group_name>;
ATTRLEN=<attr_length>;ATTRTYPE=<attr_type>;
ATTRVAL=<attr_value>;...;
COMPTYPE=<comp_type_name>;COMPNUMBER=<comp_number>;
NATTRS=<num_attrs>;ATTRNAME=<attr_name>;
ATTRGROUP=<attr_group_name>;
ATTRLEN=<attr_length>;ATTRTYPE=<attr_type>;
ATTRVAL=<attr_value>;...;
ETIME=<time_stamp>;
NPROCESS=<number_of_process>;
PROCESS=<process_name>;PVERSION=<process_version>;
PTYPE=<process_type>;
NMAPATTRNAME=<number_of_mapping_attr>;
MAPATTRNAME=<mapping_attr_name>; 
CMATTRNAME=<cm_attr_name>;
MAPATTRNAME=<mapping_attr_name>;
CMATTRNAME=<cm_attr_name>;...;
PROCESS=<process_name>;PVERSION=<process_version>;
PTYPE=<process_type>;
NMAPATTRNAME=<number_of_mapping_attr>;
MAPATTRNAME=<mapping_attr_name>;
CMATTRNAME=<cm_attr_name>;
MAPATTRNAME=<mapping_attr_name>;
CMATTRNAME=<cm_attr_name>;...;
ICMEMEND

Additional information:

The PID string is empty if the item is deleted before the event monitor has generated the PID string for the item.
The CMATTRNAME attribute can have one of the following formats:
- <attr_name>: The attribute is a root attribute and is not a member of an attribute group.
- <attr_group_name>.<attr_name>: The attribute is a root attribute and is a member of an attribute group.
- <comp_type_name>/<attr_name>: The attribute is a subcomponent attribute and is not a member of an attribute group.
- <comp_type_name>/<attr_group_name>.<attr_name>: The attribute is a subcomponent attribute and is a member of an attribute group.
If an ATTRGROUP tag of an attribute contains an empty string, the attribute is not a member of any attribute group.
For the remove item from folder event, the CHILDITEMTYPE string and the CHILDPID string are empty if the child item is deleted before the event monitor has generated them.

The OPERATIONTYPE attribute for the checkin item and checkout item event formats specifies the type of operation that triggers the item to be checked in or checked out. It can have one of the following values:

1

Create an item.

2

Create a document part.

3

Update an item.

4

Update a document part.

5

Get an item.

6

Reindex an item (move one item type to another item type).

7

Get a work package.

8

Check in an item.

9

Check out an item.

10

Terminate a process.

11

Route to an end node. A checkin occurs because an end node is reached. When the end node is reached during a document routing process, an item that is checked out is checked in. One of the following scenarios can cause the end node to be reached:

A collection of documents at a collection point node meets a requirement that results in an item route and the next node to be routed is an end node.
An item route occurs at a decision point node and the next node to be routed is an end node.
An item route is invoked and the next node to be routed is an end node

-1

Null (the operation type is not set).

The following five system-defined attributes are logged by the library server if they are subscribed to by the administrator. System-defined attributes of the root component are always used:

CREATEUSERID: Create user ID.
CREATETS: Create timestamp.
LASTCHANGEDUSERID: Update user ID.
LASTCHANGEDTS: Update timestamp.
EXPIRATIONDATE: Expiration timestamp.

Feedback