Configuring CICS to use the IBM MQ transport
To use the IBM® MQ transport with SOAP web services in CICS®, you must configure your CICS region accordingly.
About this task
Note: You cannot use the IBM MQ transport
for JSON web services.
Procedure
-
Include the IBM MQ library
thlqual.SCSQAUTH in the STEPLIB concatenation in your CICS procedure. Include the library after the CICS libraries to ensure that the correct code is used.
thlqual is the high-level qualifier for the IBM MQ libraries.
-
Include the following IBM MQ
libraries in the DFHRPL concatenation in your CICS procedure.
Include the libraries after the CICS libraries to ensure that
the correct code is used.
- thlqual.SCSQCICS
- thlqual.SCSQLOAD
- thlqual.SCSQAUTH
If you are using the CICS-MQ API-crossing exit (CSQCAPX), also add the name of the library that contains the load module for the program.The SCSQCICS library is required only if you want to run IBM MQ supplied samples. Otherwise it can be removed from the CICS procedure. -
Define and install an MQCONN resource for the CICS
region.
The MQCONN resource specifies the attributes of the connection between CICS and IBM MQ, including the name of the default IBM MQ queue manager or queue-sharing group for the connection. For instructions, see Defining and installing an MQCONN resource.
- Specify the CICS system initialization parameter MQCONN=YES to start the CICS-MQ connection automatically at CICS initialization. For details, see MQCONN system initialization parameter.
-
If you are using the CICS-MQ adapter
in a CICS system that has interregion communication (IRC) to
remote CICS systems, ensure that the IRC facility is OPEN
before you start the adapter, by specifying the CICS system
initialization parameter IRCSTRT=YES.
The IRC facility must be OPEN if the IRC access method is defined as cross-memory; that is, ACCESSMETHOD(XM).
- Ensure that the coded character
set identifiers (CCSIDs) used by your queue manager and by CICS, and the UTF-8 and UTF-16
code pages are configured to z/OS® conversion
services. The CICS code page is specified in the LOCALCCSID system initialization parameter.
- Update your CICS CSD as follows:
- If you do not share your CSD with earlier releases of CICS, remove the groups CSQCAT1
and CSQCKB, and any copies of those groups or of items from those
groups, from your CSD. You must also delete the CKQQ TDQUEUE from
group CSQCAT1. The definition for CKQQ is now supplied in the CICS CSD group DFHDCTG.
- If you do share your CSD with earlier CICS releases, ensure that CSQCAT1 and CSQCKB,
and any copies of those groups or of their content, are not installed
for CICS TS 4.1 or CICS TS 3.2. You
must also delete the CKQQ TDQUEUE from group CSQCAT1. The definition for CKQQ is now supplied in the CICS CSD group DFHDCTG.For CICS TS releases earlier than CICS TS 3.2, install the CSQCAT1 and CSQCKB groups as part of a group list, after installing DFHLIST, to override group DFHMQ and correctly install the required definitions.
- If you do not share your CSD with earlier releases of CICS, remove the groups CSQCAT1
and CSQCKB, and any copies of those groups or of items from those
groups, from your CSD. You must also delete the CKQQ TDQUEUE from
group CSQCAT1.
-
Update the IBM MQ definitions for
the dead-letter queue, default transmission queue, and CICS-MQ adapter objects.
You can use the sample CSQ4INYG, but you might need to change the initiation queue name to match the default initiation queue name in the MQINI resource definition for your CICS region. You can use this member in the CSQINP2 DD concatenation of the queue manager startup procedure, or you can use it as input to the COMMAND function of the CSQUTIL utility to issue the required DEFINE commands. Using the CSQUTIL utility is preferable because you do not then have to redefine these objects each time that you restart IBM MQ.