Cleaning up old collection data via housekeeping

You can use the C\Prof housekeeping utility to delete transaction data collected by C\Prof that has aged past a pre-defined retention period. Housekeeping can only be run on dynamically allocated data sets. You cannot use housekeeping with Generation Data Groups (GDGs). Before you run housekeeping, you must first add the retention period attribute. Review the following sections to learn how.

Preparing your configuration file for housekeeping

To prepare your C\Prof collection server configuration file for housekeeping, complete the following steps:

1. Open your collector configuration file.

2. Add the RETPD=retention-period parameter to each SUMMARY, DETAIL, and AUXILIARY control statements (if present), where retention-period is the length of time that the data set is to be retained for.

   Note: RETPD is not a data set allocation attribute. It is only used by the C\Prof housekeeping task to determine which data sets have expired and should be deleted.

   The following example sets a retention period of 100 days for summary data sets and 20 days for all other data set types before they are eligible for housekeeping:

   ...
   CHECKPT=MY.CICS.CHECKPT                  /* Used to locate data sets
   
   ARCHDSN=CPROF.+CICS.+TYPE(+1)
   SUMMARY SPACE=(CYL,10) RETPD=100 DAYS    /* Retain for 100 days
   DETAIL SPACE=(CYL,50) RETPD=20 DAYS      /* Retain for 20 days
   AUXILIARY SPACE=(CYL,32) RETPD=20 DAYS   /* Retain for 20 days
   ...
   

   Specifying data set retention periods

   Note: You can also set unique retention periods for specific CICS regions and groups by inserting SUMMARY, DETAIL, and AUXILIARY control statements directly after a GROUP or CICS control statement. More information on the RETPD option can be found in RETPD.

3. Save and close the configuration file.

Running the housekeeping task

C\Prof has a housekeeping task that you can run to delete registered data sets that have aged past a pre-defined retention period. To execute this task, add the PARM= HOUSEKEEPING option to the EXEC statement for the C\Prof utility program, TXCMAIN. An example job is supplied below:

//CPROFHKP JOB ,
/*JOBPARM SYSAFF=SYS1
//*
//S1 EXEC PGM=TXCMAIN,PARM='HOUSEKEEPING'
//STEPLIB DD DISP=SHR,DSN=TXC.V1R2M0.STXCLINK
//SYSPRINT DD SYSOUT=*
//SYSIN DD DISP=SHR,DSN=USR.TXC.CONFIG(CONFIG1)

JCL to perform housekeeping on archive data sets

The JCL contains the following elements:

• S1 EXEC statement

  The C\Prof utility program TXCMAIN with the HOUSEKEEPING parameter.

• STEPLIB

  The C\Prof link library STXCLINK.

• SYSPRINT

  The utility message log. C\Prof messages that appear in the SYSPRINT are described in Messages and Codes.

• SYSIN

  The C\Prof configuration file. The housekeeping task will use the CHECKPT and RETPD control statements to determine which data sets to delete.

  For example, to delete all summary, detail, and auxiliary trace data sets registered in checkpoint data set USR.CONFIG.CHECKPT that are older than 7 days, your configuration file might include the following statements:

  ...
  CHECKPT=USR.CONFIG.CHECKPT              /* Used to locate data sets
  ARCHDSN=USR.+CICS.+TYPE(+1)
  SUMMARY SPACE=(CYL,10) RETPD=7 DAYS     /* Retain for 7 days
  DETAIL SPACE=(CYL,50) RETPD=7 DAYS      /* Retain for 7 days
  AUXILIARY SPACE=(CYL,32) RETPD=7 DAYS   /* Retain for 7 days
  ...
  

  Control statements used by housekeeping