Control-M/Analyzer Utilities

This chapter provides a detailed description of the Control-M/Analyzer utilities.

CTBABI – Initialize Active Balancing File

The CTBABI utility initializes both the Active Balancing file and its backup file, ABFBKP. Activate the CTBABI utility whenever the IOADBF utility reformats these files.

CTBABI Parameter

The following parameter must be specified in the EXEC statement that invokes the CTBABI JCL procedure:

Table 165 CTBABI Parameter

Activating the CTBABI Utility

//    EXEC CTBABI, DBFILEB=[ABF|ABFBKP]

CTBABI Return Codes

Table 166 CTBABI Return Codes

Example for CTBABI

//    EXEC CTBABI,DBFILEB=ABF

CTBCMP – Compile Rule Definitions

The CTBCMP utility checks the syntax of rule definitions. It is especially useful for checking rule definitions created using a standard editor.

CTBCMP Parameters

Parm='-irulename'

where rulename is the name of the rule definition that must be checked for syntax errors. The rule name is preceded by the prefix –i (that can be uppercase or lowercase). The rule name and the –i prefix must be specified between quotes.

Activating the CTBCMP Utility

//    EXEC CTBCMP,PARM='-irulename'

CTBCMP Return Codes

Table 167 CTBCMP Return Codes

Example for CTBCMP

//    EXEC CTBCMP,PARM='-ICOMPTOTS'
//DABRUL DD DISP=SHR,DSN=CTB.PROD.RULES

CTBDBCP – Increase Size of a Database File

This utility copies the contents of a specified source file to a specified target file. All relevant aspects of the file are copied, including (pointers to) variable definitions, variable generations, and group information.

The sizes of the source and target files can differ. Therefore, the CTBDBCP utility is useful for increasing the size of a file. Usually, this utility copies data from a source file to a larger target file.

Copying a file is composed of the following stages:

• Create and format a new file (target file).

• Copy the data from the source file to the newly created target file.

• Delete the source file.

The CTBDBVCP utility can modify all Control-M/Analyzer database files simultaneously. However, the CTBDBCP utility is more efficient than the CTBDBVCP utility when modifying a single file.

CTBDBCP Parameters

The following parameters must be specified in the EXEC statement that invokes the CTBDBCP JCL procedure:

Table 168 CTBDBCP Parameters

Activating the CTBDBCP Utility

//  EXEC IOADBF,FUNC=INIT,D=INSTWORK,M=DEFxxxD           allocate new file
//  EXEC CTBDBCP,DBFILE=xxx,OLDQNAME=qname,KEY=KEYyyy   copy old contents

Valid values for xxx and yyy are:

Table 169 CTBDBCP File Type Values

CTBDBCP Return Codes

Table 170 CTBDBCP Return Codes

Procedure CTBDBCP

Member CTBDBCP of the IOA PROCLIB library contains a procedure that calls a series of programs to automatically enlarge a database file. The following explanation assumes that the name of the file that needs to be enlarged is ...GRPD. Before using this procedure, perform the following steps:

1. Rename the source input file from ...GRPD... to ...GRPD...OLD. For example, rename file CTB.V600.GRPD.E000 to CTB.V600.GRPD.E000.OLD

2. If DUAL is set to Y (Yes) in member DEFGRPD in the INSTWORK library, rename file CTB.V600.GRPD.D000 to CTB.V600.GRPD.D000.OLD.

3. Modify member DEFGRPD in the INSTWORK library by increasing the space allocated for the file.

4. Run the job in member JOBFGRP of the CTB.V6xx.JCL library.

When the procedure described above is called, the following actions are performed:

1. Program IOADBF formats a new pre-allocated IOA Access Method output file.

2. Program CTBDBCP copies data from the input file to the output file.

3. Program IOADIG verifies the integrity of the output file data component.

4. Program IOADBF reformats the existing index component for the file.

5. Program IOADIB rebuilds the index component.

6. Program IOADPT prints index and data component control records to the output file.

For additional information, see sample member JDBCP in the JCL library.

CTBDBIB – Rebuild a Control-M/Analyzer Index File

The CTBDBIB utility rebuilds index files for various Control-M/Analyzer data files. The new index files correspond to information contained in the data files.

This utility rebuilds the indexes of a specific data file.

This utility is used

• When the space remaining for the existing index file is insufficient. In this case

Delete the index file.

Redefine the index file with the required amount of space.

Format the index file with the IOADBF utility.

Rebuild the index file with the CTBDBIB utility.

• In case of index file integrity problems: Index file integrity problems can be detected using the IOADII utility, described later in this guide.

• In case of data file integrity problems: Correct the data file and re-index it with the CTBDBIB utility to reproduce the corresponding index file.

CTBDBIB Parameter

The following parameter can be specified in the EXEC statement that invokes the CTBDBIB JCL procedure:

Table 171 CTBDBIB Parameter

Activating the CTBDBIB Utility

//     EXEC CTBDBIB,DBFILE=xxxD
//DADBS  DD DISP=SHR,DSN=CTB.PROD.xxxD.E000                       
//DAyyy  DD DISP=SHR,DSN=CTB.PROD.xxxI.E000                       
//SYSIN  DD DSN=CTB.PROD.PARM(KEYyyy),DISP=SHR

Valid values for xxx and yyy are:

Table 172 CTBDBIB Values

CTBDBIB Return Codes

Table 173 CTBDBIB Error Codes

Example for CTBDBIB

//      EXEC  CTBDBIB,DBFILE=GRPD
//SYSIN   DD  DSN=CTB.PROD.PARM(KEYGRP),DISP=SHR
//DAGRP   DD  DSN=CTB.PROD.GRPI,DISP=SHR

The CTBDBIB utility is used by the following jobs in the JCL library. For additional examples, see the following jobs:

Table 174 CTBDBIB Jobs

CTBDBVCG – Change Number of Variable Generations

The CTBDBVCG utility changes the maximum number of generations specified for one or more database variables. It is useful whenever the number of generations must be changed but is most often used when changing the status (mode) of variables from test to production. The utility can be invoked in batch mode as described in "Activating the Utility."

The number of generations to be retained in the database can be increased or decreased. The content of existing variable generations can be retained or deleted. All other relevant aspects of the variables are retained, including definitions and group information.

It is possible to change the number of generations of all variables, groups of variables (with a common group name prefix), or one or more variables of the same group (with a common variable name prefix) in one activation of the CTBDBVCG utility.

CTBDBVCG Parameters

The following parameters can be specified in the EXEC statement that invokes the CTBDBVCG JCL procedure. These parameters dynamically specify source (input) file names and indicate whether the current content of existing generations must be retained or deleted.

Table 175 CTBDBVCG EXEC Parameters

Parameters can also be supplied using DD statement SYSIN. The following parameters are mandatory:

Table 176 CTBDBVCG SYSIN Parameters

GROUP—INV

GROUP—INV*

Activating the CTBDBVCG Utility

Figure 64 CTBDBVCG Activation

//  EXEC CTBDBVCG,DIMOD=mod,DIVAR=var,DIGRP=grp,COPY=YES|NO
//SYSIN  DD *
  GROUP=group
  VARIABLE=variable
  NUMGEN=new-maximum-#-of-generations
//

CTBDBVCG Return Codes

Table 177 CTBDBVCG Return Codes

Example for CTBDBVCG

//    EXEC  CTBDBVCG,DIMOD=MGMT,DIVAR=ACTG,DIGRP=TAX,COPY=YES
//SYSIN  DD *
  GROUP=BONDS
  VARIABLE=COST*
  NUMGEN=24
//

CTBDBVCP – Copy Variables or Groups to another File

The CTBDBVCP utility copies the contents of specified group or variable files (meaning, data from source files) to another set of group or variable files (meaning, target files). All relevant aspects of the variables are copied, including definitions, generations and group information.

The sizes of the source and target files can differ. Therefore, the CTBDBVCP utility is useful for increasing the size of variable files. Usually, this utility copies variables from source files to larger target files.

Copying variables is composed of the following stages:

• Create and format a new set of group or variable files (target files).

• Copy the data from the source files to the newly created target group or variable files.

• Delete the source files.

It is possible to copy all variables, groups of variables (with a common group name prefix), or one or more variables of the same group (with a common variable name prefix) in one activation of the CTBDBVCP utility.

CTBDBVCP Parameters

The following parameters can be specified in the EXEC statement that invokes the CTBDBVCP JCL procedure. These parameters dynamically specify the prefix of the third qualifier for the source and destination files listed below:

Table 178 CTBDBVCP EXEC Parameters

Parameters can also be supplied using DD statement SYSIN. Only one parameter can be specified on each line.

Table 179 CTBDBVCP SYSIN Parameters

INV 

INV* 

GROUP=INV VARIABLE=TOT

GROUP=INV VARIABLE=TOT*

Activating the CTBDBVCP Utility

// EXEC CTBDBVCP [DIMOD, DIVAR, DIGRP, DOMOD, DOVAR, DOTRP, 
REPLACE=YES|NO, COPY=YES|NO]

CTBDBVCP Return Codes

Table 180 CTBDBVCP Return Codes

Example for CTBDBVCP

//      EXEC CTBDBVCP,DIMOD=MOD,DIVAR=VAR,DIGRP=GRP,
//      DOMOD=TARGMOD,DOVAR=TARGVAR,DOGRP=TARGGRP
//  SYSIN DD*
  GROUP=CURRENCY
  VARIABLE=TOT*
//

For additional information, see sample member JOBDBVCP in the JCL library.

CTBDBVDL – Delete Variables or Groups from Variable or Group Files

The CTBDVBDL utility deletes specified records from Control-M/Analyzer Database Variable files. Mandatory.

CTBDBVDL Parameters

The following parameters can be specified in the EXEC statement that invokes the CTBDBVDL JCL procedure. These parameters provide dynamic specification of source and destination file names:

Table 181 CTBDBVDL EXEC Parameters

Parameters can also be supplied using DD statement SYSIN. Only one parameter can be specified on each line.

Table 182 CTBDBVDL SYSIN Parameters

Activating the CTBDBVDL Utility

// EXEC CTBDBVDL

CTBDBVDL Return Codes

Table 183 CTBDBVDL Return Codes

Example for CTBDBVDL

// EXEC CTBDBVDL,DMOD=MOD,DVAR=VAR,DGRP=GRP,DELGR=YES
// SYSIN DD *
  GROUP=CURRENCY
  VARIABLE=TOT*
//

CTBDBVIG – Check the Integrity of Variable or Group Files

The CTBDBVIG utility checks the integrity of the Database Variable Basic and Generation files. The utility reports errors that are detected in the logical organization of these files. Optionally, CTBDBVIG corrects errors that are detected. File integrity errors are listed in the sysout of the job.

CTBDBVIG Parameters

You can specify the following parameters in the EXEC statement that invokes the CTBDBVIG JCL procedure:

Table 184 CTBDBVIG EXEC Parameters

Activating the CTBDBVIG Utility

// EXEC CTBDBVIG DMOD=dmod,DVAR=dvar,DGRP=dgrp[,DELGR=YES|NO]

CTBDBVIG Return Codes

Table 185 CTBDBVIG Return Codes

Example for CTBDBVIG

// EXEC CTBDBVIG,ACT=R

CTBFRM – Compress the Active Balancing File

The CTBFRM utility compresses the Active Balancing file. The utility usually runs as part of the New Day procedure before potential missions are placed as entries in the Active Balancing file. The utility can also be run as a stand-alone job when parameter FORCE is set to Y.

The utility deletes entries from the Active Balancing file that are no longer processed by Control-M/Analyzer. The Active Balancing file is then compressed.

A backup of the Active Balancing file is created automatically by this utility.

CTBFRM Parameters

Table 186 shows the values that are valid for the parameters specified in the EXEC statement that invokes the CTBFRM JCL procedure.

Table 186 CTBFRM Parameters

Activating the CTBFRM Utility

// EXEC CTBFRM,DATABFB=balfile,DTBBKPB=backup file,FORCE={Y|N}

CTBFRM Return Codes

Table 187 CTBFRM Return Codes

Example for CTBFRM

// EXEC CTBFRM,FORCE=N,DBABFB=ABF,DBBKPB=ABFBKP

For additional information, see sample member JOBFRM in the JCL library.

CTBJAFCP – Copies Entries in Rule Activity or Report Files

The CTBJAFCP utility copies invocation and report entries to other Rule Activity and/or Report files.

CTBJAFCP Parameters

Table 188 CTBJAFCP Parameter

The following parameters can be specified in the EXEC statement that invokes the CTBJAFCP JCL procedure:

Table 189 CTBJAFCP EXEC Parameter

INCLUDE / EXCLUDE Statements (CTBJAFCP)

INCLUDE / EXCLUDE statements are supplied using DD statement SYSIN. The suffix * is permitted at the end of any of these parameters. * represents any number of characters (including no characters).

The scope of the copy can be limited by one or more INCLUDE / EXCLUDE statements. Each INCLUDE / EXCLUDE statement contains job name prefixes that limit the entries that are copied. If one or more INCLUDE statements are specified, only entries specified in the INCLUDE statements are copied. If one or more EXCLUDE statements are specified, the entries specified in the EXCLUDE statements are not copied. There is an OR relationship between multiple INCLUDE statements and between multiple EXCLUDE statements.

Each INCLUDE / EXCLUDE statement must be listed on a separate line.

Parameter JOBNAME can be specified in INCLUDE / EXCLUDE statements. This parameter represents the job name.

Activating the CTBJAFCP Utility

// EXEC CTBJAFCP FILE={JAF|REP|ALL}
// SYSIN DD       *
//

CTBJAFCP Return Codes

Table 190 CTBJAFCP Return Codes

Example for CTBJAFCP

// EXEC CTBJAFCP,FILE=ALL,DBJAFI=JAF,DBREPI=REP,DBJAFO=JAFNEW,DBREPO=REPNEW
// SYSIN  DD *
  INCLUDE JOB2*
  EXCLUDE JOB22
  EXCLUDE JOB23*
//

For additional information, see sample member JOBJAFCP in the JCL library.

CTBJAFDL – Deletes Entries from Rule Activity or Report Files

The CTBJAFDL utility cleans unnecessary entries from the Rule Activity file and/or the Report file.

CTBJAFDL Parameters

The following parameters can be specified in the EXEC statement that invokes the CTBJAFDL JCL procedure:

Table 191 CTBJAFDL EXEC Parameters

The following parameters are supplied using DD statement SYSIN. The suffix * is permitted at the end of any of these parameters. * represents any number of characters (including no characters).

Table 192 CTBJAFDL SYSIN Parameters

Parameter JOBNAME can be specified in INCLUDE or EXCLUDE statements. This parameter represents the job name.

Each INCLUDE or EXCLUDE statement must be listed on a separate line.

Activating the CTBJAFDL Utility

Figure 69 CTBJAFDL Activation

// EXEC  CTBJAFDL,DBJAFB=jaf prefix,DBREPB=rep prefix,PRINT=PRINT|NOPRINT
// SYSIN  DD *
 DAYS n
 [INCLUDE {PARAMETERS}]
 [EXCLUDE {PARAMETERS}]
//

CTBJAFDL Return Codes

Table 193 CTBJAFDL Return Codes

Example for CTBJAFDL

// EXEC CTBJAFDL,DBJAFB=JAF,DBREPB=REP,PRINT=PRINT
// SYSIN DD *
  DAYS 4
  INCLUDE JOB2*
  EXCLUDE JOB22
  EXCLUDE JOB23*
//

CTBJAFIG – Check the Integrity of Rule Activity or Report Files

The CTBJAFIG utility checks the integrity of Rule Activity and Report files. The utility reports errors detected in the logical organization of these files. If requested, utility CTBJAFIG corrects the errors that are detected. File integrity errors are listed in the sysout of the job.

CTBJAFIG Parameters

The following parameters can be specified in the EXEC statement that invokes the CTBJAFIG JCL procedure:

Table 194 CTBJAFIG EXEC Parameters

Activating the CTBJAFIG Utility

// EXEC CTBJAFIG FILE={JAF|REP|BTH|ALL}[C={Y|N}]

CTBJAFIG Return Codes

Table 195 CTBJAFIG Return Codes

Example for CTBJAFIG

//  EXEC CTBJAFIG,FILE=ALL,C=N

For additional information, see sample member JOBJAFIG in the JCL library.

CTBVXRF – Cross-Reference Utility

The CTBVXRF utility produces a report that cross-references database variables and the rules by which they are created and accessed. This utility gives the user more control over rule definition and maintenance.

CTBVXRF Parameters

This utility receives parameters using DD statement DACMD.

Table 196 CTBVXRF Parameters

CTBVXRF Report Format

The cross-reference report is formatted according to the SORT parameter, as described above.

Each report line contains the following items:

Table 197 CTBVXRF Report Formats

Activating the CTBVXRF Utility

Figure 71 provides an example of CTBVXRF activation syntax.

// EXEC CTBVXRF
// DACMD DD *
  LIB=rule-library
  RULE=rule-list
  SORT=sort-option
  BLOCKS=YES/NO
//

Examples for CTBVXRF

INPUT FOR CROSS REFERENCE REPORT:LIB=CTBP.PROD.RULES
RULE=ARWARN*
SORT=RULE
BLOCKS=YES
   
CONTROL-M/Analyzer-B VERSION 6.3.01  DATABASE VARIABLE CROSS-REFERENCE REPORT 
         TUE MAR 02 2000 16:52:31   PAGE 1
BMC SOFTWARE, INC.
RULES IN CTBP.PROD.RULES (ARWARN*)
                     ************
                     * ARWARN01 *
                     ************
NO DATABASE VARIABLES FOUND.
                     ************
                     * ARWARN02 *
                     ************
NO DATABASE VARIABLES FOUND.
                     ************
                     * ARWARN03 *
                     ************
NO DATABASE VARIABLES FOUND.
                     ************
                     * ARWARN04 *
                     ************
          VARIABLE                    | BLOCK    EXTRACT    SET    USED
--------------------------------------+---------------------------------
DB_(INTRAC).COST%%D                   | ENDJOB               1
DB_(INTRAC).INVAMT%%D                 | ENDJOB               1
DB_(INTRAC).PROCESS_MONTH             | CHKDETL                      1
--------------------------------------+---------------------------------
                     ************
                     * ARWARN05 *
                     ************
          VARIABLE                    | BLOCK    EXTRACT    SET    USED
--------------------------------------+---------------------------------
DB_(INTRAC).COST01                    | ACCUMSLS                     1
DB_(INTRAC).COST02                    | ACCUMSLS                     1
DB_(INTRAC).COST03                    | ACCUMSLS                     1
DB_(INTRAC).INVAMT01                  | ACCUMSLS                     1
DB_(INTRAC).INVAMT02                  | ACCUMSLS                     1
DB_(INTRAC).INVAMT03                  | ACCUMSLS                     1
--------------------------------------+---------------------------------
                     ************
                     * ARWARN06 *
                     ************
NO DATABASE VARIABLES FOUND
                     ************
                     * ARWARN4A *
                     ************
          VARIABLE                    | BLOCK    EXTRACT    SET    USED
--------------------------------------+---------------------------------
DB_(INTRAC).COST%%D                   | ENDJOB               1
DB_(INTRAC).INVAMT%%D                 | ENDJOB               1
DB_(INTRAC).PROCESS_MONTH             | CHKDETL                      1
------------------------------------------------------------------------
END OF REPORT

INPUT FOR CROSS REFERENCE REPORT:
LIB=CTBP.PROD.RULES
RULE=ARWARN*
SORT=VAR
BLOCKS=YES
   
CONTROL-M/Analyzer-B VERSION 6.3.01  DATABASE VARIABLE CROSS-REFERENCE REPORT 
                TUE MAR 02 2000 16:53:19   PAGE 1
BMC SOFTWARE, INC.
RULES IN CTBP.PROD.RULES (ARWARN*)
   
          VARIABLE                    | RULE      BLOCK    EXTRACT    SET    USED
--------------------------------------+-------------------  ----------------------
DB_(INTRAC).COST%%D                   | ARWARN04  ENDJOB               1
DB_(INTRAC).COST%%D                   | ARWARN4A  ENDJOB               1
DB_(INTRAC).COST01                    | ARWARN05  ACCUMSLS                     1
DB_(INTRAC).COST02                    | ARWARN05  ACCUMSLS                     1
DB_(INTRAC).COST03                    | ARWARN05  ACCUMSLS                     1
DB_(INTRAC).INVAMT%%D                 | ARWARN04  ENDJOB               1
DB_(INTRAC).INVAMT%%D                 | ARWARN4A  ENDJOB               1
DB_(INTRAC).INVAMT01                  | ARWARN05  ACCUMSLS                     1
DB_(INTRAC).INVAMT02                  | ARWARN05  ACCUMSLS                     1
DB_(INTRAC).INVAMT03                  | ARWARN05  ACCUMSLS                     1
DB_(INTRAC).PROCESS_MONTH             | ARWARN04  CHKDETL                      1
DB_(INTRAC).PROCESS_MONTH             | ARWARN4A  CHKDETL                      1
--------------------------------------+------------------------------------------
   
END OF REPORT