JCL requirements for the Catalog Manager utility

When you code JCL for the Catalog Manager utility, include the EXEC statement and appropriate DD statements.

Subsections:

JCL example

The following figure shows a JCL example that you can use to run the Catalog Manager utility program.

Figure 1. Catalog Manager utility example JCL: validating DBDs and PSBs
//CATMANJ  JOB ..... 
//STEP     EXEC PGM=FABXCATM 
//STEPLIB  DD DSN=HPS.SHPSLMD0,DISP=SHR
//         DD DSN=IMS13.SDFSRESL,DISP=SHR
//DFSRESLB DD DSN=IMS13.SDFSRESL,DISP=SHR
//IMS      DD DSN=PROD.PSBLIB,DISP=SHR
//         DD DSN=PROD.DBDLIB,DISP=SHR
//DFSVSAMP DD *
0512,9
1024,9
2048,9
4096,9
16384,9
32768,9
IOBF=(2048,4,N,N)
IOBF=(4096,4,N,N)
IOBF=(8192,4,N,N)
IOBF=(32000,4,N,N)
/*
//PROCLIB  DD DSN=IMS13.PROCLIB
//RECON1   DD DSN=PROD.RECON1,DISP=SHR
//RECON2   DD DSN=PROD.RECON2,DISP=SHR
//*
//ACBLIB   DD DSN=PROD.ACBLIB
//FABXPPRM DD * 
DLI,FABXCATM,DFSCPL00,,,,,,,,,,,Y,N,,,,,,,,,,,,,DFSDF=CAT
//FABXCIN DD *
  PROC   FUNC=CHECK_GENTIME
  DBD NAME=*               
  PSB NAME=*               
  END                      
/*

In this example, it is assumed that the DFSDFxxx PROCLIB member and RECON data sets were used to configure the environment for the IMS™ catalog. When you code the JCL, add appropriate DD statements based on how you configured the IMS catalog environment. This applies, for example, if you used the Catalog Definition exit routine (DFS3CDX0) or the IMS catalog partition definition data set (DFSHDBSC) to configure the environment for the IMS catalog.

EXEC statement

The EXEC JCL statement must specify the FABXCATM program. No PARM operand is required.

//stepname EXEC PGM=FABXCATM

You can specify IMSPlex name and a group of DBRC instances to access the RECON data set. Here is an example of the statement:

//stepname EXEC PGM=FABXCATM,PARM='IMSPLEX=imsplex,DBRCGRP=dbrcgrp'
IMSPLEX=imsplex
A 1 - 5 character IMSplex name used for RECON data sets.
DBRCGRP=dbrcgrp
A 1 - 3 character identifier (ID) assigned to a group of DBRC instances that access the same RECON data set in an IMSplex.

DD statements

Code the following DD statements to identify the source of input and the placement of output information:

STEPLIB DD or JOBLIB DD
Start of changeRequired input data set. Specify the LIU load module library data set, which contains the Catalog Manager utility, and the IMS.SDFSRESL data set. To use the following functions, you must also specify the SGLXLOAD library of IMS Tools Base V1.6 or later:
  • Compare function
  • Convert function
  • Validate function (SGLXLOAD library is required only if you want to check the resources in IMS directory data sets)

Optionally, specify the following resources:

  • If you use the Catalog Definition exit routine (DFS3CDX0), specify the load module data set that contains the exit routine.
  • If you want the RECON data sets, IMS bootstrap data set, or the DFSHDBSC data set to be dynamically allocated, specify the MDA library.
  • If you use the SCI exit routine for your IMS environment, specify the load module data set that contains the exit routine.
End of change
DFSRESLB DD
Start of changeOptional input data set. If you specify the DLI keyword in the FABXPPRM data set, you must specify this DD statement. Specify the IMS.SDFSRESL data set. End of change
IMS DD
Start of changeOptional input data set. If you specify the DLI keyword in the FABXPPRM data set, you must specify this DD statement. Specify the PSB and DBD libraries that contain the DBDs and PSBs for the IMS catalog.End of change
DFSVSAMP DD
Start of changeOptional input data set. If you specify the DLI keyword in the FABXPPRM data set, you must specify this DD statement. Specify the buffer pool parameters data set.End of change
RECON1 DD
RECON2 DD
RECON3 DD
Optional input data sets. Specify the RECON data sets if the IMS catalog database is registered in the RECON data sets.
PROCLIB DD
Optional input data set. Specify the IMS.PROCLIB data set that contains the DFSDFxxx member if a DFSDFxxx member is used for the IMS catalog.
DFSHDBSC DD
Optional input data set. Specify the IMS catalog partition definition data set (DFSHDBSC) if the IMS catalog was defined with the IMS Catalog Partition Definition Data Set utility (DFS3UCD0).
ACBLIB DD
Required input data set when using the utility to perform either of the following functions:
  • Start of changeValidate the consistency of DBDs and PSBs in the IMS catalog with ACBs in ACB libraries. Specify one or more ACB libraries that contain the DBD and PSB members to validate.End of change
  • Compare ACBs in the IMS directory with those in ACB libraries. Specify one or more ACB libraries that contain the DBD or PSB members to compare.
DBDLIB DD
Required input data set when using the utility to compare ACBs in the IMS catalog with DBDs in DBD libraries. Specify one or more DBD libraries that contain the DBD members to compare with the IMS directory.
PSBLIB DD
Required input data set when using the utility to compare ACBs in the IMS catalog with PSBs in PSB libraries. Specify one or more PSB libraries that contain the PSB members to compare with the IMS directory.
FABXPPRM DD
Start of changeOptional input statement. If you do not use the Catalog Definition exit routine (DFS3CDX0), you must specify this DD statement. Specify the parameters for the IMS region controller DFSRRC00.

Catalog Manager runs as a z/OS® batch job, and it invokes DFSRRC00 to issue DL/I calls to the IMS catalog database. The parameters in FABXPPRM DD are given to DFSRRC00.

The format of the parameters is the same as the DFS3PPRM DD statement for the ACB Generation and Catalog Populate utility (DFS3UACB). You can reuse the parameters that you specify in the DFS3PPRM data set.

Related reading: For more information, see the topic "ACB Generation and Catalog Populate utility (DFS3UACB)" in IMS System Utilities.
DL/I

The parameters must include the name of the DFSDFxxx PROCLIB member that contains the processing options for the IMS catalog. Here is an example of the parameters:

//FABXPPRM DD *
DLI,FABXCATM,DFSCP000,,,,,,,,,,,Y,N,,,,,,,,,,,,,DFSDF=CAT
/*

If you specify DLI and the IMS catalog is shared, you must specify IRLM support in the parameters. In the following example, the second Y and irlmid value indicate IRLM support:

//FABXPPRM DD *
DLI,DFS3PU00,DFSCP000,,,,,,,,,,,Y,Y,irlmid,,,,,,,,,,,'DFSDF=001'
/*

You can specify the IMSPlex name and the group of DBRC instances that access the RECON data set to the FABXPPRM DD statement. Here is an example of the parameters:

//FABXPPRM DD *
DLI,FABXCATM,DFSCP000,,,,,,,,,,,Y,N,,,,,,,,,,,imsplex,,DFSDF=CAT,DBRCGRP=dbrcgroup
/*

If you specify the IMSPlex name and the group of DBRC instances on both the EXEC statement and the FABXPPRM DD statement, the parameters on the FABXPPRM DD statement are used.

If the Catalog Definition exit routine (DFS3CDX0) is used, you can omit the FABXPPRM DD statement. If DFS3CDX0 is not used and you omit the FABXPPRM DD statement, the Catalog Manager utility uses the following statement as the default:
//FABXPPRM DD *
DLI,FABXCAPL,DFSCP000,,,,,,,,,,,Y,N,,,,,,,,,,,,,DFSDF=CAT
/*
BMP

If the IMS control region is active on the same LPAR as the Catalog Manager utility job, you can specify the BMP keyword. Here is an example of the parameters:

//FABXPPRM DD *                                
BMP,FABXCATM,DFSCP000,,,,,,,,,,,imsid,,,,,,               
/*

When you specify the BMP keyword in the FABXPPRM data set, the Catalog Manager utility behaves as follows:

  • Displays asterisks (***) for some fields (such as IMS ID, ALIAS OF CATALOG DB) in the IMS Catalog Environment report.
  • If the IMS control region is inactive, issues message DFS690A.

For both DL/I and BMP, you can specify any value for the second and third positional parameters because the Catalog Manager utility uses the following values for these parameters:

  • The name of an internal LIU program for the second parameter.
  • DFSCP000 for the third parameter.
End of change
FABXCIN DD
Required input data set. Specify the data set that contains the control statements for the Catalog Manager utility. The DCB parameters must be RECFM=FB, LRECL=80, and BLKSIZE must be a multiple of 80.
Related reading: For information about the control statements of the Catalog Manager utility, see Control statements for the Catalog Manager utility.
FABXCRP0 DD
FABXCRP1 DD
FABXCRP2 DD
Optional output data sets. Specify these data sets for Catalog Manager utility reports. The DCB parameters must be RECFM=FBA, LRECL=133, and BLKSIZE must be a multiple of 133.

If the DD statements are not specified, the Catalog Manager utility allocates SYSOUT=* to the DD statements and generates the reports.

Related reading: For information about the reports that are generated by the Catalog Manager utility, see Output from the Catalog Manager utility.
FABXCSRC DD
Optional output data set. This data set is used only for the convert function. Specify the data set in which the utility generates IMS DBDGEN control statements and IMS PSBGEN control statements. The DCB parameters must be RECFM=FB, LRECL=80, and BLKSIZE must be a multiple of 80.
DBDSRC DD
PSBSRC DD
Optional output data sets. These data sets are used only for the convert function. Specify the data sets in which the utility generates IMS DBDGEN control statements and IMS PSBGEN control statements. DBDSRC DD is for DBD members and PSBSRC DD is for PSB members. These data sets should be PDS or PDSE. The record format is fixed-blocked, and the logical record length is 80. The block size, if coded, must be a multiple of 80.

IMS DBDGEN and IMS PSBGEN control statements generated in these data sets are identical to those generated in the FABXCSRC data set, but in DBDSRC and PSBSRC data sets, a data set member is created for each DBD or PSB.

SYSUDUMP DD
SYSABEND DD
SYSMDUMP DD
Optional output data sets. Define dump data sets.
Parent topic: Catalog Manager utility