Client ID (clientID)

A value for this property must be provided when an application component uses a dedicated persistent socket connection to IMS Connect to identify this particular client.

The client ID value must be specified to identify the client to which the socket connection is dedicated (when the CM0Dedicated property is set to true). A dedicated persistent socket connection must be used for only commit mode 0 interactions with the following interaction verbs:
  • SYNC_RECEIVE_ASYNCOUTPUT_SINGLE_WAIT
  • SYNC_RECEIVE_ASYNCOUTPUT_SINGLE_NOWAIT (replacing the deprecated SYNC_RECEIVE_ASYNCOUTPUT)
  • SYNC_SEND_RECEIVE

The client ID is generated in a shareable persistent socket connection that can be used by commit mode 0 and commit mode 1 interactions (when the CM0Dedicated property is set to false).

The client ID in a shareable persistent socket can be obtained through the IMSConnectionMetaData getClientID method. You can access the IMSConnectionMetaData class from the IMSConnection class. If you use this method with IMS Version 12, APAR PM75222 (V12.1.2) is required.

A valid user-specified client ID must meet the following requirements:
  • Must be a string of 1 to 8 alphanumeric (A-Z, 0-9) or special (@,#,$) characters.
  • Must not start with the character string HWS.
  • Must not be an IMS Connect port number.
  • If lowercase letters are provided, the letters are changed to uppercase

Client IDs are dedicated to their sockets, regardless of whether they are shareable or dedicated. Unlike the other properties, the original client ID never changes until the socket is disconnected.