IBM Content Manager, Version 8.5

User exit myExit for document routing

This user exit is called after creating a work package (using the start process), when a work package is moved off a work node, to move to a work node, or when the overload limit is reached.

Purpose

At the time the exit is called, the work package exists in the work package table, and can be retrieved using the componentID as the identifier of the row in table ICMUT00204001.

Parameters

typedef struct ICMCONTAINERDATA_STRUCT 
{ 
	char  szContainerName[33];   Container Data variable name 
  char  szContainerVal[255];  Container Data variable value 
}ICMCONTAINERDATA_STRUCT; 
typedef struct _ICMUSERSTRUCT 
 int   lUserEvent;  
 char  szWPCompID[19]; 
 char  szWPItemID[27]; 
 short sWPVersionID; 
 char  szRouteSel[33]; 
 short  sUpdateFlag; 
 short  sNumContainerData; 
 pContainerDataStructIn 
 pContainerDataStructOut 
 const ICMCONTAINERDATA_STRUCT *pContainerDataStructIn; 
 ICMCONTAINERDATA_STRUCT *pContainerDataStructOut; 
 void * mallocf;  
} ICMUSERSTRUCT;

Input parameters

lUserEvent

Indicates in which Work Node Event this user exit was called. Values:

1: The work package is entering the work node.
2: The work package is leaving the work node.
3: The work package is at a work node, exceeding the overload limit at this work node.

szWPCompID

The work package component ID passed to this user exit

szWPItemID

The work package item ID passed to this user exit.

sWPVersionID

The work package Version ID passed to this user exit

sNumContainerData

Number of ICM container data structures that is sent to this exit in pContainerDataStructIn

pContainerDataStructIn

Contains container data sent to the user exit

Output parameters

szRouteSel

The route the work package takes on return from this user exit

sUpdateFlag

1: User exit is returning updated container data
0: User exit is not returning updated container data

sNumContainerData

Number of ICM container data structures that is returned on pContainerDataStructOut

pContainerDataStructOut

Contains container data returned by the user exit

mallocf

Pointer to the C malloc function that this user exit needs to use to allocate memory for the output container data structure will be returned in pContainerDataStructOut

Sample codes

A sample code is provided in IBMCMROOT\samples/server/exit. For the sample user exit, the following files are installed under IBMCMROOT\samples\server\exit directory:

Table 1. File locations
Sample name	Purpose
icmdruext.c	C source code for user exit
icmdruext.def	Standard DEF file for Windows platform
wxv2tue.h	Header file for user exit constants, prototypes
bldexit.bat	Compile IBM® Content Manager library server user exit using Microsoft Visual Studio 2003

For document routine user exits, the path name of the shared library and the name of the function are specified by the users when creating the work nodes.

Feedback