Local catalog storage program (DFHSMUTL)

The local catalog storage manager domain subpool record manipulation program, DFHSMUTL, is an MVS batch program that adds or removes storage manager domain subpool records to or from the CICS® local catalog data set.

These records are used to store tuning information that CICS uses to determine the optimum sizes of the subpools, and to indicate to CICS which subpools are to have the self-tuning mechanism enabled. You specify the records which you want to add or remove in control statements read from SYSIN (see Local catalog storage program (DFHSMUTL))..

If the local catalog is re-initialized, DFHSMUTL should be run again to add the required subpool records to the local catalog.

Note that deleting and adding a subpool record resets the tuning information for that subpool.

Job control statements to run DFHSMUTL

Control statements are read from SYSIN that specify the storage manager domain subpool records to be added to, or deleted from, the local catalog data set.

The format of the control statements to run DFHSMUTL is as follows:
  1. All commands must start in column 1.
  2. An asterisk in column 1 indicates a comment. Everything else on the line is ignored.
  3. To add a new subpool record to the local catalog, code ADD SUBPOOL=name, where name is the name of the subpool the record is added to (for example, ADD SUBPOOL=ZCTCTUA). There can only be one blank after ADD, and the rest of the line following the subpool name must be blank. The subpool name is not checked for validity.
  4. To delete a subpool record from the local catalog, code DEL SUBPOOL=name, where name is the name of the subpool the record is deleted from (for example, DEL SUBPOOL=ZCTCTUA). There can only be one blank after DEL and the rest of the line following the subpool name must be blank.
  5. To print a list of subpool records from the local catalog, code LST.
The sample JCL shown is to run DFHSMUTL in CICS TS beta.
//SSYLCD JOB (accounting information),
// CLASS=A,MSGCLASS=A,MSGLEVEL=(1,1),USER=userid,NOTIFY=userid
//************************************************************
//*
//* Use DFHSMUTL to add or remove storage manager domain
//* subpool records to or from the local catalog data set
//*
//************************************************************
//SMUTL    EXEC PGM=DFHSMUTL
//STEPLIB  DD DSN=CICSTS64.CICS.SDFHLOAD,DISP=SHR
//SYSPRINT DD SYSOUT=*
//SYSUDUMP DD SYSOUT=*
//DFHLCD   DD DSN=CICSTS64.CICS.applid.DFHLCD,DISP=OLD       1 
//SYSIN    DD *
ADD SUBPOOL=name-of-subpool-to-add                     2 
DEL SUBPOOL=name-of-subpool-to-remove                  3 
LST
/*
//
  1. Change CICSTS64.CICS.applid.DFHLCD to the name of the local catalog.
  2. Example, to enable the self-tuning mechanism for the ZCTCTUA subpool, specify ADD SUBPOOL=ZCTCTUA.
  3. Example, to disable the self-tuning mechanism for the ZCTCTUA subpool, specify DEL SUBPOOL=ZCTCTUA.

Messages from DFHSMUTL

Messages, including errors, are written to SYSPRINT. DFHSM0300 DFHSMUTL REPORT.

  1. ADD SUBPOOL=xxxxxxxx PROCESSED SUCCESSFULLY (ADD SUBPOOL=xxxxxxxx has been processed successfully.)
  2. DEL SUBPOOL=xxxxxxxx PROCESSED SUCCESSFULLY (DEL SUBPOOL=xxxxxxxx has been processed successfully.)
  3. FOUND DFHLCD RECORD SMSUBPOL=xxxxxxxx (Subpool record found by the LST command.)
  4. ERROR OPENING DFHLCD

    An error has occurred opening the local catalog data set. The program is terminated.

  5. UNRECOGNISED VERB xxx IN INPUT (Only ADD, DEL and LST are allowed. The statement is ignored.)
  6. UNRECOGNISED OPERAND xxxxxxxx IN INPUT (Only ADD SUBPOOL=xxxxxxxx or DEL SUBPOOL=xxxxxxxx are allowed. The statement is ignored.)
  7. ERROR PROCESSING 'ADD SUBPOOL=xxxxxxxx'
    .R15 = X'yy'.
    RPL FEEDBACK CODE = X'zz'.
    SEE DFSMS/MVS MACRO INSTRUCTIONS FOR DATA SETS

    ( A VSAM error has occurred while processing an ADD SUBPOOL=xxxxxxxx command. For the meaning of the VSAM codes, refer to z/OS DFSMS Macro Instructions for Data Sets. The program is terminated.)

  8. ERROR PROCESSING 'DEL SUBPOOL=xxxxxxxx'.
    R15 = X'yy'.
    RPL FEEDBACK CODE = X'zz'.
    SEE DFSMS/MVS MACRO INSTRUCTIONS FOR DATA SETS

    (A VSAM error has occurred while processing a DEL SUBPOOL=xxxxxxxx command. For the meaning of the VSAM codes, refer to z/OS DFSMS Macro Instructions for Data Sets. The program is terminated.)

  9. END OF DFHSMUTL REPORT (Report trailer.)