Overview of user message exit routines

For most types of IMS Connect clients, IMS Connect requires the use of a user message exit routine to manage the messages that are received from and sent to the client.

The user message exit routines can perform a number of tasks related to the management of messages, including:
  • Translating input messages into the protocol or format required by IMS and the IMS Open Transaction Manager Access (OTMA) component
  • Rerouting messages
  • Checking security for input messages
  • Returning user-defined messages in response to certain user-defined criteria
The following IMS Connect clients are listed with the IMS Connect user message exit that they require:
User-provided clients that access IMS TM
The HWSSMPL0 or HWSSMPL1 user message exit routine, or a user-written user message exit routine.

Optionally, you can also use an IMS Connect Port Message Edit exit routine, which receives control between IMS Connect and the z/OS® TCP/IP stack, to modify the format of input and output messages.

The HWSSMPL0 and HWSSMPL1 exit routines and their related macros are shipped with IMS both as source code and as load modules.

IMS TM Resource Adapter
The HWSJAVA0 user message exit routine.

Optionally, you can also use an IMS Connect Port Message Edit exit routine, which receives control between IMS Connect and the z/OS TCP/IP stack, to modify the format of input and output messages.

The HWSJAVA0 exit routine and its related macros are provided as both load modules and source code.

IMS Enterprise Suite SOAP Gateway
The HWSSOAP1 user message exit routine, which is provided as object code only.

Optionally, you can also use an IMS Connect Port Message Edit exit routine, which receives control between IMS Connect and the z/OS TCP/IP stack, to modify the format of input and output messages.

IBM® WebSphere® DataPower®
The HWSDPWR1 message exit routine, which is provided as object code only.

Optionally, you can also use an IMS Connect Port Message Edit exit routine, which receives control between IMS Connect and the z/OS TCP/IP stack, to modify the format of input and output messages.

Clients that access IMS DB, such as the IMS Universal drivers.
IMS Connect does not support user message exit routines for clients that access IMS DB, such as the IMS Universal drivers and user-provided clients that use the Distributed Relational Database Architecture (DRDA) interface. Instead, you can use the following IMS Connect exit routines for message routing, security, and message editing:
  • IMS Connect DB Routing user exit routine (HWSROUT0)
  • IMS Connect DB Security user exit routine (HWSAUTH0)
  • IMS Connect Port Message Edit exit routine
Clients that submit commands to the Operations Manager (OM)
The HWSCSLO0 or HWSCSLO1 user message exit routines, which are provided as object code only.

IMS-to-IMS TCP/IP connections do not use an IMS Connect user message exit routines.