IBM Content Manager, Version 8.5

IBM Content Manager event formats for IBM Case Manager integration

IBM® Case Manager preforms actions on IBM Content Manager items that can trigger IBM Content Manager events to be written to the event monitor queue by the case event handler. Each these events has its own event format and event code.

IBM Case Manager actions can trigger the following IBM Content Manager event codes:

301: Event code for creating 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). These type of events are ignored by the case event handler for all folders that are not members of the ICMPROXYFDRS item type.
308: Event code for removing an item from a folder (auto-enabled or manual). These type of events are ignored by the case event handler for all folders that are not members of the ICMPROXYFDRS item type.
311: Event code for reindexing an item when the reindex operation is monitored against the source item type.

The IBM Content Manager events that IBM Case Manager can trigger 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

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

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 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