Configuring the Client Manager for Client Communications › Multi-Instance Client Manager › Client Manager ID User Exit

Client Manager ID User Exit

A common user exit, CMICXnnN.DLL (where nn is the current CA Gen release number) is available for use by both GUI applications, through the CA Gen Client Manager CoopFlow dll, and the Client Manager executable. This customizable user exit DLL has a single function entry point, ci_cm_id(), which should return a consistent string value. This entry point must return a string containing an ID that is used to uniquely identify a specific Client Manager.

The string of characters that is returned is then used in constructing the Client Manager IPC resource (the Windows mailslot), which is used for communicating between the client application and the Client Manager.

Example:

• For a Windows workstation running in single-instance Client Manager, the default exit implementation is sufficient to identify the Client Manager. The current default mailslot name used is .\mailslot\TIRCLNTS.QUE. In this instance, the string returned from the exit is TIRCLNTS.
• For workstations that need to support multiple logged on users, a unique ID must be used (for example: a USERNAME environment variable) to differentiate one execution of one Client Manager from another. For example, if the USERNAME variable is John Doe, then the string returned by the user exit to the Client Manager would be John_Doe. The string John_Doe is then used to derive a mailslot name of \mailslot\John_Doe.QUE. The same mailslot naming scheme will be used by all clients connecting to this instance of a Client Manager.

Notes:

• The returned string from ci_cm_id() must be 64 characters or less. A returned string longer than 64 characters is truncated at 64. The returned string cannot contain any blanks.
• For further information regarding implementing this user exit, see the User Exit Reference Guide.

More information:

User Exits