Defining the local catalog

CICS® domains use the local catalog to save some of their information between CICS runs and to preserve this information across a cold start. The local catalog is a VSAM key-sequenced data set (KSDS). The local catalog is not shared by any other CICS region.

Unlike the global catalog, which must be defined with enough space to cope with any increase in installed resource definitions, the size of the local catalog is relatively static.

For information about what is written to the local catalog and about how CICS uses the local catalog for startup and restart, see Cataloging CICS resources.

About this task

You can define and initialize the CICS local catalog in two ways:

You can use the sample job as described in the Procedure section below.
You can use the CICS-supplied job, DFHDEFDS to create a local catalog for an active CICS region.

Procedure

Edit the sample job as follows:

If you are defining local catalogs for multiple CICS regions, identify the clusters uniquely by making the specific APPLID of each CICS one of the data set qualifiers.
For example, you might use the following names for the clusters of active and alternate CICS regions, where DBDCCIC1 and DBDCCIC2 are the specific APPLIDs and the prefix reflects the release of CICS TS. In the following example, the release level of CICS TS is assumed to be CICS TS 6.2.
```
DEFINE CLUSTER -
       (NAME( CICSTS62.CICS.DBDCCIC1.DFHLCD)

DEFINE CLUSTER -
       (NAME( CICSTS62.CICS.DBDCCIC2.DFHLCD)
```
Space for 200 records is probably adequate for the local catalog. However, specify space for secondary extents as a contingency allowance.
The local catalog records are small in comparison with the global catalog. Use the record sizes shown, which, with the number of records specified, ensure enough space for the data set.
Define the data definition statement for the local catalog as follows, where the prefix reflects the release of CICS TS. In the following example, the release level of CICS TS is assumed to be CICS TS 6.2.
```
//DFHLCD  DD  DSN=CICSTS62.CICS.applid.DFHLCD,DISP=OLD
```

Sample job to define and initialize the local catalog

In the example JCL, the high level qualifier (CICSTSnn.CICS) assumes the release level of CICS TS 6.2. You must adapt it for your own CICS release.

Figure 1. Sample job to define and initialize the local catalog

//LOCAT    JOB accounting info,,CLASS=A
//DEFLCD   EXEC PGM=IDCAMS
//SYSPRINT DD SYSOUT=*
//SYSIN    DD *
         DEFINE CLUSTER -
                (NAME( CICSTS62.CICS.applid.DFHLCD) -  
                 INDEXED                       -
                 RECORDS( 200 10 )             -                  
                 FREESPACE(10 10)              -
                 SHAREOPTIONS( 2 )             -
                 REUSE                         -
                 VOLUMES( volid ))             -
           DATA                                -
                (NAME( CICSTS62.CICS.applid.DFHLCD.DATA )   -
                 KEYS( 52 0 )                  -
                 RECORDSIZE( 70 2041 )         -                  
                 CONTROLINTERVALSIZE( 2048 ))  -
           INDEX (NAME( CICSTS62.CICS.applid.DFHLCD.INDEX ) )
/*
//*****************************************************************
//INITLCD EXEC PGM=DFHCCUTL
//*
//*            INITIALIZE THE CICS LOCAL CATALOG
//*
//STEPLIB   DD DSN=CICSTS62.CICS.SDFHLOAD,DISP=SHR
//SYSPRINT  DD SYSOUT=*
//SYSUDUMP  DD SYSOUT=*
//DFHLCD    DD DSN=CICSTS62.CICS.applid.DFHLCD,DISP=SHR
//*
//

What to do next

Before the local catalog can be used to start a CICS region, you must initialize it with data from the domain manager parameter records and three loader domain parameter records. For details, see Initializing the local catalog.

Some of the information that is saved in the local catalog can be overridden at CICS system initialization by system initialization parameters, such as CICS transaction dump data set status.

If you delete and redefine the local catalog, you must follow these steps:

Initialize the local catalog with an initial set of domain records.
Use the CICS-supplied utility program, DFHSMUTL, to re-add records to enable the CICS self-tuning mechanism for storage manager domain subpools. For details of how to do this, see Local catalog storage program (DFHSMUTL).
Delete and reinitialize the global catalog.

Note: If you need to reinitialize the local catalog for any reason, you must also reinitialize the global catalog.