Previous Topic: The $PTB MacroNext Topic: The $VERB Macro

Installation Options › CA JCLCheck Macros › The $UPT Macro

The $UPT Macro

Tailoring CA JCLCheck can increase its usefulness at your installation. For example, this macro defines the required ddnames for utility programs and defines control input files for control statement processing. Coding this macro to your installation requirements enables CA JCLCheck to check that all required DD statements are coded.

$UPT USERPGM,REQ=(SYSUT1,SYSUT2,SYSPRINT,SYSIN)

You can also use the $UPT entry to define control input files to CA JCLCheck for control statement processing (for example, IDCAMS, IEHPROGM, DFSORT, and ADRDSSU). The following $UPT macro defines the control input file for the SORT utility:

$UPT SORT,CTL=SYSIN

Coding this statement causes CA JCLCheck to retrieve the control statements and list them on Report 2 - Listing of Merged JCL Report. CA JCLCheck also provides the examples of verb tables to validate user utility control statements (the VBT parameter) in CAZ2SRC.

Use the $UPT macro to define entries in the utility program table. The last entry in the table is a $UPT macro that is coded without operands.

$UPT name,
      COPY=(ddname1,ddname2),
      CTL=(ddname1[-{R|C|O}][,...ddname[-{R|C|O}]),
      OPTCOPY=(ddname1,ddname2),
      REQ=(ddname,...ddname),
      VBT=name,
      EXEPARM={YES|NO|UCP},
      UCP=name,
      CALLPGM=name,
      VERB=verbname
name

CA JCLCheck requires this parameter except when using an end-of-table indicator name and specifies the name of the utility program this UPT entry is defining.

If you omit this operand, CA JCLCheck terminates the table. CA JCLCheck flags any $UPT macro that is coded after this one as an error.

COPY

Specifies pairs of required ddnames that a copy operation uses.

Utility program execution copies the data set that the first ddname of each pair defines to the second ddname. All ddnames defined in the COPY parameter are considered required, and if the copy operation omits any ddnames, CA JCLCheck generates a CAY6119E message. The information about file copy operations is only significant if you use CA APCDOC.

CTL

Specifies the ddnames of the control statement input files and specifies whether the ddnames are required (ddname or ddname-R), conditional (ddname-C) or optional (ddname-O). The following example shows two methods to specify that the SYSIN DD is required and the OPTIN DD is optional.

CTL=(SYSIN,OPTIN-O)
CTL=(SYSIN-R,OPTIN-O)

You can specify the conditional identifier (-C) when control statement input is required to be specified in at least one of a group of sources. Also, when control statement input can be specified in more than one source. The following example specifies that the SYMNAMES DD is optional and the SYSIN and DFSPARM DD statements are conditional. At least one of the DD statements (SYSIN or DFSPARM) must exist. Both SYSIN and DFSPARM DD statements can exist.

CTL=(SYMNAMES-O,SYSIN-C,DFSPARM-C)

Control statements for DD names that are specified in the CTL parameter are listed and processed. The control statement DDs are processed in the order specified in the CTL parameter.

CA JCLCheck always lists control statements in these input files, regardless of the setting of the CCLIST option. CA JCLCheck lists control statements in permanent disk files or libraries when the CTLSCAN option is active. In addition, if you code the VBT or UCP parameter, CA JCLCheck scans the control statements.

CA JCLCheck issues a CAY6119E message for each missing ddname when: you omit required ddnames or do not specify at least one conditional ddname.

OPTCOPY

Specifies pairs of ddnames that CA JCLCheck uses in a copy operation.

This parameter has the same function and requirements as the COPY parameter, except that CA JCLCheck does not require these ddnames. Therefore, the CAY6119E message is not issued for omitted ddnames.

REQ

Specifies one or more ddnames CA JCLCheck requires for the execution of this utility program.

If any of these ddnames are missing in the JCL, a CAY6119E message is generated.

VBT

Requests that CA JCLCheck analyze the control statements in the input file (CTL) using the verb table named in this parameter. This action occurs when the CTLSCAN option is active.

CA JCLCheck provides verb tables for IEHPROGM, IDCAMS, XCOM, DFSORT, and other utilities.

EXEPARM

Specifies whether the PARM value on the EXEC statement should be validated. Specify YES, NO, or UCP. The PARM value is not validated when you specify NO or the default is used. The Verb Table validates the PARM data when you specify YES. The VBT parameter specifies the Verb Table. The Utility Call Program validates the PARM data when you specify UCP. The UCP parameter specifies the Utility Call Program.

UCP

Specifies the name of a Utility Call Program (UCP) that is called to validate the control statements. This action occurs when the CTLSCAN option is active.

CA JCLCheck provides the UCP to validate DFSORT and ADRDSSU statements and parameters.

CALLPGM

Specifies whether a Utility Call Program (UCP) is called to validate the control statements. Specify YES or NO. The traditional Verb Table (VBT) validates the control statements when you specify NO or the default is used. The program specified in the UCP parameter is used to validate the control statements when you specify YES. This action occurs when the CTLSCAN option is active.

VERB

Specifies a verb name to use with a user utility program that has operands only on the input control statements. CA JCLCheck depends on the verb-operand syntax it finds in IBM utilities.

CA JCLCheck substitutes this verb internally to meet the verb-operand syntax requirement. Use the same verb name here as is in the verb table that the VBT parameter points to. See members JCLUPT and JCLUTIL in CAZ2SRC for examples of this macro and $VERB macro.