Program Directory For MQ v9
Program Directory For MQ v9
FMID HMS9000
GI13-3386-01
Note
Before using this information and the product it supports, be sure to read the general information under Appendix D, “Notices”
on page 65.
A form for reader's comments appears at the back of this publication. When you send information to IBM, you grant IBM a
nonexclusive right to use or distribute the information in any way it believes appropriate without incurring any obligation to you.
Reader's Comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Figures
1. Basic Material: Program Tape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
2. Program File Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
3. Basic Material: Unlicensed Publications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
4. Publications Useful During Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
5. PSP Upgrade and Subset ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
6. Component IDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
7. Driving System Software Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
8. Target System Mandatory Installation Requisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
9. Target System Mandatory Operational Requisites . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
10. Target System Conditional Operational Requisites . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
11. Target System Negative Requisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
12. Total DASD Space Required by IBM MQ for z/OS . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
13. Storage Requirements for IBM MQ for z/OS Target Libraries . . . . . . . . . . . . . . . . . . . . . 20
14. IBM MQ for z/OS File System Paths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
15. Storage Requirements for IBM MQ for z/OS Distribution Libraries . . . . . . . . . . . . . . . . . . 24
16. Cross Reference of Tapes to Installable Features . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
17. SMP/E Options Subentry Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
18. High-level qualifiers for data set names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
19. Volume and unit names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
20. Target and distribution zone names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
21. Path for IBM MQ for z/OS Unix System Services Components. . . . . . . . . . . . . . . . . . . . . 34
22. Sample Installation Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
23. Allocation jobs for optional features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
24. Library contents after installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
25. Directory contents after installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Contents v
vi IBM MQ for z/OS Program Directory
1.0 Introduction
IBM MQ for z/OS Version V9.0 has two types of release; a Long Term Support Release (LTSR) and a
Continuous Delivery (CD) release. The differences between these two are documented in detail at
http://www.ibm.com/support/knowledgecenter/en/SSFKSJ_9.0.0/com.ibm.mq.pla.doc/q004715_.htm. This
program directory describes installation of the FMIDs associated with the Long Term Support Release.
This program directory is intended for system programmers who are responsible for program installation
and maintenance. It contains information about the material and procedures associated with the
installation of IBM MQ for z/OS. This publication refers to IBM MQ for z/OS as IBM MQ for z/OS.
Before installing IBM MQ for z/OS, read the CBPDO Memo To Users and the CBPDO Memo To Users
Extension that are supplied with this program in softcopy format and this program directory; then keep
them for future reference. Section 3.2, “Preventive Service Planning” on page 9 tells you how to find any
updates to the information and procedures in this program directory.
IBM MQ for z/OS is supplied in a Custom-Built Product Delivery Offering (CBPDO, 5751-CS3). The
program directory that is provided in softcopy format on the CBPDO tape is identical to the hardcopy
format if one was included with your order. All service and HOLDDATA for IBM MQ for z/OS are included
on the CBPDO tape.
Basic Machine-Readable Materials are materials that are supplied under the base license and are required
for the use of the product.
The program announcement material describes the features supported by IBM MQ for z/OS. Ask your
IBM representative for this information if you have not already received a copy.
You can find information about the physical media for the basic machine-readable materials for IBM MQ
for z/OS in the CBPDO Memo To Users Extension.
NOTE
If IBM MQ for z/OS was shipped to you in a CBPDO, you need to refer to the CBPDO Memo To Users
Extension for the physical tape layout of the basic machine-readable materials.
Figure 2 on page 4 describes the program file content for IBM MQ for z/OS. You can refer to the
CBPDO Memo To Users Extension to see where the files reside on the tape.
Figure 3 identifies the basic unlicensed publications for IBM MQ for z/OS. Those that are in softcopy
format publications can be obtained from the IBM Publications Center website at
http://www.ibm.com/shop/publications/order/.
Program Materials 5
Figure 3 (Page 2 of 2). Basic Material: Unlicensed Publications
Form
Publication Title Number Media Format
IBM MQ for z/OS V9.0.0 Program Directory GI13-3386 http://www.ibm.com/shop/
publications/order/
Additionally, IBM MQ for z/OS V9.0.0 documentation is published in IBM Knowledge Center, which can be
viewed from a web browser with Internet access at
http://www.ibm.com/support/knowledgecenter/SSFKSJ_9.0.0/com.ibm.mq.helphome.v90.doc/WelcomePagev9r0.htm.
Program Materials 7
8 IBM MQ for z/OS Program Directory
3.0 Program Support
This section describes the IBM support available for IBM MQ for z/OS.
If the CBPDO for IBM MQ for z/OS is older than two weeks by the time you install the product materials,
you can obtain the latest PSP Bucket information by going to the following website:
http://www14.software.ibm.com/webapp/set2/psearch/search?domain=psp
You can also use S/390 SoftwareXcel or contact the IBM Support Center to obtain the latest PSP Bucket
information.
PSP Buckets are identified by UPGRADEs, which specify product levels; and SUBSETs, which specify the
FMIDs for a product level. The UPGRADE and SUBSET values for IBM MQ for z/OS are included in
Figure 5.
Figure 6 identifies the component IDs (COMPID) for IBM MQ for z/OS.
Frequently check the IBM MQ for z/OS PSP Bucket for HIPER and SPECIAL attention PTFs against all
FMIDs that you must install. You can also receive the latest HOLDDATA, then add the
FIXCAT(IBM.PRODUCTINSTALL-REQUIREDSERVICE) operand on your APPLY CHECK command.
This will allow you to review the recommended and critical service that should be installed with your
FMIDs.
In many cases, you can use a system as both a driving system and a target system. However, you can
make a separate IPL-able clone of the running system to use as a target system. The clone must include
copies of all system libraries that SMP/E updates, copies of the SMP/E CSI data sets that describe the
system libraries, and your PARMLIB and PROCLIB.
Note: SMP/E is a requirement for Installation and is an element of z/OS but can also be ordered as a
separate product, 5655-G44, minimally V3.6.0.
Note: Installation might require migration to new z/OS releases to be service supported. See
http://www-03.ibm.com/systems/z/os/zos/support/zos_eos_dates.html.
IBM MQ for z/OS Unix System Services Components is installed into a file system, either HFS or zFS.
Before installing IBM MQ for z/OS Unix System Services Components, you must ensure that the target
system file system data sets are available for processing on the driving system. OMVS must be active on
the driving system and the target system file system data sets must be mounted on the driving system.
If you plan to install IBM MQ for z/OS Unix System Services Components in a zFS file system, this
requires that zFS be active on the driving system. Information on activating and using zFS can be found in
z/OS Distributed File Service zSeries File System Administration, SC24-5989.
5.2.2.1 Installation Requisites: Installation requisites identify products that are required and
must be present on the system or products that are not required but should be present on the system for
the successful installation of this product.
Mandatory installation requisites identify products that are required on the system for the successful
installation of this product. These products are specified as PREs or REQs.
Note: Installation might require migration to new z/OS releases to be service supported. See
http://www-03.ibm.com/systems/z/os/zos/support/zos_eos_dates.html.
Conditional installation requisites identify products that are not required for successful installation of this
product but can resolve such things as certain warning messages at installation time. These products are
specified as IF REQs.
5.2.2.2 Operational Requisites: Operational requisites are products that are required and must
be present on the system or products that are not required but should be present on the system for this
product to operate all or part of its functions.
Mandatory operational requisites identify products that are required for this product to operate its basic
functions.
Conditional operational requisites identify products that are not required for this product to operate its
basic functions but are required at run time for this product to operate specific functions. These products
are specified as IF REQs.
5.2.2.4 Incompatibility (Negative) Requisites: Negative requisites identify products that must
not be installed on the same system as this product.
Figure 12 lists the total space that is required for each type of library.
Notes:
1. For non-RECFM U data sets, IBM recommends using system-determined block sizes for efficient
DASD utilization. For RECFM U data sets, IBM recommends using a block size of 32760, which is
most efficient from the performance and DASD utilization perspective.
2. Abbreviations used for data set types are shown as follows.
U Unique data set, allocated by this product and used by only this product. This table provides
all the required information to determine the correct storage for this data set. You do not need
to refer to other tables or program directories for the data set size.
S Shared data set, allocated by this product and used by this product and other products. To
determine the correct storage needed for this data set, add the storage size given in this table
to those given in other tables (perhaps in other program directories). If the data set already
exists, it must have enough free space to accommodate the storage size given in this table.
E Existing shared data set, used by this product and other products. This data set is not
allocated by this product. To determine the correct storage for this data set, add the storage
size given in this table to those given in other tables (perhaps in other program directories). If
the data set already exists, it must have enough free space to accommodate the storage size
given in this table.
If you currently have a previous release of this product installed in these libraries, the installation of
this release will delete the old release and reclaim the space that was used by the old release and any
service that had been installed. You can determine whether these libraries have enough space by
The following figures describe the target and distribution libraries and file system paths required to install
IBM MQ for z/OS. The storage requirements of IBM MQ for z/OS must be added to the storage required
by other programs that have data in the same library or path.
Note: Use the data in these tables to determine which libraries can be merged into common data sets.
In addition, since some ALIAS names may not be unique, ensure that no naming conflicts will be
introduced before merging libraries.
Figure 13 (Page 1 of 4). Storage Requirements for IBM MQ for z/OS Target Libraries
R L
T E R No. No.
Y O C E of of
Library Member Target P R F C 3390 DIR
DDNAME Type Volume E G M L Trks Blks
SCSQINST SAMP ANY U PDSE FB 80 14 N/A
If you do not want to delete these FMIDs at this time, install IBM MQ for z/OS into separate SMP/E target
and distribution zones.
Note: These FMIDs are not automatically deleted from the Global Zone. If you want to delete these
FMIDs from the Global Zone, use the SMP/E REJECT NOFMID DELETEFMID command. See the
SMP/E Commands book for details.
If you are migrating from a previous version of IBM MQ for z/OS, please read Appendix C, “SMP/E
Migration considerations” on page 61 before you start.
The Configuring > Configuring z/OS section of the MQ product documentation hosted in IBM Knowledge
Center describes how to use the REFRESH QMGR command to update the version of early code being
installed.
There is a separate RECEIVE job for each TAPE which contains features you are installing. See
Figure 16 on page 28 for a list of which features are provided on each tape. The APPLY and ACCEPT
jobs will have been customized to deal with all the features you selected in a single run of the job when
you ran the CSQ8ASYJ job above.
If you are using the optional LINK job, see Appendix B, “Enabling automatic relinking after service is
applied” on page 59.
Installation Instructions 29
6.3.3 SMP/E CALLLIBS Processing
IBM MQ for z/OS uses the CALLLIBS function provided in SMP/E to resolve external references during
installation. When IBM MQ for z/OS is installed, ensure that DDDEFs exist for the following libraries:
CSSLIB
SCEEBND2
SCEECPP
SCEELIB
SCEELKED
SCEELKEX
SCEEOBJ
SCEESPC
Note: CALLLIBS uses the previous DDDEFs only to resolve the link-edit for IBM MQ for z/OS. These
data sets are not updated during the installation of IBM MQ for z/OS.
When IBM MQ for z/OS has been installed, use SMP/E to install preventative or corrective service if
required.
6.3.5.1 High-level qualifiers: Use Figure 18 to plan the high-level qualifiers for the IBM MQ for
z/OS data sets.
Installation Instructions 31
Figure 18 (Page 2 of 2). High-level qualifiers for data set names
Parameter Default value Assigned Description
name in value
the sample
JCL
provided
DHQ DHQ High-level qualifiers for the UCSQINST data set into
which the installation JCL will be loaded from tape.
LEQUAL PP.ADLE370 High-level qualifiers for the Language Environment
target libraries.
MACQUAL SYS1 High-level qualifier for the SYS1.MACLIB library.
This library is referenced during definition of the
SMP/E global zone to initialize the VSAM CLUSTER
as an SMP/E CSI.
PATHPREFIX /usr/lpp/mqm/V9R0M0 Install path for the IBM MQ for z/OS Unix System
Services Components.
SHLQUAL MQ.SMPE High-level qualifiers for the new SMP/E data sets
that you are going to use to install IBM MQ for z/OS.
If you are going to install into existing data sets, this
name is already defined.
SSLPREFIX . Any prefix required on the driver system for the
/usr/lpp/gskssl directory. If a prefix is specified the
directory will be in the following form:
/SSLPREFIX/usr/lpp/gskssl.
THLQUAL MQ.TLIB High-level qualifiers for the IBM MQ for z/OS target
data sets.
THQ THQ High-level qualifiers for the TCSQINST data set into
which the customized installation JCL will be placed.
ZFSNAME ZFSNAME The data set name used by CSQ8J8ZF for creation
of a zFS file system on which to install IBM MQ for
z/OS Unix System Services Components.
Note: If required, DHQ can be the same as DHLQUAL and THQ can be the same as THLQUAL.
If these high-level qualifiers do not already exist, you must define them to RACF, or any other security
product you are using, and have ALIAS definitions in the master catalog.
The TSO user ID used to install or service IBM MQ for z/OS requires RACF ALTER access to these
high-level qualifiers. See the MQ product documentation hosted in IBM Knowledge Center for details of
the security authorization required for running IBM MQ for z/OS.
If you are going to use the System Display and Search Facility (SDSF) to look at the output from the
installation jobs, you must have authorization to use the prefix CSQ8 to view them, or you must customize
6.3.5.2 Volume and unit names: Plan the volume and unit names shown in Figure 19. These
are used by the supplied sample JCL during the installation of IBM MQ for z/OS. You must decide where
you are going to install the product, taking into account the space requirements (see Figure 15 on
page 24 and Figure 13 on page 20) and how frequently the data sets are going to be accessed.
6.3.5.3 SMP/E environment: You must decide whether to install IBM MQ for z/OS into a new or
an existing SMP/E environment. Remember that installing a new release of IBM MQ for z/OS into the
same SMP/E zones as an existing release will cause the earlier level to be deleted from both the SMP/E
zones and the existing release data sets.
If you are going to install into the same SMP/E zones, then to preserve your current release while you
install and test the new release you should copy the existing release data sets into data sets with different
names. Do not rename or delete the current data sets because they need to be available to SMP/E for
delete processing during the installation of the new release. If they are not available, the APPLY and
ACCEPT steps will fail with a return code of 12. After running a successful ACCEPT of the IBM MQ for
z/OS products, the previous release data sets are no longer required and can be deleted when testing of
the new release has been completed.
Installation Instructions 33
If you use existing SMP/E data sets, you need to know the names of your target zone and distribution
zone, and the data set name of your global CSI.
You must decide upon the names for the SMP/E zones.
6.3.5.4 File system: The IBM MQ for z/OS Unix System Services Components installs into the file
system in Unix System Services. By default, code is installed under the path /usr/lpp/mqm/V9R0M0.
If you choose to change this default behavior, modify the PATHPREFIX value in CSQ8ASYJ
Figure 21. Path for IBM MQ for z/OS Unix System Services Components.
Default value Assigned Value Description
/usr/lpp/mqm/V9R0M0 The path for IBM MQ for
z/OS Unix System Services
Components.
In addition to having an OMVS segment you will require READ access to the RACF
BPX.FILEATTR.PROGCTL and BPX.FILEATTR.APF profiles in the FACILITY class. Having superuser
authority does not give you access to these profiles automatically.
Installation Instructions 35
Figure 22 (Page 2 of 2). Sample Installation Jobs
Job Name Job Type Description RELFILE
CSQ8K8MK MKDIR Sample job to create the file system path for IBM.HMS9000.F2
IBM MQ for z/OS Unix System Services
Components
CSQ8L0DD DDDEF Sample job to define IBM MQ for z/OS target IBM.HMS9000.F2
and distribution libraries to SMP/E
CSQ8M8DD DDDEF Sample job to define libraries for IBM MQ for IBM.HMS9000.F2
z/OS Unix System Services Components to
SMP/E
CSQ8N0RC RECEIVE Sample RECEIVE job for IBM MQ for z/OS IBM.HMS9000.F2
CSQ8P0AP APPLY Sample APPLY job for IBM MQ for z/OS IBM.HMS9000.F2
CSQ8Q0AC ACCEPT Sample ACCEPT job for IBM MQ for z/OS IBM.HMS9000.F2
CSQ8RLKB CUSTOMIZE Customizes the CSQ8SLDQ SMP/E link IBM.HMS9000.F2
statement
CSQ8ZLKB REXX REXX program to scan a set of libraries IBM.HMS9000.F2
looking for aliases then convert a JCL file to
resolve aliases to their real names
CSQ8SLDQ LINK Optional link job IBM.HMS9000.F2
CSQ8Z8MK REXX REXX program to create the necessary ZFS IBM.HMS9000.F2
directories for IBM MQ for z/OS Unix System
Services Components
CSQ8TUBP USERMOD User modification that moves the IBM MQ for IBM.HMS9000.F2
z/OS exit program into the SYS1.SIFALIB
data set
CSQ8UERL USERMOD User modification that moves the CSQ3ECMX IBM.HMS9000.F2
load module into the SCSQLINK data set
You can access the sample installation jobs by performing an SMP/E RECEIVE (refer to 6.3.10, “Perform
SMP/E RECEIVE” on page 42) then copy the jobs from the RELFILES to a work data set for editing and
submission. See Figure 22 on page 35 to find the appropriate relfile data set.
//OFFTAPE JOB
//TALLOC EXEC PGM=IEBCOPY,REGION=124K
//SYSPRINT DD SYSOUT=
//IN DD DSN=IBM.HMS9.F2,
// LABEL=(3,SL),
// UNIT=tapeunit,
// VOL=SER=MS9,
// DISP=OLD
//OUT DD DSN=dhq.UCSQINST,
// DCB=(LRECL=8,RECFM=FB,BLKSIZE=88),
// SPACE=(CYL,(1,1,2)),
// VOL=SER=disvol,UNIT=SYSALLDA,
// DISP=(NEW,CATLG)
//SYSUT3 DD SPACE=(TRK,(5)),UNIT=SYSALLDA
//SYSUT4 DD SPACE=(TRK,(5)),UNIT=SYSALLDA
//SYSIN DD
COPY INDD=IN,OUTDD=OUT
/
//
You have now read all the sample jobs into the data set DHQ.UCSQINST. To confirm that you have the
correct set of jobs, check the list of members in DHQ.UCSQINST against the list in Appendix A, “Customizing
the sample installation manually” on page 57. The next step is to customize the sample jobs for your
system.
Installation Instructions 37
6.3.8 Customize the sample installation JCL
To customize the sample installation JCL use the customization job (CSQ8ASYJ) provided with IBM MQ
for z/OS. If you don't want to use this job and would rather customize the sample installation jobs
manually, see Appendix A, “Customizing the sample installation manually” on page 57.
If you use CSQ8ASYJ, you can customize the sample jobs by adding the names you chose in section
6.3.5, “Prepare to install IBM MQ for z/OS” on page 31 to CSQ8ASYJ in DHQ.UCSQINST and running this
job.
We recommend that you customize all the installation jobs together, although you might not need some of
them until later.
CSQ8ASYJ calls a REXX program to copy and edit the sample jobs from DHQ.UCSQINST to THQ.TCSQINST.
If THQ.TCSQINST does not exist, it is created by CSQ8ASYJ. Full instructions for modifying CSQ8ASYJ are
included in its comments. Where selections are to be made, this is usually done by removing the leading
asterisk.
intact and insert your parameters after the second 'JOB' on this line. If your enterprise does not
require any additional information on the job statement you must still leave this line intact. You can
also add lines such as /*ROUTE or /*JOBPARM by using the JOB keyword.
You can enter more than one line for your JOB statement. Begin each line with the keyword JOB
followed by at least one blank, and type the text as you would expect to see it in the resulting JCL,
including all punctuation such as start of line ‘//’ and end of line commas.
If your enterprise needs a ‘TIME=’ parameter, you must specify a value large enough to run the
SMP/E apply step. This can take up to 120 minutes for IBM MQ for z/OS.
Below is an example of a JOB statement with some additional information:
Whilst the following lines show a case where there is so much information added that a continuation
statement has been created:
Installation Instructions 39
JOB //XXXXXXXX JOB (ACCOUNT),CLASS=A,MSGLEVEL=(1,1),
JOB // USER=USERID,NOTIFY=USERID
6. You can change the default value of the prefix, 'CSQ8', next to the 'JCPREF' keyword. If you change
it to a value that is one to four characters long, the prefix will be concatenated with the last four
characters of the JCL member name to form the job name. If you change the prefix to a value that is
five to eight characters long, the prefix alone will form the job name.
7. Type the values you have chosen for the MQ product high-level qualifiers, where they are different
from the defaults.
8. Type the values you have chosen for your system high-level qualifiers, where they are different from
the defaults.
9. Type the values you have chosen for your volume serial numbers and unit types, where they are
different from the defaults.
To let the system choose the volumes for the target and distribution libraries (TARVOL and DISVOL)
change 'VOLSER' to a '.'. (Quotes should not be used in the JCL). The SMP/E volume and unit type
must be changed to an existing volume name and its actual unit type.
10. Type the SMP/E zone names you have chosen if they are different from the defaults. If you use your
existing SMP/E data sets, you must customize the names of your target zone, distribution zone, and
global CSI data set.
If you intend to let IBM MQ for z/OS create a new SMP/E environment, leave the SMP/E information
as it is. If you are going to use the optional LINK job (see Appendix B, “Enabling automatic relinking
after service is applied” on page 59) you must customize the name of the target zones in which
Language Environment, IBM TCP/IP, and OS/390 callable services are installed.
Specifying NEW for GZONECSI means that the customization step will add the name
SHLQUAL.GLOBAL.CSI for the global zone CSI. If you wish to use a different global zone CSI you
must specify the fully qualified name for GZONECSI.
Choose whether to have SYSMOD JCLIN saved in the distribution zone when SYSMODS are
accepted, by changing the value for ACCJCLIN. This switch sets the ACCJCLIN subentry on the
SMP/E DZONE subentry. The default is YES.
11. Type the file system install path for the IBM MQ for z/OS Unix System Services Components, if it is
different from the default.
12. Run CSQ8ASYJ. It should finish with a return code of 0.
If the return code is not 0, inspect the output to discover what caused the problem:
A return code of 4 may indicate that no FMIDs were selected for installation, or, that one or more
members were truncated during customization.
CSQ8ASYJ can be run again when the error has been corrected, but running it many times might
cause the output data set THQ.TCSQINST to need compressing.
6.3.9.1 High-level assembler consideration: If you create a new global zone, the default
utility for ASM (assembler) will be used for the SMP/E environment. If your site uses the high-level
assembler, you might need to do the following:
1. Add an SMP/E UTILITY for the high-level assembler to your global zone, by uncommenting the lines
below the two comments containing the word HLASM in the CSQ8B0GZ job.
2. Change the CSQ8D0DZ job so that it references the high-level assembler utility entry by
uncommenting the lines below the the comment containing the word HLASM.
6.3.9.3 Target and distribution zones: If you are using the optional LINK job, see Appendix B,
“Enabling automatic relinking after service is applied” on page 59.
If you need to create new target and distribution zones, run the following jobs:
CSQ8C0TZ to create a target zone
CSQ8D0DZ to create a distribution zone
Both jobs consist of a number of steps, all of which should complete with a return code of 0.
Installation Instructions 41
If any of the return codes is not 0, inspect the job output to determine what caused the problem, correct it,
and then rerun the job from the step that failed.
You can also choose to edit and submit sample job CSQ8N0RC to perform the SMP/E RECEIVE for IBM
MQ for z/OS. Consult the instructions in the sample job for more information.
All the RECEIVE jobs should complete with a return code of 0, and the following messages should appear
in the SMPLOG (depending on which features you have decided to install). The example below is from
CSQ8N0RC, similar messages will be seen for any of the other RECEIVE jobs you run:
If the return code is not 0, check the job output listing to find out why the job failed, correct the error, and
then rerun the job.
If the return code is not 0, check the job output carefully to ensure that the data sets have been allocated
correctly. If you need to rerun the job, you must delete any data sets that were created by the
unsuccessful attempt. These all begin with the THLQUAL or DHLQUAL high-level qualifiers. (Be careful not to
delete any SMP/E data sets.)
If you have chosen to install an additional feature, you must also run the appropriate job from the following
list, in the same way that you ran CSQ8E1AL:
All the steps in these jobs should complete with a return code of 0.
Important
During the creation of the mountpoints and the mounting of the file system data sets, the convention
-PathPrefix-/usr/lpp/mountpoint is used. -PathPrefix- allows you to specify a service directory on your
driving system. It is assumed that you will be mounting the IBM MQ for z/OS Unix System Services
Components file system data sets under a service directory which already contains the /usr and
/usr/lpp directories. If this is not the case, you must create the /usr and /usr/lpp directories manually
under your -PathPrefix- directory PRIOR to running the sample commands.
If you choose to allocate separate file system data sets for these components, then 5.2.3, “DASD Storage
Requirements” on page 19 details the sizes required. The file system used may be either zFS or the
older HFS. Sample job CSQ8J8ZF is provided to allocate, format and mount a zFS filesystem. If you
intend to use zFS then follow instructions in 6.3.12.1, “zFS file system for IBM MQ for z/OS Unix System
Services Components” on page 44, for HFS, follow instructions in 6.3.12.2, “HFS file system directories
for IBM MQ for z/OS Unix System Services Components” on page 44 below.
Installation Instructions 43
6.3.12.1 zFS file system for IBM MQ for z/OS Unix System Services Components:
Use sample job CSQ8J8ZF to allocate, format and mount a data set for the zFS filesystem to contain IBM
MQ for z/OS Unix System Services Components then proceed to 6.3.13, “Allocating file system paths” on
page 44.
All the steps in these jobs should complete with a return code of 0.
6.3.12.2 HFS file system directories for IBM MQ for z/OS Unix System Services
Components: The following example JCL fragment illustrates the allocation of an HFS data set,
modify it for your installation standards and submit it.
//CSQ8HFS JOB
// Allocate HFS data set
//ALLOCHFS EXEC PGM=IEFBR14
//HFS DD DSN=zos.dsname,
// UNIT=SYSALLDA,VOL=SER=volser,
// SPACE=(CYL,(6,5,1)),
// DSNTYPE=HFS,
// DISP=(NEW,CATLG)
If you have allocated the optional HFS file system data sets for IBM MQ for z/OS Unix System Services
Components, you must make them available on your driving system for installation. For IBM MQ for z/OS
Unix System Services Components, use the following sample commands to create the mountpoint and
mount the IBM MQ for z/OS Unix System Services Components file system data set:
From TSO:
MOUNT FILESYSTEM('zos.dsname')
MOUNTPOINT('-PathPrefix-/usr/lpp/mqm/V9RM') TYPE(HFS)
MODE(RDWR)
Where 'zos.dsname' is a the name of an z/OS data set allocated to hold the HFS.
Once the file system is available at the correct mount point, edit and submit sample job CSQ8K8MK to
allocate the file system paths for IBM MQ for z/OS Unix System Services Components. Consult the
instructions in the sample job for more information.
All the steps in these jobs should complete with a return code of 0.
This job has 3 steps, and should complete with a return code of 0. If you are installing into existing zones,
this job might give a return code of 8, because it attempts to add DDDEFS that might already exist.
If you have chosen to install the IBM MQ for z/OS Unix System Services Components, you must also run
the job CSQ8M8DD.
Important
The value of SCSQJ900 should not be changed in the TARGDDDF step of CSQ8M8DD. The
CHGPATH step updates the SCSQJ900 value to contain the PATHPREFIX chosen. The value of the
SCSQJ900 DDDEF will be the value you chose for PATHPREFIX suffixed by /IBM.
If the return code is not 0, and you are not installing into existing data sets, check the job output carefully
to ensure that the DDDEFs have been allocated correctly. CSQ8L0DD or CSQ8M8DD can be re-run if
required, but you need to replace the ADD commands with REP.
Before running CSQ8P0AP, ensure that Language Environment load-library SCEERUN is available in the
LNKLIST or uncomment the STEPLIB DD statement in CSQ8P0AP replacing the '++LEQUAL++'
characters with the high level qualifier of the SCEERUN load-library.
Installation Instructions 45
HIPER or FIXCAT APARs, the APPLY CHECK will also identify fixing PTFs that will resolve the APARs, if
a fixing PTF is available.
You should install the FMIDs regardless of the status of unresolved HIPER or FIXCAT APARs. However,
do not deploy the software until the unresolved HIPER and FIXCAT APARs have been analyzed to
determine their applicability. That is, before deploying the software either ensure fixing PTFs are applied
to resolve all HIPER or FIXCAT APARs, or ensure the problems reported by all HIPER or FIXCAT APARs
are not applicable to your environment.
To receive the full benefit of the SMP/E Causer SYSMOD Summary Report, do not bypass the PRE, ID,
REQ, and IFREQ on the APPLY CHECK. The SMP/E root cause analysis identifies the cause only of
errors and not of warnings (SMP/E treats bypassed PRE, ID, REQ, and IFREQ conditions as warnings,
instead of errors).
Products successfully applied result in the following messages in the output listing of CSQ8P0AP,
depending which features you have decided to install:
The job can be rerun, but if one of the FMIDs was successfully applied, you must first delete the lines
from CSQ8P0AP that refer to this product FMID.
To receive the full benefit of the SMP/E Causer SYSMOD Summary Report, do not bypass the PRE, ID,
REQ, and IFREQ on the ACCEPT CHECK. The SMP/E root cause analysis identifies the cause of errors
but not warnings (SMP/E treats bypassed PRE, ID, REQ, and IFREQ conditions as warnings rather than
errors).
Before you use SMP/E to load new distribution libraries, it is recommended that you set the ACCJCLIN
indicator in the distribution zone. In this way, you can save the entries that are produced from JCLIN in the
Installation Instructions 47
distribution zone whenever a SYSMOD that contains inline JCLIN is accepted. For more information about
the ACCJCLIN indicator, see the description of inline JCLIN in the SMP/E Commands book for details.
By default, supplied job CSQ8D0DZ was customized by CSQ8ASYJ in 6.3.8, “Customize the sample
installation JCL” on page 38 to set ACCJCLIN on the DZONE.
Expected Return Codes and Messages from ACCEPT CHECK: You will receive a return code of 0 if
this job runs correctly.
After you take actions that are indicated by the ACCEPT CHECK, remove the CHECK operand and run
the job again to perform the ACCEPT.
Note: The GROUPEXTEND operand indicates that SMP/E accepts all requisite SYSMODs. The
requisite SYSMODS might be applicable to other functions.
If PTFs that contain replacement modules are accepted, SMP/E ACCEPT processing will link-edit or bind
the modules into the distribution libraries. During this processing, the Linkage Editor or Binder might issue
messages that indicate unresolved external references, which will result in a return code of 4 during the
ACCEPT phase. You can ignore these messages, because the distribution libraries are not executable
and the unresolved external references do not affect the executable system libraries.
Expected Return Codes and Messages from ACCEPT: You will receive a return code of 0 if this job
runs correctly.
If the return code is not 0, check the job output listing to find out why the job failed and correct the error.
The job can be rerun, but if one of the FMIDs was successfully accepted, you must first delete the line
from CSQ8Q0AC that refers to this FMID. Products successfully accepted result in the following
messages in the output listing of CSQ8Q0AC depending which features you have decided to install:
For more information about REPORT CROSSZONE, see the SMP/E manuals.
Two separate mechanisms are available for updating the IBM MQ for z/OS target libraries after applying
maintenance to other products:
1. The first uses SMP/E LINK LMODS processing to relink the IBM MQ for z/OS target libraries after
maintenance has been applied on the other products.
This has the advantage that IBM MQ for z/OS libraries are only updated when definite action is taken
on them.
If you choose to use this mechanism, no further action is needed at this stage.
2. The second uses SMP/E cross zone linking.
SMP/E provides a facility to update the SMP/E information for products installed in other SMP/E
zones, so that when maintenance is applied to them, IBM MQ for z/OS target libraries are
automatically updated. IBM MQ for z/OS provides jobs to set up cross zone linking so that SMP/E will
perform automatic cross zone link-editing when service has been applied to the following corequisite
products:
Language Environment
z/OS callable services (which includes APPC)
If you do want to use this facility, see Appendix B, “Enabling automatic relinking after service is
applied” on page 59.
6.3.19 Mount the File System data sets on the target system
Before proceeding with activation, unmount the IBM MQ for z/OS file system data sets on the driving
system, and mount them on the target system at the target system mountpoints. If you have selected the
default mountpoints, you can use the following TSO commands on your target system to mount the zFS
data sets:
MOUNT FILESYSTEM('zos.dsname1')
MOUNTPOINT('/usr/lpp/mqm/V9RM')
TYPE(ZFS) MODE(READ)
A MOUNT command will be required for each of the optional file system data sets you defined in 6.3.12,
“Set up the file system” on page 43.
Installation Instructions 49
You will probably want to add these mounts to your BPXPRMxx members in PARMLIB to ensure that
these data sets are always mounted. If, at a later date, you need to perform service on IBM MQ for z/OS
Unix System Services Components,
Temporarily unmount the file system data sets.
Mount both data sets at the service (-PathPrefix-) mountpoint you created for installation.
Apply the service.
Unmount both data sets from the service mountpoint.
Remount them at the production mountpoints given above.
The customization steps require changes to SYS1.PARMLIB and may need an IPL to activate the
changes. We recommend that you check the preventative service planning information and apply any
APAR fixes that also require an IPL before doing this.
If you are migrating from a previous version of IBM MQ for z/OS, you do not need to perform all the
customization tasks. To find out what you need to do, read the Configuring > Configuring z/OS section of
the MQ product documentation hosted in IBM Knowledge Center about migrating from previous versions.
Installation verification programs are provided with IBM MQ for z/OS. These cannot be run until IBM MQ
for z/OS has been customized and an IBM MQ for z/OS subsystem activated.
If you choose to have the HFS in which you have installed IBM MQ for z/OS mounted in read-only mode
during execution, then no further tasks are required to accomplish this.
The Configuring > Configuring z/OS section of the MQ product documentation hosted in IBM Knowledge
Center contains the step-by-step procedures to activate the functions of IBM MQ for z/OS.
Where dist is the name you allocated for the distribution zone.
Where dist is the name you allocated for the distribution zone and x is the language suffix used in
customizing the job.
Installation Instructions 51
Figure 24 (Page 1 of 3). Library contents after installation
Target library Distribution Description
library
SCSQANLC Load modules - IBM MQ for z/OS Simplified Chinese CHS product code
and utilities
SCSQANLE Load modules - IBM MQ for z/OS US English ENU product code and
utilities
SCSQANLF Load modules - IBM MQ for z/OS French FRA product code and utilities
SCSQANLK Load modules - IBM MQ for z/OS Japanese JPN product code and
utilities
SCSQANLU Load modules - IBM MQ for z/OS Uppercase English ENP product code
and utilities
SCSQASMS ACSQASMS Assembler sample source
SCSQAUTH Load modules - IBM MQ for z/OS product code and utilities
SCSQCICS Load modules required by CICS DFHRPL
SCSQCLST ACSQCLST Sample CLISTS
SCSQCOBC ACSQCOBC COBOL Copybooks (sample and product copybooks)
SCSQCOBS ACSQCOBS COBOL Sample source
SCSQCPPS ACSQCPPS C++ Sample source
SCSQC37S ACSQC37S C/370 Sample source
SCSQC370 ACSQC370 C/370 Headers (sample and product headers)
SCSQDEFS ACSQDEFS Side definitions for C++, the DB2 DBRMs for shared queuing and
language header files from previous releases of WebSphere MQ for
z/OS
SCSQEXEC ACSQEXEC Exec files
SCSQHPPS ACSQHPPS Headers for C++
SCSQINST ACSQINST Install jobs JCL
SCSQLINK Load modules - early code (must be in LPA)
SCSQLOAD Load modules - non APF authorized samples, user exits, IVPs, stubs,
utilities, C++ runtime DLLs.
SCSQMACS ACSQMACS Sample, product, and ZPARM macros
SCSQMAPS ACSQMAPS Sample maps
ACSQMOD Object code library
SCSQMSGC ACSQMSGC IBM MQ for z/OS Simplified Chinese CHS messages to be included in
ISPMLIB concatenation
SCSQMSGE ACSQMSGE IBM MQ for z/OS US English ENU messages to be included in ISPMLIB
concatenation
Installation Instructions 53
Figure 24 (Page 3 of 3). Library contents after installation
Target library Distribution Description
library
SCSQTBLF ACSQTBLF IBM MQ for z/OS French FRA tables to be included in ISPTLIB
concatenation
SCSQTBLK ACSQTBLK IBM MQ for z/OS Japanese JPN tables to be included in ISPTLIB
concatenation
SCSQTBLU ACSQTBLU IBM MQ for z/OS Uppercase English ENP tables to be included in
ISPTLIB concatenation
The distribution libraries for IBM MQ for z/OS Unix System Services Components are ACSQOJSH and
ACSQOJTR.
Installation Instructions 55
56 IBM MQ for z/OS Program Directory
Customizing the sample installation manually
If you want to customize the sample installation jobs manually, these are the jobs that you must
customize:
CSQ8B0GZ Sets up an SMP/E global zone.
CSQ8C0TZ Sets up an SMP/E target zone.
CSQ8D0DZ Sets up an SMP/E distribution zone.
CSQ8E1AL Allocates the IBM MQ for z/OS base product and IBM MQ for z/OS US English ENU target
and distribution libraries.
CSQ8L0DD Defines IBM MQ for z/OS target and distribution libraries to SMP/E.
CSQ8N0RC Runs the SMP/E RECEIVE step for IBM MQ for z/OS. When customizing this job you
must add the list of FMIDs you want to install. Look at the comments in the job for details.
CSQ8P0AP Runs the SMP/E APPLY step for IBM MQ for z/OS. When customizing this job you must
add the list of FMIDs you want to install. Look at the comments in the job for details.
CSQ8Q0AC Runs the SMP/E ACCEPT step for IBM MQ for z/OS. When customizing this job you must
add the list of FMIDs you want to install. Look at the comments in the job for details.
If you are going to use the optional LINK job (described in Appendix B, “Enabling automatic relinking after
service is applied” on page 59) you must also customize:
CSQ8RLKB Customizes the CSQ8SLDQ SMP/E link statement for your system.
CSQ8SLDQ SMP/E link for the base product.
In addition, if you are intending to install support for one of the optional national languages, you must
customize:
CSQ8F2AL Allocates the IBM MQ for z/OS Japanese JPN target and distribution libraries.
CSQ8G3AL Allocates the IBM MQ for z/OS Simplified Chinese CHS target and distribution libraries.
CSQ8H4AL Allocates the IBM MQ for z/OS Uppercase English ENP target and distribution libraries.
CSQ8H5AL Allocates the IBM MQ for z/OS French FRA target and distribution libraries.
If you intend to install IBM MQ for z/OS Unix System Services Components you must customize:
CSQ8I8AL Allocates the distribution libraries for IBM MQ for z/OS Unix System Services Components.
CSQ8J8ZF Create, format, mount and make active a zFS filing system.
CSQ8K8MK Creates the HFS target paths for IBM MQ for z/OS Unix System Services Components.
CSQ8M8DD Defines the target and distribution libraries for IBM MQ for z/OS Unix System Services
Components to SMP/E.
If you want to reduce the number of IBM MQ for z/OS target libraries that need to be added to the link list,
you must customize the following job:
CSQ8UERL A user modification that moves the CSQ3ECMX load module into the SCSQLINK data set,
from the specified language data set.
Finally, if you want to enable the measured usage license charge (MULC) feature, you must customize the
following job:
CSQ8TUBP A user modification that moves the IBM MQ for z/OS exit program into the SYS1.SIFALIB
data set.
Note: The order in which these jobs should be run is described in the following sections:
6.3.9, “Prepare the installation environment” on page 41
6.3.10, “Perform SMP/E RECEIVE” on page 42
6.3.15, “Perform SMP/E APPLY” on page 45
6.3.16, “Perform SMP/E ACCEPT” on page 47
6.4.1, “Enabling measured usage license charges” on page 50
There are a number of other members that may be in DHQ.UCSQINST. You do not need to customize them
manually. They are:
CSQ8ASYJ
CSQ8Z8MK
CSQ8ZLKB
CSQ8ZLKN
CSQ8ZSYR
SET BOUNDARY(GZNAME) .
UCLIN .
ADD GLOBALZONE
ZONEINDEX((TZNAME,HLQS.TZNAME.CSI,TARGET)
(DZNAME,HLQS.DZNAME.CSI,DLIB)) .
ENDUCL .
Where:
GZNAME - The name of the global zone
TZNAME - The name of the target zone
DZNAME - The name of the distribution zone
HLQS - The high-level qualifiers for the target and
distribution zones
The names of the target and distribution zones must be the same in each of the global zones in which
ZONEINDEXs are defined. For example if the MQ target zone name is MQTZON in the MQ global zone
ZONEINDEX, then it must also be MQTZON in the Language Environment global zone ZONEINDEX, and
the z/OS Global zone.
DDDEFs for SCEESPC and SCEELKED are required in the Language Environment target zone. DDDEFs
are required in the z/OS callable services zone for CSSLIB. It is assumed these DDDEF entries were
made during the installation of Language Environment, and z/OS.
The MQ product documentation hosted in IBM Knowledge Center contains the considerations for migrating
queue managers from a previous release. Details of any APARs required for migration can be found
online at:
http://www.ibm.com/support/entry/portal/Planning/Software/WebSphere/WebSphere_MQ.
See C.2, “Tailoring Installation jobs for migration.” for a description of steps required to tailor the
installation jobs, and the jobs to run, to create a new IBM MQ for z/OS Version 9.0.0 target zone in an
existing SMP/E environment.
and
ADD DDDEF(SMPSTS)
DA(SHLQUAL.SMPSTS) SHR .
to
//SMPSCDS DD DSN=SHLQUAL.TZNAME.SMPSCDS,
and
ADD DDDEF(SMPSTS)
DA(SHLQUAL.TZNAME.SMPSTS) SHR .
respectively.
Ensure that the SMPPTS, SMPLOG DDNAMEs and the SMPPTS, SMPLOG and SMPLOGA DDDEFs
set up for the new target and distribution zones reference those which already exist for the global zone
you are reusing.
2. Edit member CSQ8ASYJ of DHQ.UCSQINST paying particular attention to the following customization
variables:
SHLQUAL should be set to the high level qualifier of the existing SMP/E environment which you
want to use.
THLQUAL and DHLQUAL should contain version specific information for the new IBM MQ for
z/OS data sets you will allocate, for example you might choose PP.MQM.V9RM for THLQUAL.
GZONECSI should be the name of your existing SMP/E global zone.
TZNAME and DZNAME should be new target and distribution zone names for installing IBM MQ
for z/OS, for example, you might choose TZMQ9 for TZNAME.
3. See 6.3.8, “Customize the sample installation JCL” on page 38 for further information on further
customizing of the installation JCL.
4. Run CSQ8ASYJ to create customized installation jobs in THQ.THQINST.
5. Edit and submit CSQ8C0TZ to create a new target zone for installation of IBM MQ for z/OS.
6. Edit and submit CSQ8D0DZ to create a new distribution zone IBM MQ for z/OS.
7. Allocate target and distribution libraries by running the data set allocation jobs appropriate for your
installation set. One or more of:
CSQ8E1AL
CSQ8F2AL
CSQ8G3AL
CSQ8H4AL
CSQ8H5AL
CSQ8I8AL
8. Optionally use CSQ8J8ZF to create and mount a ZFS for the USS components installed in JMS9008.
9. Create DDDEF entries for the new target and distribution zones by running CSQ8L0DD. and, if
installing IBM MQ for z/OS Unix System Services Components, CSQ8M8DD.
10. Now run RECEIVE, APPLY and ACCEPT processing as described in 6.3.10, “Perform SMP/E
RECEIVE” on page 42, 6.3.15, “Perform SMP/E APPLY” on page 45 and 6.3.16, “Perform SMP/E
ACCEPT” on page 47.
APAR numbers are provided in this document to assist in locating PTFs that may be required. Ongoing
problem reporting may result in additional APARs being created. Therefore, the APAR lists in this
document may not be complete. To obtain current service recommendations and to identify current
product service requirements, always contact the IBM Customer Support Center or use S/390
SoftwareXcel to obtain the current "PSP Bucket".
IBM may have patents or pending patent applications covering subject matter in this document. The
furnishing of this document does not give you any license to these patents. You can send license
inquiries, in writing, to the
For license inquiries regarding double-byte (DBCS) information, contact the IBM Intellectual Property
Department in your country or send inquiries, in writing, to:
D.1 Trademarks
IBM, the IBM logo, and ibm.com are trademarks or registered trademarks of International Business
Machines Corp., registered in many jurisdictions worldwide. Other product and service names might be
trademarks of IBM or other companies. A current list of IBM trademarks is available on the Web at
"Copyright and trademark information" at www.ibm.com/legal/copytrade.shtml.
Java and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle and/or
its affiliates.
We appreciate your input on this publication. Feel free to comment on the clarity, accuracy, and completeness of the
information or give us any other feedback that you might have.
FAX Number:
From outside the U.K., after your international access code use 44-1962-816151
From within the U.K., use 01962 816151
When you send information to IBM, you grant IBM a nonexclusive right to use or distribute the information in any way
it believes appropriate without incurring any obligation to you.
IBM or any other organizations will only use the personal information that you supply to contact you about the issues
that you submit.
Printed in USA
GI13-3386-1