InterTest™ and SymDump ® 11.0
A|D
Lets you specify the values A or D to sort the display in ascending or descending order.
Values: A, D
H
Lets you sort the hexadecimal numeric values. This allows digits A - F to compare greater than 0 - 9.
Usage Notes:
After sorting a display, SORT * returns the display to its original order.
SYM
Use the SYM command to display the Symbolic Utilities menu.
Syntax
 SYM <option>

Synonyms
 CSL, CPP, LISTcsl, PROTsym, Utilities, DSS

Parameters
option
Lets you prime the selection field to any of the valid menu items:
•List the contents of a PROTYSM or CSL symbolic file. After the list is displayed, you can browse, print, or
delete members using line commands from the selection list.
•Add listings to a PROTSYM file.
•List symbolic files defined globally in your installation options table CAOUDFRX. After the list is displayed,
use the S line command to list the contents of any symbolic file, or the A line command to add members to a
PROTSYM file.
•Add or Remove supplemental symbolic files defined locally to your viewer profile. After the list is displayed,
use the S line command to list the contents of any symbolic file, or the A line command to add members to a
PROTSYM file.
•View or change the Endevor  symbolic support options defined locally to your viewer profile. Once the options
display, overtype the values to change them.
Usage Notes:
•The last symbolic file referenced by any of the symbolic utilities is automatically saved in the Symbolic File Dsname
field.
•For online help for a symbolic utility, select the option for that utility and press PF1.
TAG


TAG
Use the TAG command while viewing a report to equate a line number to your current position within the report.
Syntax
 TAG <name>

Synonyms
 .name
 899


InterTest™ and SymDump ® 11.0

Parameters
name
Lets you specify any 1- to 32-character name that will become equated with your current position within the report
you are viewing.
Usage Notes:
•Entering a duplicate tag name replaces the previous tag with the new report position. Two tags cannot share the same
name.
•Use the LOCATE command to position your display using a previously defined tag.
•All tags are automatically deleted when you close and exit a report.
VIEW
Use the VIEW command while viewing a report to display the listing for a specified program.
The VIEW command displays the version of the listing that was used to provide symbolic information when the report was
formatted. If no symbolic information was provided for the program in the report you are viewing, use the SYM command
instead.
Syntax
 View <program-name>

Synonyms
None.
Parameters
program-name
Lets you specify the program name that was formatted with symbolic information in the report you are viewing.
SymDump  Batch Utilities
The following reporting facilities are provided to measure the use and effectiveness of the product:
•The Management Reporting System (MRS) provides a means for you to audit your load module libraries.
•The Initialization Summary generates a report describing which SymDump  Batch modules are currently loaded in the
CSA area of LPA.
•The Options Summary reports on the options set as installation defaults.
•The CSL Summary reports on the contents of a specified CSL or on all of the CSLs defined as installation defaults.
•The CAIPRINT Repository Utility provides a means for you to list and maintain the contents of the central VSAM
repository.
Symbolic file (PROTSYM) utilities are also provided. For a description of these utilities, see Symbolic Support.
Management Reporting System (MRS)


Management Reporting System (MRS)
The Management Reporting System scans any load module library and reports on the COBOL programs contained within
each member. MRS produces two reports, a detailed report and a summary report, indicating the size and characteristics
of each load module in a selected library.
 900


InterTest™ and SymDump ® 11.0
MRS reads the members of a specified library and identifies and lists COBOL CSECTs and load modules that contain
them. It also provides compilation and size information for these CSECTS and indicates whether they are processed by
Optimizer/II  or Optimizer/II .
JCL
A procedure called CAIMRSII is provided to invoke MRS. To obtain detail and summary reports for library
PROD1.LOADLIB, specify the following:
 // EXEC CAIMRSII,LIBRARY='PROD1.LOADLIB'

The MRS program, CAOUMRS, uses the following DD statements:
DD Statement Description
STEPLIB Defines the library containing MRS.
SYSPRINT Defines the MRS report file.
SYSLIB Defines the library to be analyzed.
NOTE
The ddname for the library to be analyzed is an installation option with a default of SYSLIB. If the ddname was
changed during installation, ensure that the procedure CAIMRSII was changed too.
Reports
MRS provides the following two reports for each load library that is scanned:
•The Load Library Analysis Detailed Report is a detailed listing of all COBOL CSECTs in the library.
•The Load Library Analysis Summary Report is a summary of all of the library's statistics.
Load Library Analysis Detailed Report
The Load Library Analysis Detailed report lists all of the load modules in the library that contain COBOL CSECTs. A
sample report is shown next:
 LEGEND FOR OPTIMIZER OPTIONS:
 D=DTECT C=XCOUNT X=XTIME P=PFLOW S=SUBRNGCK R=PARMCHK B=DBGSLEEP F=FDCHECK W=WSINIT I=CICS E=EOS L=WSCLEAR
 H=PUSHPOP O=CASORT


H=PUSHPOP O=CASORT
 MODULE  MODULE-SIZE CSECT   CSECT-SIZE  PROC-SIZE   DATA-SIZE   COMPILER-ID  RE  DATE       TIME      CA-OPT
 REL DCXPSRBFWIELHO
 IX101A   9,376 IX101A        8,276      3,826       4,450       C2  5668-958 3.2 08/13/2003 13.54.45  NONE
 IX102A  12,440 IX102A       11,340      6,432       4,908       C2  5668-958 3.2 08/13/2003 13.54.45  NONE
 IX103A  13,128 IX103A       12,028      6,952       5,076       C2  5668-958 3.2 08/13/2003 13.54.46  NONE
 IX104A  12,880 IX104A       11,782      6,266       5,516       C2  5668-958 3.2 08/13/2003 13.54.45  NONE
 IX105A  17,048 IX105A       15,950      9,128       6,822       C2  5668-958 3.2 08/13/2003 13.54.46  NONE
 IX106A  22,824 IX106A       21,726     10,990      10,736       C2  5668-958 3.2 08/13/2003 13.54.45  NONE


IX107A  15,536 IX107A       14,440      8,762       5,678       C2  5668-958 3.2 08/13/2003 13.54.46  NONE
 IX108A  20,560 IX108A       19,458     12,840       6,618       C2  5668-958 3.2 08/13/2003 13.54.09  NONE
 IX109A  15,968 IX109A       14,868      7,070       7,798       C2  5668-958 3.2 08/13/2003 13.54.15  NONE
 IX110A  10,048 IX110A        8,948      4,168       4,780       C2  5668-958 3.2 08/13/2003 13.54.15  NONE
 IX111A   9,584 IX111A        8,486      3,454       5,032       C2  5668-958 3.2 08/13/2003 13.54.15  NONE
 IX112A  14,224 IX112A       13,124      5,772       7,352       C2  5668-958 3.2 08/13/2003 13.54.16  NONE
 IX113A  12,472 IX113A       11,372      4,206       7,166       C2  5668-958 3.2 08/13/2003 13.54.16  NONE


IX114A  11,944 IX114A       10,844      3,814       7,030       C2  5668-958 3.2 08/13/2003 13.54.15  NONE
 901


InterTest™ and SymDump ® 11.0
 IX115A  11,896 IX115A       10,796      3,770       7,026       C2  5668-958 3.2 08/13/2003 13.54.49  NONE
 IX116A  11,888 IX116A       10,788      3,762       7,026       C2  5668-958 3.2 08/13/2003 13.54.52  NONE
 IX117A  11,896 IX117A       10,796      3,766       7,030       C2  5668-958 3.2 08/13/2003 13.54.51  NONE
 IX118A  11,928 IX118A       10,828      3,806       7,022       C2  5668-958 3.2 08/13/2003 13.54.52  NONE
 IX119A  12,168 IX119A       11,068      3,976       7,092       C2  5668-958 3.2 08/13/2003 13.54.51  NONE
 IX120A  11,704 IX120A       10,604      3,580       7,024       C2  5668-958 3.2 08/13/2003 13.54.52  NONE


IX121A  12,952 IX121A       11,852      4,660       7,192       C2  5668-958 3.2 08/13/2003 13.54.52  NONE
 IX201A   9,424 IX201A        8,324      3,826       4,498       C2  5668-958 3.2 08/16/2003 12.26.51  NONE
 IX202A  12,504 IX202A       11,404      6,468       4,936       C2  5668-958 3.2 08/16/2003 12.26.52  NONE
 IX203A  13,128 IX203A       12,028      6,910       5,118       C2  5668-958 3.2 08/16/2003 12.26.53  NONE
 IX204A  12,896 IX204A       11,798      6,298       5,500       C2  5668-958 3.2 08/16/2003 12.26.53  NONE
 IX205A  19,728 IX205A       18,288      9,518       8,770       C2  5668-958 3.2 08/16/2003 14.13.25  OPT/II
 2.0 DCXPSR.FW.....


2.0 DCXPSR.FW.....
 IX206A  13,904 IX206A       12,804      7,572       5,232       C2  5668-958 3.2 08/16/2003 12.26.55  NONE
 IX207A  15,960 IX207A       14,864      8,760       6,104       C2  5668-958 3.2 08/16/2003 12.26.56  NONE
 IX208A  24,776 IX208A       23,680     17,004       6,676       C2  5668-958 3.2 08/16/2003 12.26.56  NONE
 IX209A  39,504 IX209A       38,404     26,034      12,370       C2  5668-958 3.2 08/16/2003 12.26.56  NONE
 IX210A  33,616 IX210A       32,520     20,650      11,870       C2  5668-958 3.2 08/16/2003 12.26.57  NONE
 IX211A  19,072 IX211A       17,972      8,240       9,732       C2  5668-958 3.2 08/16/2003 12.26.57  NONE


IX212A  18,936 IX212A       17,840     11,292       6,548       C2  5668-958 3.2 08/16/2003 12.26.57  NONE
 IX213A  18,328 IX213A       17,232     11,240       5,992       C2  5668-958 3.2 08/16/2003 12.26.57  NONE
 IX214A  34,032 IX214A       32,936     21,034      11,902       C2  5668-958 3.2 08/16/2003 12.26.59  NONE
 IX215A  48,584 IX215A       47,486     33,168      14,318       C2  5668-958 3.2 08/16/2003 12.27.01  NONE
 IX216A  13,400 IX216A       12,298      6,610       5,688       C2  5668-958 3.2 08/16/2003 12.27.02  NONE
 IX217A  11,400 IX217A       10,302      5,168       5,134       C2  5668-958 3.2 08/16/2003 12.27.01  NONE
 IX218A  10,648 IX218A        9,550      4,474       5,076       C2  5668-958 3.2 08/16/2003 12.27.04  NONE


IX301M   3,264 IX301M        2,164        694       1,470       C2  5668-958 3.2 08/16/2003 12.27.08  NONE
 IX302M   3,896 IX302M        2,796        136       2,660       C2  5668-958 3.2 08/16/2003 12.27.08  NONE
 IX401M   3,496 IX401M        2,398        464       1,934       C2  5668-958 3.2 08/16/2003 12.27.08  NONE
 RL206A  13,256 RL206A       11,814      5,248       6,566       C2  5668-958 3.2 09/16/2003 10.57.29  OPT/II
 2.0 DCXPSR.FW.....
 SQ124A  20,968 SQ124A       19,522     10,368       9,154       C2  5668-958 3.2 06/18/2002 13.32.01  OPT/II
 2.0 DCXPSR.FW.....
 ST140A  22,232 ST140A       20,778     11,162       9,616       C2  5668-958 4.0 06/25/2002 15.35.57  OPT/II
 2.0 DCXPSR.FW.....
 TOTALS: 719,416            668,576    363,338     305,238


The report displays the following information:
LEGEND FOR OPTIMIZER OPTIONS
Lets you specify the meaning of each letter that appears in the last column. All the options for execution-time
facilities that can be specified at compile/optimize time are listed in the report.
MODULE
Lists the names of the load modules that contain at least one COBOL CSECT.
MODULE-SIZE
Displays the total number of bytes in each load module listed.
NOTE
For overlay modules, the size specifies the maximum amount of memory used by the module and not
the sum of the CSECTs contained in it.
 902


InterTest™ and SymDump ® 11.0
CSECT
Lists all the COBOL CSECT names in each load module. Multiple COBOL CSECTs within a given load module
print on a separate line.
CSECT-SIZE
Displays the total number of bytes in each COBOL CSECT.
PROC-SIZE
Displays the number of bytes for the program's Procedure code. See Usage Considerations for more information.
DATA-SIZE
Displays the number of bytes of storage generated by the compiler for the COBOL program's Data Division. For
more information about Data Division, see Usage Considerations.
COMPILER-ID
Identifies the type of COBOL compiler used and the compiler's program product number and version number.
MRS copies the program product number and the version number directly from the COBOL module.
REL, DATE, and TIME
Displays the release of the COBOL compiler used and the date and time of the program's compilation (copied
directly from the COBOL module).
CA-OPT version release
Verifies whether the COBOL CSECT is processed with an Optimizer/II  product. The release number indicates the
release with which the CSECT was optimized.
•YES indicates that the CSECT was optimized with an earlier release that did not retain release numbers in the
load module.
•NONE indicates that the CSECT is not processed with Optimizer/II .
In some instances, the compiler program product number, version number, and the date and time of compilation
may not be available. In this case, an UNAVAILABLE message appears.
The last column shows whether certain Optimizer/II  or Optimizer/II  execution-time options were specified at
compile or optimize time. If the program was optimized using Optimizer/II , then only the letters for DTECT,


PFLOW, or XCOUNT appear even if the options FDCHECK, SUBRNGCK, or WSINIT were specified at compile
time.
The last line of the report specifies the following totals in bytes (1024 KB):
•Load modules listed on the report
•COBOL CSECTs
•Number of data bytes
•Number of procedure bytes from the COBOL CSECTs
Load Library Analysis Summary Report
The Load Library Analysis Summary report follows the Load Library Analysis Detailed report and provides summarized
statistical information about the library being scanned.
 COMPILER-ID   REL MODULES  CSECTS   OPTOS OPTII   DTE   XCO   XTI   PFL   SUB   PAR   DBG   FDC   WSI   CIC
  EOS   WSC   PUS   CAS
  C2  5668-958 3.2      44      44   0     3     3     3     3     3     3     3     0     3     3     0     0
     0     0     0
  C2  5668-958 4.0       1       1   0     1     1     1     1     1     1     1     0     1     1     0     0
     0     0     0
 TOTALS: COBOL          45      45   0     4     4     4     4     4     4     4     0     4     4     0     0
     0     0     0
         IGZ            45      45
         CAO             4       4


IGZ            45      45
         CAO             4       4
 903


InterTest™ and SymDump ® 11.0
         ALL            45      94
 *----------------------------------------------------------------------------------------------------------------------------------
*
 * For programs which have been compiled using CA-OPTIMIZER, only DTECT, XCOUNT, and CICS are reflected in
 these MRS reports.       *
 * More information regarding the options used during optimization is only available for programs compiled
 using CA-OPTIMIZER/II.   *
 *----------------------------------------------------------------------------------------------------------------------------------
*

For programs that are compiled using Optimizer/II , only DTECT, XCOUNT, and CICS are reflected in these MRS reports.
More information regarding the options used during optimization is only available for programs compiled using Optimizer/
II.
The Load Library Analysis Summary report displays the following information:
IGZ, CEE, CAO
Displays the number of modules containing COBOL CSECTs and the total number of COBOL CSECTs.
ALL
Displays the total number of modules and CSECTs in the library.
The next part of the Summary Report provides a summary of Optimizer/II  and Optimizer/II  options in effect by compiler
type and version.
COMPILER ID
Lists the compiler type and version used.
OPTOS
Displays the number of programs compiled under the listed compiler version that were compiled and optimized
with Optimizer/II .
OPTII
Displays the number of programs compiled under the listed compiler version that were compiled and optimized
with Optimizer/II .
TOTALS
Displays the total number of programs that were optimized using the various options listed.
Usage Considerations
MRS analyzes any standard IBM load module library, but does not support concatenated load library data sets. Specify
each load library to be analyzed in a separate MRS execution run.


each load library to be analyzed in a separate MRS execution run.
MRS recognizes COBOL CSECTs that are compiled using the following IBM COBOL compilers: V2, V3, V4, OS/VS
COBOL, COBOL II, COBOL 370, COBOL for MVS and VM, COBOL for OS/390 and VM, Enterprise COBOL for z/OS and
OS/390, and Enterprise COBOL for z/OS.
OS/VS COBOL Reporting
MRS makes a distinction between data bytes and procedure bytes in the detailed report. Data bytes include the storage
size in the CSECT that is directly generated by the COBOL CSECTs Data Division plus the INIT1 code. (Data bytes are
figured from the beginning of the program to the TGT.) Procedure bytes include the storage size of the remainder of the
CSECT. The sections of the CSECT that make up the procedure bytes are as follows:
 904


InterTest™ and SymDump ® 11.0
•TGT
•PGT
•Report Writer Routines
•COBOL Procedure Division
•Q Routines
•INIT2
•INIT3
COBOL II and Above
When reporting for COBOL II and above, MRS distinguishes between data and procedure bytes. The data bytes include
only the areas in the program generated at compile time, and do not include data areas acquired dynamically at execution
time for a program compiled with the RENT option. The sections of the CSECT that make up the procedure bytes are as
follows:
•Signature Code
•INITD Code (for RENT programs)
•Q Routines
•Procedure Division
Options Summary Report
The Options Summary produces a report detailing your installations default options.
JCL
A procedure called CAIOPTNS is provided to invoke the Options Summary program. To obtain an options summary for
your data center, specify the following:
// EXEC   CAIOPTNS
The initialization summary program, CAOUOPTS, uses the following DD statements:
DD Statement Description
STEPLIB Defines the library containing SymDump  Batch Options Summary
program and options modules.
SYSPRINT Defines the report file.
Report
A sample of the Options Summary is as follows:
*
*  EXECUTION TIME DEFAULTS:
*
*  CEEDUMP    =  OFF
*  DUPLIM     =  5
*  EXPDAYS    =  0
     .           .
     .           .
 905


InterTest™ and SymDump ® 11.0
*  SYSOUTD    =
*  UNIT       =  SYSDA
*
*  CAOUXMOD   =  CAO
*  CAOUXMOD   =  CEE
*  CAOUXMOD   =  IGZ
*  CAOUXMOD   =  ILBO
*  CAOUXMOD   =  IN25
*
*  CAOUSYM    =  CAI.PROTSYM
*
*************************************************************************
    SUPPORT IS ACTIVE
    SQA ANCHOR LOADED AT 82A3D2F0

    REPORTING OPTIONS:

    OPTION         STATUS         FIXED

    ACB            =  OFF
    ACTONLY        =  OFF
    AMB            =  OFF
     .                .
     .                .
    WORKSTOR       =  ON
    WTOXCL         =  ON

    LOGGING OPTIONS:

    OPTION         STATUS         FIXED

    LOGTSO         =  ON
    LOGNET         =  OFF
    LOGROS         =  ON
    LOGUNI         =  OFF
    LOGWTO         =  ON
    LOGWTL         =  OFF
    SMF            =  OFF

    CONTROL OPTIONS:

    MCHAR VALUE  = ?
    PCHAR VALUE  = *
    RCHAR VALUE  = :
    SYSOUT VALUE = *
    MAXBLL       = 512

    DEFAULT DATA SET NAMES:

    NTMGCCTL       CAI.NTMMGCTL


NTMGCCTL       CAI.NTMMGCTL
    NTMPI          CAI.NTMPI
    NTMSC          CAI.NTMSC
 906


InterTest™ and SymDump ® 11.0
    CAIOPTS FILE SUFFIX           CAIOPTS
CSL Summary Report
The CSL Summary produces a report of all members in the Condensed Source Listing library. The user can select to
report on a single CSL or on all of the CSLs defined as installation defaults.
NOTE
SymDump  Batch no longer writes symbolic information using the CSL format. This utility provides summary
information for CSL libraries that were populated by earlier versions of the product. These CSL libraries may
still be used as input to the report formatter. However, as programs are recompiled, their updated symbolic
information can only be written using the PROTSYM format.
JCL
A procedure called CAICSLD is provided to invoke the Condensed Source Listing Summary program. To obtain a CSL
Summary for your data center, specify the following:
// EXEC   CAICSLD
The CSL summary program, CAOUOPTS, uses the following DD statements:
DD Statement Description
STEPLIB Defines the library containing SymDump  Batch CSL Summary
program.
SYSPRINT Defines the report file.
CAISYM (Optional) Defines the Condensed Source Listing library to be
reported on.
NOTE
The ddname for the CSL is an installation option that can be modified. If it is modified at your installation, be
sure to also change the ddname in procedure CAOUCSLD. If omitted, CAOUCSLD reports on all of the CSLs
defined as installation defaults.
Report
This sample report shows the information and the format of the condensed source listing summary:
                    CONDENSED SOURCE LIBRARY
                     DATA SET NAME = USER002.CSL
PROGRAM ID      DATE COMPILE   TIME COMPILED GENLEVEL  RELEASE  COMPILER


PROGRAM ID      DATE COMPILE   TIME COMPILED GENLEVEL  RELEASE  COMPILER
--[A]------     ----- [B]--------- [C]----------- [D]-------[E]-------- [F]---
ABEND           05 May,2004    12:55:21     0004OX220   2.2     COBOL II
CALLDETH        24 Nov,2003    16:42:27     9906OX210   2.1     COB OS390
CALLIVP1        23 Jan,2004    12:05:01     9912RX220   2.2     COB OS390
CAOUTC2K        16 Jan,2004    16:56:51     9912HH100   1.0     COB OS390
CAO2DB2         05 Apr,2004    14:37:22     0002RX220   2.2     COB OS390
CAO2DEMO        14 Jul,2003    16:25:47     0007W9800   1.0     COB OS390
CAO2DEMR        06 NOV,2003    17:27:03     9709OX210   2.1     COB OS390
CAO2IDMS        04 Apr,2003    13:29:58     0002RX220   2.2     COB OS390
CCDEMO03        08 Nov,2002    10:53:01     9909OX220   2.2     COB OS390
 907


InterTest™ and SymDump ® 11.0
COB0C7          05 May,2004    14:20:08     0004RX220   2.2     COB OS390
DB2ADD          26 Apr,2004    09:35:19     0106AOX00   3.0     COB OS390
DB2CAF          24 Mar,2004    16:20:46     0002OX220   2.2     COB OS390
DB2DEL          26 Apr,2004    09:35:28     0106AOX00   3.0     COB OS390
DB2DEMO         26 Apr,2004    09:35:10     0106A0X00   3.0     COB OS390
DB2LIST         08 Sep,2002    18:24:28     9909OX220   2.2     COB OS390
DB2LISTM        07 Sep,2002    14:01:07     9909OX220   2.2     COB OS390
DB2LIST2        08 Sep,2002    18:25:05     9909OX220   2.2     COB OS390
DB2MSG          07 Sep,2002    14:08:38     9909OX220   2.2     COB OS390
DB2PLANS        25 Apr,2003    10:41:17     0002OX220   2.2     COB OS390


DB2TBLS         07 Mar,2003    15:07:54     0002OX220   2.2     COB OS390
DB2UPD          25 Apr,2003    09:35:39     0106AOX00   3.0     COB OS390
DFSSAM01        14 Jul,2003    10:27:44     0007OX220   2.2     COBOL II
ENTRIES         05 Feb,2002    17:08:55     9812HH100   1.0     COB OS390
IC114A          11 Jul,2003    12:59:13     0007OX220   2.2     COB OS390
MAINPGM         05 Feb,2002    17:08:47     9812HH100   1.0     COB OS390
MAINPROG        30 Apr,2002    17:09:41     9903OX210   2.1     COB OS390
MAIN1           06 DEC,2002    17:37:45     9912OM610   6.1     VS COBOL
MWP503          11 Feb,2004    16:16:51     9912OX220   2.2     COB OS390
MWP635          08 May,2003    09:35:31     0004RX220   2.2     COBOL II
M648884A        06 Jun,2003    17:50:29     0106AOX00   3.0     COBOL II


OPIMSDMO        11 Jul,2003    18:27:50     0007RX220   2.2     COBOL MVS
PSIMPLE         13 JAN,2002    15:46:02     9712OX210   2.1     COBOL MVS
STOPRUN         03 May,2004    10:48:28     0004RX220   2.2     COBOL II
SUBPGM          06 Oct,2002    16:09:37     9813OX220   2.2     COBOL II
SUBPROG         20 May,2002    13:13:03     9504OX130   1.3     COBOL II
SUBPROGA        30 Apr,2002    17:09:36     9903OX210   2.1     COB OS390
SVTEST          28 Mar,2003    11:18:37     0002OX220   2.2     COBOL II
TESTMRG         11 Feb,2003    14:57:15     9912OX220   2.2     COB OS390
XACD912         26 Jun,2003    11:37:38     9912HH100   1.0     COB OS390
TOTAL NUMBER OF COBOL II PROGRAMS       =   8   [G]
TOTAL NUMBER OF VS COBOL PROGRAMS       =   1
TOTAL NUMBER OF COBOL FOR MVS PROGRAMS      =   2
TOTAL NUMBER OF COBOL FOR OS/390 PROGRAMS   =   28


TOTAL NUMBER OF COBOL FOR OS/390 PROGRAMS   =   28
TOTAL NUMBER OF PROGRAMS            =   39
The Condensed Source Listing Summary report displays the following information:
[A]
Lists the program IDs.
[B]
Displays the date when the program was compiled.
[C]
Displays the time when the program was compiled.
[D]
Displays the genlevel of SymDump  Batch when the CSL was created.
[E]
Displays the release of SymDump  Batch when the CSL was created.
[F]
Displays the compiler used.
 908


InterTest™ and SymDump ® 11.0
[G]
Displays the totals for each CSL reported on.
CAIPRINT Repository Utility
The CAIPRINT repository utility provides a batch facility to list and maintain the contents of the central VSAM repository.
JCL
A procedure called CAIPRTU is provided to invoke the CAIPRINT Repository Maintenance Utility, CAOUPRTU. To display
or maintain the contents of your repository, specify the following:
// EXEC CAIPRTU
//PRTU.SYSIN DD *
(commands go here)
/*
CAOUPRTU uses the following DD statements:
DD Statement Description
STEPLIB Defines the library containing SymDump  Batch.
SYSPRINT Defines the report file.
SYSUT1 Defines the work file used for some requests.
Commands
The syntax of any command is:
keyword <selection criteria>
keyword
Lets you specify one of the command keywords listed in this section.
selection criteria
Lets you specify the selection criteria comprised of an argument and optionally an operator and a value.
Example:
LIST DATE GT 2004/04/06
In this example, the LIST keyword is used to display a summary of reports that were created in the repository after
April 6, 2004. The selection criteria is comprised of the DATE argument, the GT (for Greater Than) operator and
the value 2004/04/06.
Command Keywords
Following are the supported command keywords:
COPY
Lets you copy reports from a secondary repository (ODSN) to your primary repository (DSN). Requires that both
DSN and ODSN be specified.
DELETE
Lets you delete selected reports from a repository (DSN). The DSN must be specified.
 909


InterTest™ and SymDump ® 11.0
DSN
Lets you define the dsname for your primary CAIPRINT repository. The dsname must be specified prior to using
any other commands.
ERRSUM
Lists a summary of abend reports contained within a repository (DSN). The summary includes the program name,
offset, and abend code, and a count indicating the number of reports found with the same information. The entries
are displayed in alphabetical order, by program name. Requires that DSN be specified.
INIT
Lets you initialize a newly defined repository (DSN). Requires that DSN be specified.
JOBSUM
Lists a summary of abend reports contained within a repository (DSN), by job name. The summary includes the
job name, program name, offset, and abend code, and a count indicating the number of reports found with the
same information. The entries are displayed in alphabetical order by job name and program name. Requires that
DSN be specified.
LIST
Lists a summary of reports contained within a repository (DSN). Requires that DSN be specified.
LOCK
Lets you lock one or more reports in a repository (DSN) to prevent deletion. Requires that DSN be specified.
ODSN
Lets you specify  the dsname for a secondary CAIPRINT repository. Must be specified prior to using the COPY
command.
UNLOCK
Lets you unlock one or more locked reports in a repository (DSN) to enable the deletion. Requires that DSN be
specified.
NOTE
The dsname must be specified prior to using any other commands.
Arguments
Valid arguments for selection criteria include the following:
AGE
Lets you select reports by the number of days since they were created. This argument requires an operator and a
1- to 3-digit value.
Example:
DELETE AGE GT 5
ALL


1- to 3-digit value.
Example:
DELETE AGE GT 5
ALL
Lets you select every report unconditionally, with no operator or value specified.
Example:
UNLOCK ALL
CODE
Lets you select reports by the completion code of the step that produced the report. This argument requires an
operator and a 4- to 7-character value.
Example:
LIST CODE EQ S0C7
(or) LIST CODE EQ U1125
(or) LIST CODE EQ RC0004
(or) LIST CODE EQ CEE3250
System abend codes must begin with S followed by three hexadecimal digits.
 910


InterTest™ and SymDump ® 11.0
User abend codes must begin with U followed by four decimal digits. Return codes must begin with RC followed
by four decimal digits. IBM message codes must be 1- to 7-characters.
DATE
Lets you select reports by the date on which they were created. This argument requires an operator and a value
in the format yyyy/mm/dd.
Example:
DELETE DATE LT 2004/04/06
JOB
Lets you select reports by the name of the job that produced the report. This argument requires an operator and a
1- to 8-character value.
Example:
UNLOCK JOB NE OPTJOB1
LOCK
Lets you select reports by the ID of the user that owns a lock on the report. This argument requires an operator
and a 1- to 7-character value.
Example:
LIST LOCK EQ OPTUSER
PGM
Lets you select reports by the name of the abending program that caused the report. This argument requires an
operator and a 1- to 8-character value.
Example:
DELETE PGM EQ CAO2DEMO
STEP
Lets you select reports by the name of the step that produced the report. This argument requires an operator and
a 1- to 8-character value.
Example:
LIST STEP NE GO
NOTE
If the abend report was generated in an IMS DC environment under LE, STEP represents the Task ID.
SYSTEM
Lets you select reports by the 1- to 8-character name of the system on which the report was created.
Example:
COPY SYSTEM EQ PRODZ1
USER
Lets you select reports by the ID of the user who submitted the job that produced the report. This argument
requires an operator and a 1- to 7-character value.
Example:
LOCK USER EQ OPTUSER
Operators


Example:
LOCK USER EQ OPTUSER
Operators
Valid operators include the following:
EQ
Selects reports if the value of the argument is equal to the value specified.
GE
Selects reports if the value of the argument is greater than or equal to the value specified.
 911


InterTest™ and SymDump ® 11.0
GT
Selects reports if the value of the argument is greater than the value specified.
LE
Selects reports if the value of the argument is less than or equal to the value specified.
LT
Selects reports if the value of the argument is less than the value specified.
NE
Selects reports if the value of the argument is not equal to the value specified.
RANGE
Selects reports if the value of the argument is between the two values specified.
Dynamic Symbolic Support
The dynamic symbolic support feature, when activated, dynamically retrieves the compiler or assembler listing of the
program being printed or viewed from a listing data set managed by Endevor  and loads it into the designated PROTSYM
file. For this feature to work, the load module library (JOBLIB or STEPLIB) where the load module is loaded and the listing
data set containing the module listing must be under the control of Endevor .
Follow these steps:
1.Specify the option NDVRDSS=ON in your installation options table CAOUDFRX using the CAIOPTS DD statement, or
in the SYM Option 5 panel.
2.Designate a PROTSYM file to receive the dynamic populated symbolic using the NDVRDSN option.
The designated PROTSYM file can be any existing PROTSYM file and is searched ahead of all other PROTSYM files
specified.
When the dynamic symbolic support feature is activated, it loads the correct symbolic information whenever a matching
symbolic version is not found.
You can reload the symbolic files associated with programs that do not contain a time stamp in the executable, such as
non-LE-enabled Assembler programs, every time they are printed or viewed. You can activate this behavior using the


additional option NDVRASM=ON. Default is not to refresh the symbolic. This option, when suppressed (NDVRASM=OFF),
never refreshes the symbolic of a non-LE-enabled Assembler program.
NOTE
The dynamic symbolic support feature cannot differentiate between multiple listing outputs created by a single
Endevor  processor for the same element. Thus, dynamic symbolic support using listing outputs from multiple
compiles or assemblies from a single Endevor  GENERATE or MOVE action for the same element may produce
unpredictable results.
Dynamic Symbolic Support Return Codes
Dynamic symbolic support provides an integrated service using API calls that deploy various proven components
including Endevor , PROTSYM post processors, z/OS dynamic allocation, CSVQUERY, and binder services.
For specific information about the return codes, see message CAPU309E in Messages and Codes.
C1DEFLTS Consideration
Following are the considerations for single and multiple C1DEFLTS:
•Single C1DEFLTS -- In an Endevor  single C1DEFLTS environment, dynamic symbolic support invokes Endevor  API
directly, provided the C1DEFLTS data set and Endevor  AUTHLIB and CONLIB data sets are in the LNKLIST.
•Multiple C1DEFLTS -- In an Endevor  multiple C1DEFLTS environment, dynamic symbolic support normally invokes
Endevor  API through a listing server dedicated to a unique C1DEFLTS. For more information, see Installing.
 912


InterTest™ and SymDump ® 11.0
Troubleshooting
This section contains information about identifying and resolving problems.
Collect Diagnostic Data
Execution-Time Problems
Gather the following information on the execution environment:
•In an Online Data Communication environment, the name of the package (if it is not an in-house developed product),
the version/release and maintenance level, and a vendor contact, if available.
•Non-COBOL programs being invoked by the program. Assembler language subroutines may be of interest to us in
resolving the problem. Have the source available.
•The CAIPRINT report, if applicable.
Formatting Problems
Gather the following documentation:
•Print the member listing from the PROTSYM or CSL file. See examples later in this section for more information. For
some problems, you may also be required to unload one or more members from a PROTSYM file using the batch
utility IN25UTIL. For more information about unloading members with IN25UTIL, see Symbolic Support.
•Use IDCAMS REPRO to create a sequential file of your central VSAM repository. (If the repository is very large or you
only want to send the data for a single report, you can copy the report to a temporary repository and REPRO that file.)
See Copying Repository Data for Diagnostic Purposes.
•For clients that do not use the repository, Broadcom Support  may require the unformatted data used to generate the
report. To provide that data, you will need to add the following DD to your execution time JCL and rerun the job:
 //CAIPRTWK DD DSN=data-set-name,DISP=(NEW,CATLG,CATLG),
 //           UNIT=SYSDA,SPACE=(CYL,(1,1)),


//           UNIT=SYSDA,SPACE=(CYL,(1,1)),
 //           DCB=(LRECL=133,BLKSIZE=13300,RECFM=FBA)

The data set can then be sent to Broadcom  as a BINARY file.
Symbolic Postprocessors
Review all output from the postprocessor for error messages. If any messages are found, locate the message in Symbolic
Support, then review the reason and suggested action(s).
Gather the following documentation:
•All output from the postprocessor
•The listing file used as input to the postprocessor
For all problems, gather:
•The full IBM system SYSUDUMP if an abend has occurred. Although there are other products that, like SymDump
Batch, produce very neat, easy-to-read, condensed dumps appropriate for debugging user programs, they generally
do not contain enough information for our purposes.
•All JCL, JOBLOG information, and messages for the job that ended in error.
•You may occasionally encounter a problem involving a COBOL program purchased from another vendor that is
considered proprietary. While you are usually allowed to send the source listing on paper, you may not be permitted
to send it on tape. Check. Arrangements can usually be made, including the signing of nondisclosure agreements by
Broadcom .
 913


InterTest™ and SymDump ® 11.0
Interpret Diagnostic Data
When you have collected the specified diagnostic data, write down your answers to the following questions:
1.What was the sequence of events prior to the error condition?
2.What circumstances existed when the problem occurred and what action did you take?
3.Has this situation occurred before? What was different then?
4.Did the problem occur after a particular PTF was applied or after a new version of the software was installed?
5.Have you recently installed a new version of the operating system or Language Environment (LE)?
6.Has the hardware configuration (tape drives, disk drives, and so forth) changed?
From your response to these questions and the diagnostic data, try to identify the cause and resolve the problem.
Print a Symbolic File Member for Diagnostic Purposes
There are two ways to print a symbolic file member or symbolic file directory. Either method is adequate for diagnostic
purposes.
Use the Viewer
Follow these steps:
1.Start the SymDump  Batch Repository Viewer the way you normally do.
2.Enter the SYM primary command.
The Symbolic Utilities menu is displayed.
3.Select Option 1 (List) and type the name of your PROTSYM or CSL file in the field provided.
4.Press Enter to list the contents of your symbolic file
5.Use the PRINT primary command to print a copy of the display to a printer, file, or other desired destination.
6.After the directory is printed, type the p line command next to any member to print that member.
Use the Batch Utilities
Sample JCL is provided for three utility programs that can be used to display the contents of your symbolic files:
•CAOUCSLD -- Use this program to generate a member list for your CSL library.


•CAOUCSLD -- Use this program to generate a member list for your CSL library.
•CAORMAIN -- Use the PRINTCSL function of CAORMAIN to print a member from your CSL library.
•IN25UTIL -- Use the REPORT function of IN25UTIL to generate a list of symbolic members in your PROTSYM and use
the PRINT function to print a symbolic listing for any member.
Copy Repository Data for Diagnostic Purposes
Broadcom Support  may require the data for one or more reports in your CAIPRINT repository for diagnostic purposes. To
provide that data, you must create a sequential data set from your VSAM repository.
If your CAIPRINT repository is very large, or you only want to send the data for selected reports, you can use the following
steps:
1.Create a temporary VSAM repository.
2.Copy the required reports to that repository.
3.Create a sequential data set from the temporary repository.
Otherwise, if you want to send the data for all reports, you can skip directly to Step 3. Create a Sequential Data Set
from a VSAM Repository.
 914


InterTest™ and SymDump ® 11.0
Create a Temporary VSAM Repository
Member CARXREPO in the CAI.CAVHJCL library contains JCL to create and initialize a CAIPRINT repository.
Follow these steps:
1.Make a copy of the JCL member and modify the appropriate fields, such as the data set name, space, and volume.
(Ensure to change the data set name in both the CLUSTER and DATA definitions.)
2.Submit the JCL to create your temporary repository.
Copy the Report to a Temporary VSAM Repository
Use the COPY command of the CAIPRINT Repository Utility, CAOUPRTU, to copy one or more reports from your central
VSAM repository to the temporary repository you just created.
For example, the following JCL copies the report for job TESTJOB from the central VSAM repository (CAI.PRTLIB) to a
temporary VSAM repository (TEMP.PRTLIB).
// EXEC CAIPRTU
//PRTU.SYSIN DD *
  ODSN  CAI.PRTLIB
   DSN   TEMP.PRTLIB
   COPY  JOB EQ TESTJOB
/*
NOTE
If there is more than one report in the central VSAM repository with a job name of TESTJOB, the example above
copies all of the reports by that name.
Create a Sequential Data Set from a VSAM Repository
Use IDCAMS REPRO to create a sequential file from your VSAM repository. For example, the following JCL creates a
sequential file (TEMP.PRTLIB.BACKUP) from a temporary VSAM repository (TEMP.PRTLIB).
//REPRO    EXEC PGM=IDCAMS
//PRTLIB   DD  DSN=TEMP.PRTLIB,DISP=SHR


//PRTLIB   DD  DSN=TEMP.PRTLIB,DISP=SHR
//BACKUP   DD  DSN=TEMP.PRTLIB.BACKUP,DISP=(NEW,CATLG),
//             UNIT=SYSDA,VOL=SER=vvvvvv,SPACE=(CYL,(3,3),RLSE),
//             DCB=(RECFM=FB,LRECL=4085,BLKSIZE=4085)
//SYSPRINT DD  SYSOUT=*
//SYSIN    DD  *
 REPRO INFILE(PRTLIB) OFILE(BACKUP)
/*
Using the Batch REST API
Use the SymDump Batch REST Application Programming Interface (API) to perform the following actions:
 915


InterTest™ and SymDump ® 11.0
•Display a report list
•Retrieve a report with index
•Lock a report
•Unlock a report
•Delete a report
•Display installation options
•Update Report Options
•Display Report Options
For instructions about how to install the SymDump  REST API, see Install Testing Tools Server and REST API.
Example Use Cases
As a developer or DevOps admin, you can use the SymDump Batch REST API for the following actions:
Reports
Displays a list of ABEND reports
Full Dump with index
Retrieves an ABEND analysis report with an index
LOCK
Locks an ABEND report to prevent accidental deletion
UNLOCK
Unlocks an ABEND report to allow deletion
DELETE
Deletes an ABEND report
OPTIONS
Displays the current product installation options
REPORT OPTIONS
Displays and updates the current ABEND report options
Authentication
REST API communication is secured through the HTTP or HTTPS protocol. To authenticate, the REST API server uses
the Basic authentication type and the mainframe username and password.
Troubleshoot Errors
For errors that occur during request processing, the API returns an HTTP status code to the calling client. An error is
indicated by a 4nn code or a 5nn code. For example:
Status: 400 Bad Request.
Some errors might include a JSON object/response that contains a message with a description of the error. Use this
information to diagnose the error.
This section contains the detailed API documentation in JSON format.
Please refer to the online format for OpenAPI content.
Batch REST API: Reports
Use the SymDump Batch REST API reports endpoint to display a report list.
 916


InterTest™ and SymDump ® 11.0
HTTP Method and URI Path
The SymDump Batch REST API URI path for the Reports endpoint has the following format:
GET   http://host:port/symdump/api/v1/batch/prtlib/{prtlib}/reports
Where:
host
Specifies the address of the server that runs the REST API
port
Specifies the port of the server that runs the REST API
PRTLIB
Specifies the dump repository data set name
Headers
Authorization: Basic Auth with mainframe username and password
Example:  Retrieve a report list.
GET /symdump/api/v1/batch/prtlib/CAI.PRTLIB/reports
REST API Response and Return Codes
Expected Response
On completion, the service returns an HTTP response. This response includes a status code that indicates whether the
request completed. The status code 200 OK  indicates success.
Example:
{
  "data": [
    {
      "abend": "string",
      "date": "string",
      "jobName": "string",
      "key": "string",
      "lock": "string",
      "offset": "string",
      "program": "string",
      "stepName": "string",
      "system": "string",
      "time": "string",
      "userID": "string"
    }
  ],
  "messages": [
    {
      "messageContent": "string",
      "messageNumber": "string",
      "messageType": "string"
    }
  ],
  "metadata": [
    {
      "messageTime": "string",
 917


InterTest™ and SymDump ® 11.0
      "messageVersion": "string",
      "serviceName": "string",
      "sessionID": "string"
    }
  ]
}
Batch REST API: Full Dump with Index
Use the SymDump Batch REST API full dump with index endpoint to retrieve a report.
HTTP Method and URI Path
The SymDump Batch REST API URI path for the full dump with index endpoint has the following format:
GET   http://host:port/symdump/api/v1/batch/prtlib/{prtlib}/reports/{key}/full-dump-with-index
Where:
host
Specifies the address of the server that runs the REST API
port
Specifies the port of the server that runs the REST API
PRTLIB
Specifies the dump repository data set name
Key
Report key used to locate a particular report from the report list
Headers
Authorization: Basic Auth with mainframe username and password
Request Body
Supply a JSON request document (Content-Type=application/json, character-encoding=UTF-8) with the following input
parameters:
protsymList
List of PROTSYM data set names
ndvrDSSdsn
The data set name of a PROTSYM file that is designated as the receiver of Dynamic Symbolic Support auto
population. Specify this parameter to activate Dynamic Symbolic Support for Endevor .
ndvrDSSasm
Activate or deactivate auto population for non-LE enabled ASSEMBLER programs
Values: Y, N
Example:  Retrieve a report

GET/symdump/api/v1/batch/prtlib/CAI.PRTLIB/reports/{key}/full-dump-with-index
      {
  "options": {
    "ndvrDSSdsn": "CAI.ENDV.PROTSYM",
    "ndvrDSSasm": "Y"
  },


"ndvrDSSasm": "Y"
  },
 918


InterTest™ and SymDump ® 11.0
  "protsymList": [
    "CAI.D1.PROTSYM",
    "CAI.D2.PROTSYM"
  ]
}
REST API Response and Return Codes
Expected Response
On completion, the service returns an HTTP response. The response includes a status code that indicates whether the
request completed. The status code 200 OK  indicates success.
Example:
{
  "data": "string",
  "dump": {
    "abend": "string",
    "date": "string",
    "jobName": "string",
    "key": "string",
    "lock": "string",
    "offset": "string",
    "program": "string",
    "stepName": "string",
    "system": "string",
    "time": "string",
    "userID": "string"
  },
  "index": [
    {
      "children": [
        "string"
      ],
      "description": "string",
      "lineNo": "string"
    }
  ],
  "messages": [
    {
      "messageContent": "string",
      "messageNumber": "string",
      "messageType": "string"
    }
  ],
  "metadata": [
    {
      "messageTime": "string",
      "messageVersion": "string",
      "serviceName": "string",
      "sessionID": "string"
    }
  ]
}
 919


InterTest™ and SymDump ® 11.0
Batch REST API: Lock
Use the SymDump Batch REST API Lock endpoint to lock a report.
HTTP Method and URI Path
The SymDump Batch REST API URI path for the Lock endpoint has the following format:
POST   http://host:port/symdump/api/v1/batch/prtlib/{prtlib}/reports/{key}/lock
Where:
host
Specifies the address of the server that runs the REST API
port
Specifies the port of the server that runs the REST API
PRTLIB
Specifies the dump repository data set name
Key
Report key used to locate a particular report from the report list
Headers
Authorization: Basic Auth with mainframe username and password
Example:  Lock a report:
POST /symdump/api/v1/batch/prtlib/CAI.PRTLIB/reports/{key}/lock
REST API Response and Return Codes
Expected Response
On completion, the service returns an HTTP response. The response includes a status code that indicates whether the
request completed. The status code 200 OK  indicates success.
Example:
{
  "dump": {
    "abend": "string",
    "date": "string",
    "jobName": "string",
    "key": "string",
    "lock": "string",
    "offset": "string",
    "program": "string",
    "stepName": "string",
    "system": "string",
    "time": "string",
    "userID": "string"
  },
  "messages": [
    {
      "messageContent": "string",
      "messageNumber": "string",
      "messageType": "string"
 920


InterTest™ and SymDump ® 11.0
    }
  ],
  "metadata": [
    {
      "messageTime": "string",
      "messageVersion": "string",
      "serviceName": "string",
      "sessionID": "string"
    }
  ]
}
Batch REST API: Unlock
Use the SymDump Batch REST API Unlock endpoint to unlock a report.
HTTP Method and URI Path
The SymDump Batch REST API URI path for the Unlock endpoint has the following format:
POST   http://host:port/symdump/api/v1/batch/prtlib/{prtlib}/reports/{key}/unlock
Where:
host
Specifies the address of the server that runs the REST API
port
Specifies the port of the server that runs the REST API
PRTLIB
Specifies the dump repository data set name
Key
Report key used to locate a particular report from the report list
Headers
Authorization: Basic Auth with mainframe username and password
Example:  Unlock a report:
POST /symdump/api/v1/batch/prtlib/CAI.PRTLIB/reports/{key}/unlock
REST API Response and Return Codes
Expected Response
On completion, the service returns an HTTP response. The response includes a status code that indicates whether the
request completed. The status code 200 OK  indicates success.
Example:
Example:

{
  "dump": {
    "abend": "string",
    "date": "string",
    "jobName": "string",
 921


InterTest™ and SymDump ® 11.0
    "key": "string",
    "lock": "string",
    "offset": "string",
    "program": "string",
    "stepName": "string",
    "system": "string",
    "time": "string",
    "userID": "string"
  },
  "messages": [
    {
      "messageContent": "string",
      "messageNumber": "string",
      "messageType": "string"
    }
  ],
  "metadata": [
    {
      "messageTime": "string",
      "messageVersion": "string",
      "serviceName": "string",
      "sessionID": "string"
    }
  ]
}
Batch REST API: Delete
Use the SymDump Batch REST API Delete endpoint to delete a report.
HTTP Method and URI Path
The SymDump Batch REST API URI path for the Delete endpoint has the following format:
DELETE   http://host:port/symdump/api/v1/batch/prtlib/{prtlib}/reports/{key}
Where:
host
Specifies the address of the server that runs the REST API
port
Specifies the port of the server that runs the REST API
PRTLIB
Specifies the dump repository data set name
Key
Report key used to locate a particular report from the report list
Headers
Authorization: Basic Auth with mainframe username and password
Example:  Delete a report:
DELETE /symdump/api/v1/batch/prtlib/CAI.PRTLIB/reports/{key}
 922


InterTest™ and SymDump ® 11.0
REST API Response and Return Codes
Expected Response
On completion, the service returns an HTTP response. The response includes a status code that indicates whether the
request completed. The status code 200 OK  indicates success.
Example:
{
  "dump": {
    "abend": "string",
    "date": "string",
    "jobName": "string",
    "key": "string",
    "lock": "string",
    "offset": "string",
    "program": "string",
    "stepName": "string",
    "system": "string",
    "time": "string",
    "userID": "string"
  },
  "messages": [
    {
      "messageContent": "string",
      "messageNumber": "string",
      "messageType": "string"
    }
  ],
  "metadata": [
    {
      "messageTime": "string",
      "messageVersion": "string",
      "serviceName": "string",
      "sessionID": "string"
    }
  ]
}
Batch REST API: Options
Use the SymDump Batch REST API Options endpoint to display installation options.
HTTP Method and URI Path
The SymDump Batch REST API URI path for the options endpoint has the following format:
GET  http://host:port/symdump/api/v1/batch/options
Where:
host
Specifies the address of the server that runs the REST API
port
Specifies the port of the server that runs the REST API
 923


InterTest™ and SymDump ® 11.0
Headers
Authorization: Basic Auth with mainframe username and password
Example:  Display installation options:
POST /symdump/api/v1/batch/options
REST API Response and Return Codes
Expected Response
On completion, the service returns an HTTP response. The response includes a status code that indicates whether the
request completed. The status code 200 OK  indicates success.
Example:
{
   "data":"string",
   "messages":[
      {
         "messageContent":"string",
         "messageNumber":"string",
         "messageType":"string"
      }
   ],
   "metadata":[
      {
         "messageTime":"string",
         "messageVersion":"string",
         "serviceName":"string",
         "sessionID":"string"
      }
   ]
}
Batch REST API: Display Report Options
Use the SymDump Batch REST API Display Report endpoint to display formatting options for a report.
HTTP Method and URI Path
The SymDump Batch REST API URI path for the Display Report endpoint has the following format:
GET
http://host:port/symdump/api/v1/batch/prtlib/{prtlib}/reports/{key}/options
Where:
host
Specifies the address of the server that runs the REST API
port
Specifies the port of the server that runs the REST API
PRTLIB
Specifies the dump repository data set name
PKey
Report key used to locate a particular report from the report list
 924


InterTest™ and SymDump ® 11.0
Headers
Authorization: Basic Auth with mainframe username and password
Example:  Display a report:
GET /symdump/api/v1/batch/prtlib/CAI.PRTLIB
/reports/{key}/options
REST API Response and Return Codes
Expected Response
On completion, the service returns an HTTP response. The response includes a status code that indicates whether the
request completed. The status code 200 OK indicates success.
{
  "displayOptions": {
    "asminst": "ON",
    "files": "ON",
    "first128": "ON",
    "linecnt": "60",
    "linkage": "ON",
    "listline": "10",
    "localstor": "ON",
    "memmap": "ON",
    "rptsz80": "ON",
    "savearea": "ON",
    "showheap": "ON",
    "workstor": "ON"
  },
  "dump": {
    "abend": "string",
    "date": "string",
    "jobName": "string",
    "key": "string",
    "lock": "string",
    "offset": "string",
    "program": "string",
    "stepName": "string",
    "system": "string",
    "time": "string",
    "userID": "string"
  },
  "mergingOptions": {
    "binfrmt": "HEX",
    "grpaddr": "ON",
    "mergedb": "ON",
    "mrgauto": "ON",
    "mrgbased": "ON",
    "mrgcntld": "ON",


"mrgbased": "ON",
    "mrgcntld": "ON",
    "mrgdsect": "ON",
    "mrgfiles": "ON",
    "mrglink": "ON",
    "mrglocal": "ON",
 925


InterTest™ and SymDump ® 11.0
    "mrgparms": "ON",
    "mrgstat": "ON",
    "mrgwork": "ON",
    "occurs": "MAX",
    "showunmrg": "ON"
  },
  "messages": [
    {
      "messageContent": "string",
      "messageNumber": "string",
      "messageType": "string"
    }
  ],
  "metadata": [
    {
      "messageTime": "string",
      "messageVersion": "string",
      "serviceName": "string",
      "sessionID": "string"
    }
  ]
}
Batch REST API: Update Report Options
Use the SymDump Batch REST API Update Report endpoint to update options for a report.
HTTP Method and URI Path
The SymDump Batch REST API URI path for the Update Report Options endpoint has the following format:
      POST
      http://host:port/symdump/api/v1/batch/prtlib/{prtlib}/reports/{key}/options
Where:
host
Specifies the address of the server that runs the REST API
port
Specifies the port of the server that runs the REST API
PRTLIB
Specifies the dump repository data set name
Key
Report key used to locate a particular report from the report list
Headers
Authorization: Basic Auth with mainframe username and password
 926


InterTest™ and SymDump ® 11.0
Request Body
Supply a JSON request document (Content-Type=application/json, character-encoding=UTF-8) with the following input
parameters:
Display Options:
Asminst
Displays the abending assembler instruction
Values: ON, OFF
Files
Displays the Open Files report
Values: ON, OFF
First128
Displays only the first 128 bytes of each record
Values: ON, OFF
Linecnt
Specifies the number of lines on formatted pages
Values: A numeric Value
Linkage
Displays the Linkage Section for COBOL programs
Values: ON, OFF
Listline
Specifies the number of additional source lines to display before and after the abending (or snap) statement
Values:
Localstor
Displays Local Storage for COBOL programs
Values: ON, OFF
Memmap
Displays the TGT, DSA, and PGT memory maps
Values: ON, OFF
Rptsz80
Specifies to format using 80-byte output when possible
Values: ON, OFF
Savearea
Displays the Save Area Trace report
Values: ON, OFF
Showheap
Displays LE or PL/I heap storage
Values: ON, OFF
Workstor
Display the Working Storage for COBOL programs
Values: ON, OFF
Merging Options:
Binfrmt
Specifies how to display binary values
Values: DEC (Decimal), HEX (Hexadecimal)
 927


InterTest™ and SymDump ® 11.0
Grpaddr
Specifies whether to display the base locator, displacement, and address of a group item on the merged Data
Division displays
Values: ON, OFF
Mergedb
Specifies whether to merge symbolic name into Database reports
Values: ON, OFF
Mrgauto
Specifies whether to merge symbolic names into PL/I automatic storage
Values: ON, OFF
Mrgbased
Specifies whether to merge symbolic names into PL/I based variable storage
Values: ON, OFF
Mrgcntld
Specifies whether to merge symbolic names into PL/I controlled storage.
Values: ON, OFF
Mrgdsect
Specifies whether to merge symbolic names into Assembler DSECT storage
Values: ON, OFF
Mrgfiles
Specifies whether to merge symbolic names into the File Section for COBOL
Values: ON, OFF
Mrglink
Specifies whether to merge symbolic names into the Linkage Section for COBOL
Values: ON, OFF
Mrglocal
Specifies whether to merge symbolic names into Local Storage for COBOL
Values: ON, OFF
Mrgparms
Specifies whether to merge symbolic names into PL/I parameter storage.
Values: ON, OFF
Mrgstat
Specifies whether to merge symbolic names into PL/I static storage
Values: ON, OFF
Mrgwork
Specifies whether to merge symbolic names into Working Storage for COBOL
Values: ON, OFF
Occurs
Specifies the number of table elements to display for each array
Values: MAX, a numeric value
Showunmrg
Displays storage for unmerged data
Values: OFF, ON, TBLS
Example:  Update a report:
POST /symdump/api/v1/batch/prtlib/CAI.PRTLIB
/reports/{key}/options
 928


InterTest™ and SymDump ® 11.0
{
    "displayOptions": {
        "asminst": "ON",
        "files": "ON",
        "first128": "OFF",
        "linecnt": "60",
        "linkage": "ON",
        "listline": "0",
        "localstor": "ON",
        "memmap": "ON",
        "rptsz80": "OFF",
        "savearea": "ON",
        "showheap": "OFF",
        "workstor": "ON"
    },
    "mergingOptions": {
        "binfrmt": "DEC",
        "grpaddr": "ON",
        "mergedb": "ON",
        "mrgauto": "ON",
        "mrgbased": "ON",
        "mrgcntld": "ON",
        "mrgdsect": "ON",
        "mrgfiles": "ON",
        "mrglink": "ON",
        "mrglocal": "ON",
        "mrgparms": "ON",
        "mrgstat": "ON",
        "mrgwork": "ON",
        "occurs": "1",
        "showunmrg": "TBLS"
    }
}
REST API Response and Return Codes
Expected Response
On completion, the service returns an HTTP response. This response includes a status code that indicates whether the
request completed. The status code 200 OK indicates success.
Example:
{
  "dump": {
    "abend": "string",
    "date": "string",
    "jobName": "string",
    "key": "string",
    "lock": "string",


"key": "string",
    "lock": "string",
    "offset": "string",
    "program": "string",
    "stepName": "string",
    "system": "string",
 929


InterTest™ and SymDump ® 11.0
    "time": "string",
    "userID": "string"
  },
  "messages": [
    {
      "messageContent": "string",
      "messageNumber": "string",
      "messageType": "string"
    }
  ],
  "metadata": [
    {
      "messageTime": "string",
      "messageVersion": "string",
      "serviceName": "string",
      "sessionID": "string"
    }
  ]
}
Using CICS Tools
InterTest for CICS is an interactive tool for testing and debugging CICS COBOL, PL/I, and Assembler programs.
InterTest for CICS
Testing and debugging are the most time consuming and important phases of application development. The interactive
testing facilities of InterTest for CICS dramatically improve testing efficiency and application quality. InterTest for CICS
works online to trap all known CICS application errors. You can resolve multiple errors interactively as the errors occur
without having to recompile or end the test session.
SymDump  for CICS
SymDump  for CICS is a powerful online tool that brings application dumps back to life. SymDump  for CICS improves
your ability to analyze and resolve application program problems. Ideally, you could monitor every program and catch
every error with a product like InterTest for CICS. Realistically, this scenario is not possible because of overhead or
because you may not want to monitor security programs or programs using nonstandard code. As a result, dumps occur,
especially in production where even a thoroughly debugged program abends because of bad data, scheduling errors,
invalid parameters, and other factors beyond programmer control.
Help File Printout


invalid parameters, and other factors beyond programmer control.
Help File Printout
The InterTest for CICS Help file contains extensive tutorial information that is available to you online by entering HELP  or
pressing PF1 from any InterTest for CICS screen. The file has a browse capability from any point of access. You can print
the Help file once it is loaded from the distribution tape using the JCL in the following examples. The program prints one
screen image per page. The input to the program is the VSAM KSDS file that was loaded from the distribution tape.
•The printout is formatted as 81-byte fixed-length records. The first byte contains the ANSI print control character, such
as 1 for new page or a plus sign (+) to overprint the same line.
•The file is produced in uppercase and lowercase to enhance readability.
•The output is over 1000 pages.
•If your printer cannot handle lowercase characters, specify PARM=UPPER in the EXEC statement of the JCL.
 930


InterTest™ and SymDump ® 11.0
Sample MVS JCL to Print the Help File
Use the following MVS JCL to print the Help file.
//PRINHELP JOB....
//STEP1 EXEC PGM=IN25PRIH,REGION=256K
//STEPLIB DD DSN=YOUR.INTRTST.LOADLIB,DISP=SHR
//PROTHLF DD DSN=INTRTSTV.PROTHLF,DISP=SHR
//OUTPUT DD SYSOUT=A
//
CICS Debugging
InterTest for CICS Product Features
InterTest for CICS is an interactive testing and debugging product for CICS applications written in COBOL, PL/1, and
Assembler. Specific compilers support includes:
•Assembler
•COBOL
•COBOL II
•COBOL/370
•COBOL II or COBOL/370 with Optimizer/II
•IBM Enterprise COBOL for z/OS
•PL/1
•PL1/370
•PL/1 for MVS
•IBM Enterprise PL/1 for z/OS
InterTest for CICS is an essential tool for both application and system programmers:
•It makes CICS testing faster, easier, and more effective.
•It prevents CICS crashes by automatically detecting and preventing application errors before they damage CICS.
•It provides powerful capabilities for examining and modifying main and auxiliary storage.
Fast, Easy Testing
The primary function of InterTest for CICS is to help application programmers test and debug their programs quickly and
efficiently. InterTest for CICS has many features that simplify testing, including:
•Interactive testing ability through the InterTest for CICS monitor
•Error detection and prevention
•Diagnostic information display screens
•Program interruption through setting breakpoints


•Error detection and prevention
•Diagnostic information display screens
•Program interruption through setting breakpoints
•Isolated test sessions through monitoring by CICS User ID
Interactive Testing The InterTest for CICS Monitor
InterTest for CICS allows interactive testing. When InterTest for CICS detects an error, you can correct it dynamically (or
go around it) and resume testing, allowing you to correct many errors in one test session.
With InterTest for CICS, you no longer need dumps. All the information you need to diagnose and correct errors is
available online. You can continue testing without recompiling your program or waiting for new printouts.
 931


InterTest™ and SymDump ® 11.0
InterTest for CICS acts as an intermediary between your CICS program and the CICS system. Here is how InterTest for
CICS operates:
•You instruct InterTest for CICS to monitor a program, and then run the program.
•InterTest for CICS inspects every instruction and CICS command before it executes to make sure neither the program
nor CICS itself will fail.
•If an error is detected, InterTest for CICS automatically interrupts the program. This temporary interruption in program
execution is called a breakpoint .
•InterTest for CICS then displays a diagnostic screen explaining the nature of the problem and provides detailed
technical information for correcting it.
Error Detection and Prevention
InterTest for CICS detects and prevents errors before they occur. This means your programs will not abend. InterTest for
CICS does not permit storage violations that could corrupt the data of other programs or cause CICS to fail.
InterTest for CICS inspects every COBOL, PL/1 statement or Assembler instruction and every CICS Command. InterTest
for CICS can detect and prevent the following errors:
•All storage violations (attempts to modify storage not owned by your program)
•Any CICS abend that can occur in a command level program
•All improper or invalid CICS requests (Commands)
•Any statement that would cause a program check or other abend
•All illegal or invalid instructions (for example, STOP RUN)
•All wild branches
•All violations of CICS standards
Diagnostic Information
InterTest for CICS provides the information you need to diagnose and correct errors. When InterTest for CICS detects
an error, it halts the program before the error occurs. This temporary halt in program execution is called an automatic


breakpoint . InterTest for CICS then displays a screen of diagnostic information indicating the statement or instruction
triggering the breakpoint, and InterTest for CICS explains why the error occurred.
The breakpoint display explains why InterTest for CICS halted the program. The program instruction that triggered the
breakpoint is highlighted. You can use all of the InterTest for CICS facilities to find and correct the error without analyzing
a dump.
Interrupt Programs by Setting Breakpoints
To help you test and debug CICS programs effectively, you can also interrupt program execution at any point by setting
breakpoints. You can set four types of breakpoints:
Unconditional  -- the program stops when it reaches a specified location.
Conditional  -- the program stops when it reaches a specified location and a prescribed condition is met (for example, a
variable exceeds a certain limit).
Variable-change -- the program stops at any location if the value of a specified variable has changed (COBOL and
Assembler only).
Request  -- the program stops when it reaches specified CICS Commands, calls to DL/I or DB2, and calls to subroutines,
such as database software.
You also can instruct InterTest for CICS to halt your program each time it executes a specified number of COBOL verbs,
PL/1 statements, or Assembler instructions.
 932


InterTest™ and SymDump ® 11.0
Controlling the pace at which a program executes makes it easier to pinpoint and correct logic errors. For example, when
a program is halted, you can inspect the values of program variables and test data to determine whether processing is
proceeding as planned. You can also dynamically change the value of a data item or generate additional test records
before resuming execution.
When a program is stopped at a breakpoint, you can resume execution at any time and from any point. This means you
can go around errors or dynamically alter the order in which certain routines are executed. When your program is halted at
a breakpoint, you can do the following tasks:
•View your program listing and compiler output online and search for a data string
•Display data items in a Keep window to observe changes in their values
•Display and modify main storage
•Display and modify auxiliary storage
•Set and remove breakpoints
•Instruct InterTest for CICS to halt the program after it executes a specified number of COBOL verbs, PL/1 statements,
or Assembler instructions
•Write and execute indirect commands, which are statements you insert during a test session, without recompiling the
source code
•Display the path (backtrace) that brought the program to its current point
•Display the execution counts of the lines that brought the program to its current point
•Resume program execution or abend the task
•Initiate any CICS transaction
Stable CICS Test and Production Systems
InterTest for CICS protects CICS test and production systems because it will not permit errors that could damage CICS.
In your test CICS system, you can instruct InterTest for CICS to inspect every program for errors. In addition to spotting
program errors, InterTest for CICS detects and prevents all CICS storage violations. With InterTest for CICS, CICS test


systems are less likely to crash, so programmers can work more productively. Additionally, program errors are confined
to a single program -- other programs remain unaffected. Therefore, system throughput improves because trial and error
testing is eliminated, test programs need fewer recompiles, and CICS is much more stable.
InterTest for CICS also helps maintain stable CICS production systems. Using InterTest for CICS in CICS test systems
means programs are less likely to have bugs when they go into production. InterTest for CICS can also monitor new,
modified, and problem programs in production until they are completely debugged. In an emergency, InterTest for CICS
can even monitor all the programs in the production system until you isolate the error. Special options let you adapt
InterTest for CICS to specific production situations.
Examine and Modify Main and Auxiliary Storage
InterTest for CICS has powerful facilities for examining and modifying main and auxiliary storage. You can take advantage
of these facilities while testing a program. For example, you can interrupt program execution at various points to see how
the values of program variables and test data have changed. And, you can dynamically modify storage as your testing
progresses.
Example
You can halt your program, change the value in a flag, initialize a counter, or change the data in a test record, and then
resume execution -- all without recompiling.
You can inspect and modify main and auxiliary storage at any time -- even when no program is executing and InterTest
for CICS is otherwise inactive. System programmers can use InterTest for CICS to fine-tune CICS. They can display the
contents of CICS control blocks and tables in main storage, making changes as necessary.
 933


InterTest™ and SymDump ® 11.0
InterTest for CICS also makes it easy to maintain files online without writing one-time programs. You can use InterTest for
CICS to add, update, and delete records in VSAM and BDAM files and DL/I, DB2 and SQL/DS databases. With InterTest
for CICS, it is easy to browse a file and search for a character string. InterTest for CICS also lets you create and delete
transient data and temporary storage records.
Get HELP
The InterTest for CICS comprehensive Help facility is available from every InterTest for CICS screen. Online help explains
how to use all of the InterTest for CICS facilities, provides important information on diagnosing and correcting program
errors, and includes examples. You can access the Help facility by entering Help on a blank screen. Press PF1 to access
context-sensitive help from any screen. For example, when InterTest for CICS halts your program at an automatic
breakpoint, you can press PF1 to get more information on the error that caused the breakpoint.
User-Defined Help for Abends
You can define your own abend codes and descriptions or replace the delivered abend descriptions with your own text.
If user-defined text is defined for an abend code, InterTest for CICS displays your site's help text instead of the delivered
help text at an automatic breakpoint. For more information, see InterTest for CICS Options.
Online Access to Source Listings and Compiler Output
With InterTest for CICS, you never have to wait for printouts. InterTest for CICS provides online access to your source
listings and compiler output, such as maps, cross-reference tables, and messages -- information your online editor cannot
provide. Working directly from your source listing makes it easy to set breakpoints and display main storage.
Symbolic Support


Symbolic Support
InterTest for CICS lets you reference all program locations by the names you have defined in the program, so you
can forget about displacements or address changes after recompiling. You can inspect the contents of a data item simply
by specifying its name. If you set breakpoints at symbolic locations and then recompile your program, InterTest for CICS
can transfer those breakpoints to the recompiled program. You can also access all CICS system-related areas by field
names. InterTest for CICS even provides full symbolic support for programs that consist of separately compiled modules
brought together when the program is link-edited. These modules can be written in the same or different languages.
InterTest for CICS supports both PROTSYM and DWARF formats for debugging COBOL programs. For more information,
see Symbolic Support.
InterTest for CICS Components
InterTest for CICS consists of these CICS transactions:
ITST  – Displays the ISPF-like Primary Option Menu, which provides access to all other InterTest for CICS and SymDump
for CICS Option facilities without having to know any other transaction or command.
LIST  -- Displays online COBOL, PL/1, and Assembler source listings and compiler output.
CNTL  -- Controls program monitoring.
CORE  -- Inspects and modifies main storage.
FILE  -- Displays and updates CICS files, DL/I, DB2, and SQL/DS databases, temporary storage, or transient data.
HELP  -- Provides online assistance for using InterTest for CICS.
You can use any of these transactions at any time. Your program does not have to be executing for you to use CORE to
display or change the contents of main storage, and you can use FILE to update a file or create a test file whether or not
InterTest for CICS is monitoring any programs.
 934


InterTest™ and SymDump ® 11.0
Different Methods of Using InterTest for CICS
Novice CICS programmers will learn to take advantage of the many features of InterTest for CICS because it is not
necessary to learn command syntax. Standard ISPF-like menus and selection screens make it easy to access any
component in InterTest for CICS at any time.
The ITST transaction displays the Primary Option Menu from which you can access any InterTest for CICS function.
Specially formatted displays and screens also enable you to bypass menu processing by using special commands or
single keystrokes for the most frequently used testing functions. For example, you can instruct InterTest for CICS to set
monitoring, breakpoints or display main storage simply by pressing a PF key or entering a single action character next to a
line in your source listing display. A command line on the top of any Source Listing or Breakpoint display lets you access a
main menu or a specific menu function by entering its fastpath syntax (=X.Y.Z).
More experienced users often find it faster to enter transaction-based commands for LIST, CNTL, CORE, and FILE
facilities directly.
Example
Entering LIST=COBDEMO directly from CICS immediately displays the Source Listing Display of the program
COBDEMO, where you can quickly set breakpoints before you begin executing the program.
You can also mix and match different methods during a single test session to meet your testing needs.
Menus and Displays
This article explains how to use the ISPF-like menus and selection lists to get around InterTest for CICS before, during,
and after your test sessions.
The menus are always available and use a standard set of PF keys.
Additional menu features include the following:
•Support a subset of ISPF commands, including the fast-path Jump (=x.y.z) command for quick navigation


•Simplify navigation among the Source Listing, Monitoring (CNTL), Main Storage (CORE), Auxiliary Storage (FILE), and
SymDump  for CICS (SYMD) displays
This article also explains how to use the Monitoring Status display, an expandable tree-like display of current monitoring
entries. You will find the Status display saves testing time, since you can quickly remove any monitoring, breakpoint, or
monitoring option directly from it.
Primary Option Menu
The menus offer easy access to the InterTest for CICS LIST, CNTL, CORE, FILE, and SYMD facilities. The Primary
Option Menu is available at all times, even if you did not start the session from a menu. For example, if you started your
InterTest for CICS session using LIST=COBDEMO, from the Source Listing Display you can still use PF6 Menu to display
the Primary Option Menu. If you used single-line commands to set monitoring and breakpoints for your program, and then
execute the program and reach a breakpoint, PF 6 Menu displays the Breakpoint Primary Option Menu and Option 1 Main
Menu accesses the Primary Option Menu.
To access the Primary Option Menu, enter ITST from CICS, from any Source Listing display or breakpoint, or any
InterTest for CICS menu.
•Before a test session, sign on to CICS, and then enter the ITST  transaction
•From any Source Listing display or breakpoint display, type ITST on the command line
•From the Breakpoint Primary Option Menu, type ITST or select option 1 Main Menu
Following is a list of each menu option and the subsequent menu options that are available.
•Option 1 --  Source
 935


InterTest™ and SymDump ® 11.0
1 -- Source listings
2 -- Symbolic files
Selecting options from this menu launches relevant source listing displays. (LIST=progname)
•Option 2 -- Monitoring
1 -- Programs
2 -- Transactions
3 -- Terminals
4 -- Status
5 -- Active tasks
6 -- System-wide
7 -- Debugging sessions
Selecting options from this menu launches relevant monitoring menus and CNTL menus and subsequent monitoring
status displays.
•Option 3 -- Main Storage
1 -- System Areas
2 -- Task Areas
3 -- Breakpoint Areas
Selecting options from this menu launches relevant storage displays of CORE
•Option 4 -- Auxiliary Storage
1 -- Files
2 -- DB2 database
3 -- DL/I database
4 -- TS queues
5 -- TD queues
Selecting options from this menu launches relevant displays of FILE
•Option 5 -- SymDump
1 -- Analysis
2 -- Tracing
3 -- Configuration
4 -- Start
5 -- Stop
6 -- Source
7 -- Status/Maintenance
8 -- What's New?
X -- Exit
Selecting options from this menu launches relevant SymDump selection panels and displays
•Option 6 -- Product Help
This option launches the main menu for all help topics.
•Option 7 -- Status/Maintenance
1 -- Product Status
2 -- Abend Descriptions
Selecting options from this menu launches relevant displays for programs, transactions, file statuses, global options,
and symbolic file names for InterTest for CICS and SymDump  for CICS, as well as abend code maintenance panels.
•Option 8 -- What's New?
This option launches the portion of the help facility that describes the new product features.
•X -- Exit
Breakpoint Primary Option Menu


•X -- Exit
Breakpoint Primary Option Menu
When you are at a breakpoint, InterTest for CICS includes a Breakpoint Primary Option Menu, from which you can access
the following options. Press PF6 to access the Breakpoint Primary Option menu.
 936


InterTest™ and SymDump ® 11.0
Main menu
Display the InterTest primary option menu
Status
Display or remove current monitoring options
Abend
Abend the breakpointed task
Resume
Resume breakpointed task menu options
Override
Override automatic breakpoint default processing
Dump
Cause dump, resume from next sequential instruction
Disconnect
Disconnect the breakpoint from this terminal
Hogan SMART
Invoke Hogan System's debugging facility
Exit
Terminate breakpoint menu processing
Option Selection
Option selection for the new menus follows standard ISPF conventions. To select a menu option, enter its number in the
Option==> field and press Enter . If you have questions about menu usage, press PF1 for menu-specific help.
Fast-path Option Selection (=x.y.z)
The Option field of menus (and the command line of the Source Listing Facility) support the Jump (=x.y.z) command
notation, also known as fastpath notation. Jump notation lets you bypass intermediate menus by making a series of
selections in the format x.y.z. The equal sign indicates your selection starts from the top level menu in the current
hierarchy. If you do not include the equal sign, your selection starts from the current menu.
Fast-path Notation
When a submenu to a Primary Option Menu is discussed in this article, its fast-path from the Primary Option Menu is
written in parentheses following the menu name.
Example
 ... Program Monitoring menu (2.1)...
the notation indicates that the Program Monitoring menu is option 2 Monitoring on the Primary Option Menu, and then
option 1 Programs on the Monitoring Menu.
PF Keys
All menus and selection lists have a standard set of PF keys.
PF1 Help
Displays a Help menu relating to the current menu or display. At an automatic breakpoint, gives help for the
specific problem. Use Clear to exit help.
PF3 End


specific problem. Use Clear to exit help.
PF3 End
Ends the current display and returns to the previous menu or display.
 937


InterTest™ and SymDump ® 11.0
PF4 Return
Returns to the highest level menu, either the Primary Option Menu or the Breakpoint Primary Option Menu.
PF7 Backward
Scrolls a list back one page, or scrolls back to the list item indicated by the user's cursor.
PF8 Forward
Scrolls a list forward one page, or scrolls down to the list item indicated by the user's cursor.
Selection and Navigation Commands
InterTest for CICS and the SymDump  for CICS support the following standard ISPF commands in the top OPTION==>
line of menus and COMMAND ==> line of Selection Lists. These commands let you quickly navigate through screens with
selection lists and tree structures.
NOTE
All commands do not apply to all screens.
Example
EXPAND and COLLAPSE apply only to screens with tree structure displays, and LOCATE applies only to selection lists
displayed in alphanumeric order.
BACKWARD BWD
Same as PF7, scrolls backwards or towards the top of the selection list.More: - (minus sign) indicates there are
more selections to view using PF7 or BACKWARD.
BOTTOM
BOT
Scrolls to the bottom of a selection list.
COLLAPSE
Same as PF5 Collapse. Collapses a branch in a tree structure to show only the base entry. A minus sign in front
of tree structure entry indicates the branch can be collapsed.
DOWN
Same as FORWARD.
END
Same as PF3. Ends the current function and returns to the previous menu or display.
EXPAND
Expands a branch in a tree structure to show all related entries. A plus sign in front of a tree structure entry
indicates the branch can be expanded.
FORWARD
FWD
Same as PF8, scrolls the display list forward towards the bottom of the selection list. The More: + (plus) field


indicates there are more entries to view using PF8 or FORWARD. Use the cursor to go to an entry in the middle of
a display and press PF8 (Forward) to position that entry at the top of the display.
HELP
Same as PF1, displays help for the current screen. Once in the help facility, follow the help panel instructions to
access additional or related help topics. To exit help, use PF3 or Clear.
LOCATE
LOC
L
Locates a selection in a list based on the character string you enter. For example, LOC COBDEMO locates
COBDEMO in the current selection list. Accepts masking characters * and ?
 938


InterTest™ and SymDump ® 11.0
MAIN
Same as PF4 Return. Returns you to the highest level menu, such as the Primary Option Menu.
REFRESH
Same as PF2 Refresh. Refreshes or redraws the current display to reflect recent modifications. For example, after
removing options from a Monitoring Status display, use REFRESH to eliminate the removed entries from the tree
view.
RETURN
Same as PF4 Return. Returns you to the highest level menu, such as the Primary Option Menu (before a test
session) or the Breakpoint Primary Option Menu (at a breakpoint).
SELECT
SEL
S
Selects an option on a menu.
TERMINAL
TERM
Displays the current Terminal ID.
TIME
Displays the current time.
TOP
Scrolls to the first entry in a selection list.
UP
Same as PF7, Backward.
USER
Displays the current CICS user ID.
Diagnostic Information
InterTest for CICS provides the information you need to diagnose and correct errors. When InterTest for CICS detects
an error, it halts the program before the error occurs. This temporary halt in program execution is called an automatic
breakpoint . InterTest for CICS then displays a screen of diagnostic information indicating the statement or instruction
triggering the breakpoint, and InterTest for CICS explains why the error occurred.
The breakpoint display explains why InterTest for CICS halted the program. The program instruction that triggered the
breakpoint is highlighted. You can use all of the InterTest for CICS facilities to find and correct the error without analyzing
a dump.
Monitoring Status Display
The Monitoring Status display shows you current monitoring, breakpoints and monitoring options in effect for one, or for all
monitoring entries.
Sample Status
The following screen is a sample Monitoring Status display for the program COB2DEMO. This example shows the


expanded monitoring entry for the Program COB2DEMO.
                     CA InterTest for CICS  MONITORING STATUS
COMMAND ===>

  Type + to expand or  collapse option levels displayed below,
         or R to remove option(s).
 939


InterTest™ and SymDump ® 11.0
                                                                      More:   +
    Option     Description                Attributes
_ COB2DEMO  Program monitor entry      COBOL II
    |       Waiting at breakpoint      Task 00043, UBP since 08:48 a.m.
_   |.ANY   User monitoring options    Active
_   |.ANY   User monitoring options    Deactivated
     |      Symbolic listing file      PROTDEM
     |      Symbolic listing file      PROTDEM
r    |RBP   Request breakpoint(s)      DSNHLI calls
     |      Option ID                  CB1E38D7
     |      From, to terminals         X508, X508
     |      On count, times thru, left 39, 0, 39
_ +  |UBP   Unconditional breakpoint   #386
_ +  |UBP   Unconditional breakpoint   #389
_    |SLB   Source listing breakpoints .ANY
_    |SLB   Source listing breakpoints X508

PF1 Help       2 Refresh    3 End        4 Return     5 Collapse   6 Expand
PF7 Backward   8 Forward    9           10           11           12
Review the following list to remember what each Option listed on this status display means.
•The COB2DEMO option identifies the program being monitored is COB2DEMO, a COBOL program. Notice the rest of
the Options are indented under COB2DEMO, indicating they are options to this monitoring entry.
•The .ANY option indicates this program is being monitored under .ANY user. If you were monitoring under a single


User ID, you would see a specific User ID, such as MARY01, instead of .ANY.
•Notice the rest of the options are indented under .ANY. This indicates they are options for the monitoring entry
COB2DEMO when executed by .ANY user.
•The RBP option identifies a request breakpoint was set for this monitoring entry for all DSNHLI calls. Notice that the
breakpoint is assigned the Option ID# CB1E38D7. This request breakpoint takes affect when the program executes at
the terminal X508 and displays on the terminal X508 (the current terminal).
•The SLB option indicates the Source Listing Breakpoint display is the default for all breakpoint displays.
Access
The Monitoring Status display is conveniently accessed from the menus and the Source Listing facility.
To get a Monitoring Status for a single monitoring entry, such as a single program:
•From the Source Listing Display or Source Listing Breakpoint screen, enter STATUS in the COMMAND ===> line
when the current program is displayed and press Enter , or press PF12 Status .
•From the Breakpoint Primary Option Menu, select option 2 Status .
From the Primary Option Menu, complete the Monitoring Menus for the Program (2.1), Transaction (2.2), or Terminal (2.3),
and select the Status option from the option list.
To get a Monitoring Status for all monitoring entries, perform the following steps:
•From the Source Listing Display or Source Listing Breakpoint screen, enter STATUS ALL in the COMMAND ===> line.
•From the Primary Option Menu, select Option 2.4 Monitoring Status.
The following screen shows a Monitoring Status display for all entries.
                    CA InterTest for CICS MONITORING STATUS
 COMMAND ===>

   Type + to expand or  collapse option levels displayed below,
 940


InterTest™ and SymDump ® 11.0
          or R to remove option(s).

     Option     Description                Attributes
 _ + COBDEML    Program monitor entry      COBOL
 _ + COBDEMO    Program monitor entry      COBOL
 _ + COB2DEMO   Program monitor entry      COBOL II
 _ + PL1DEMO    Program monitor entry      PL/I
                *** End of data ***

 PF1 Help       2 Refresh    3 End        4 Return     5 Collapse   6 Expand
 PF7 Backward   8 Forward    9           10           11           12
Expand and Collapse Entries
Collapse and expand entries on the monitoring status display. An option preceded by a plus sign (+) can be expanded,
and an option preceded by a minus sign (-) can be collapsed.
•To collapse all entries, press PF5 Collapse or use the COLLAPSE command.
•To fully expand all entries, press PF6 Expand or use the EXPAND command.
•To collapse all entries below an option, tab to the selection field in front of the option, type - (a minus sign), and press
Enter .
•To expand all entries for a specific option, tab to the selection field in front of the option, type + (a plus sign), and press
Enter .
Remove Monitoring, Breakpoints, or Other Options
Enter the letter   r  in the selection field next to any option to remove it. This removes the option and any options in that
branch. For example, removing monitoring for COB2DEMO removes all monitoring options and breakpoints too.
Removing breakpoints, especially request breakpoints, is simple using the status display. First, display the status report


Removing breakpoints, especially request breakpoints, is simple using the status display. First, display the status report
for the monitored entry and expand the monitored entry to view all options. Next, enter r next to the breakpoint you want to
remove, and press Enter.
The following screen is an example of removing the request breakpoint for COB2DEMO, monitored under ANY user.
               CA InterTest for CICS MONITORING STATUS
COMMAND ===>

  Type + to expand or  collapse option levels displayed below,
         or R to remove option(s).
                                                                      More:   +
    Option     Description                Attributes
_  COB2DEMO   Program monitor entry      COBOL II
   |          Waiting at breakpoint      Task 00043, UBP since 08:48 a.m.
_  |.ANY      User monitoring options    Active
_  |.ANY      User monitoring options    Deactivated
    |         Symbolic listing file      PROTDEM
    |         Symbolic listing file      PROTDEM
r   |RBP      Request breakpoint(s)      DSNHLI calls
              Option ID                  CB1E38D7
    |         From, to terminals         X508, X508
    |         On count, times thru, left 39, 0, 39
 941


InterTest™ and SymDump ® 11.0
_ + |UBP      Unconditional breakpoint   #386
_ + |UBP      Unconditional breakpoint   #389
_   |SLB      Source listing breakpoints .ANY
_   |SLB      Source listing breakpoints X508

PF1 Help       2 Refresh    3 End        4 Return     5 Collapse   6 Expand
PF7 Backward   8 Forward    9           10           11           12
Refresh the Display
After removing an option, refresh the display to reflect your changes. Use the REFRESH Command or press PF2 Refresh.
Exit the Status Display
Press  PF3  End or PF4 Return to exit the Status display.
Source Listing Facility for InterTest
Use the InterTest for CICS Source Listing facility to debug your program while viewing your source code. You can access
all of the other InterTest for CICS facilities -- ITST, CNTL, CORE, FILE, HELP and SYMD (for SymDump  for CICS licensed
users) directly from the Source Listing facility using menus or single-line commands.
As you become familiar with the Source Listing facility, keep in mind that there is no such thing as a cookbook method of
using InterTest for CICS. How you use it depends on your particular testing needs.
For more information, see Composite Module Testing.
Prepare Your Program
NOTE
•This section describes the procedure for using PROTSYM as a symbolic format. For instructions on
preparing your program with DWARF as a debugging format, see DWARF.
•For detailed instructions on how to modify your JCL, see Symbolic Support.
To prepare a program for source listing testing and symbolic testing, you must modify the compile or assemble JCL to


include an InterTest for CICS post-processor step. For source listing testing, the LISTER parameter of the post-processor
is required. After modifying the JCL, recompile or reassemble the program. This puts the program's listing in the InterTest
for CICS Symbolic File.
Start InterTest in Your CICS Region
InterTest for CICS is generally started once a day. At many sites, InterTest automatically starts during CICS initialization.
Additionally, InterTest automatically starts whenever you complete a monitoring-related request from the Monitoring
Menus or Submenus (Option 2 on the Primary Option Menu).
To start InterTest for CICS or to verify that InterTest for CICS is up and running, sign on to CICS and issue the following
command on a Clear screen:
CNTL=START
InterTest for CICS responds with a message stating either that it has successfully started or that it is already active. If
CICS responds with a message stating that CNTL is an invalid transaction, the systems programmer who installed
InterTest for CICS probably changed the name of the CNTL transaction. Find out the new transaction ID and try again.
 942


InterTest™ and SymDump ® 11.0
InterTest for CICS Transaction IDs
InterTest for CICS has the following standard transaction IDs: ITST, CNTL, CORE, FILE, LIST, HELP, and an additional
transaction ID for licensed SymDump  for CICS users: SYMD. These IDs might have been modified when InterTest for
CICS was installed. If the HELP transaction ID was not modified, you can learn your current transaction IDs by entering
Help on a Clear screen.
Start a Test Session
To begin testing, be sure you have compiled or assembled your program with the InterTest for CICS post-processor step
using the LISTER parameter, and then set monitoring and breakpoints in your program.
Follow these steps:
1.Perform CICS sign on.
2.Display your source code.
3.Set monitoring.
4.Set breakpoints.
5.Initiate your program and begin testing.
Perform CICS Sign On
If you are working in a secure CICS region, always sign on to CICS before using InterTest for CICS. InterTest for CICS
monitoring is sensitive to CICS user IDs.
Display Your Source Code
Access the InterTest for CICS Source Listing facility using the following methods to view the compiled or assembled listing
of your program:
•ITST Primary Menu Option access, Option 1 Source
•Command access: LIST=  progname
Menu Access
Use the ITST Primary Menu, Option 1 Source , to select your program from a selection list by program name or by
SYMBOLIC file name. For details, see Source Selection List.
Command Access
To use the single-line CICS command, sign on to CICS. On a clear screen, enter:
LIST=progname
progname
Specifies the name of your program.


LIST=progname
progname
Specifies the name of your program.
InterTest for CICS displays your program on the Source Listing Display screen. From this screen set monitoring and
breakpoints.
If a message informs you that the listing is not available, consider the following:
•Is the program name correct?
•Is the program in the InterTest for CICS Symbolic File?
•Was the program compiled or assembled with the LISTER option?
If there are multiple copies of the program you specified, InterTest for CICS asks you to select the program that you want
to run. When you make your selection and press Enter, InterTest for CICS displays the Source Listing of your program.
For more information, see Maintain Synchronized Processing.
 943


InterTest™ and SymDump ® 11.0
Set Monitoring
While viewing the program listing, enter monitor  in the top Command Line. This is the same as pressing PF5 Monitor .
NOTE
InterTest for CICS monitoring and breakpoints include a CICS user ID option. For a discussion of this option, see
Set Monitoring.
Set Breakpoints
Setting breakpoints enables you to control program execution. InterTest for CICS halts program execution when the
program reaches a breakpoint, which lets you use any InterTest for CICS facility before continuing execution.
Initiate Program and Begin Testing
To exit to CICS, press PF3 End  or Clear  to terminate the Source Listing facility. If you entered through the menus, exit the
menus using =X or PF3 End.
To begin testing, execute the program as you normally would. In a secure CICS region, be sure to sign on to CICS before
executing the program.
The Source Selection List
From CICS, use the ITST transaction to display the InterTest for CICS Primary Option Menu. Select Option 1 Source  to
display the InterTest Source Menu.
This menu has two uses:
•Display a listing or a list of listings (type 1 in the Option field).
•Display a symbolic file or a list of symbolic files (type 2 in the Option field), and then select a Symbolic file to display
the Program Listings for that file.
In the unlabeled text fields, enter either the listing name or the InterTest for CICS Symbolic File name. Use masks to filter
the selection list for items matching the filter criteria:
•Use * in place of a string of any length.
•Use + for a single character.
Example


•Use + for a single character.
Example
A mask of COBD++O filters for any seven letter item that begins with the letters COBD, has an O in the last position, and
has any valid character in the fifth and sixth positions. For instance, COBDEMO, COBDXXO, and COBDABO would all
meet the mask criteria, but COBDEML or COBDEM would not.
•Leave the fields blank to display all symbolic files or listings.
Once you specify a listing, file or mask and press Enter, InterTest for CICS displays the Source Listing Selection menu,
showing all the files or listings meeting the criteria you specified on the Source Menu. Type S next to the file or listing
you want and press Enter  to display that file or listing in the Source Listing display. The following screen shows a sample
result of the criteria entered on the Source Menu shown previously.
CA InterTest for CICS SOURCE LISTING SELECTION
 COMMAND ===>

   Name     File        Created      Size  Attributes
 _ CICSCOBA PRTSYM1  09/20/13 16:38    29  COBOL II, no purge
 _ CICSCOBB PRTSYM1  09/20/13 16:13    21  COBOL II, no purge
 _ COBDEML  PROTSYM  07/07/13 09:32    17  COBOL, no purge, composite
 _ COBDEMO  PROTSYM  07/07/13 09:25    70  COBOL, no purge
 944


InterTest™ and SymDump ® 11.0
 _ COB2DEML PROTSYM  07/07/13 09:33    25  COBOL II, no purge, composite
 _ COB2DEMO PROTSYM  07/21/13 10:34   158  COBOL II, no purge
 _ COB2DMLX PRTSYM1  09/21/13 16:10    26  COBOL II, no purge, composite
 _ COB2INSP PRTSYM1  02/01/13 09:11   155  COBOL II, no purge
 _ COB2IN25 PROTSYM  07/07/13 09:31    11  COBOL II, no purge
 _ COB2XCTL PRTSYM1  09/22/13 13:38   159  COBOL II, no purge
 _ CSBIN25  PROTSYM  07/07/13 09:29     8  COBOL, no purge
 _ C370DEML PROTSYM  07/07/13 09:33    27  COBOL/370, no purge, composite
 _ C370DEMO PROTDGG  12/12/13 12:51   161  COBOL/370, no purge
 _ C370DEMO PROTWSD  12/12/13 12:51   161  COBOL/370, no purge
 _ C370DEMO PROTSYM  07/21/13 16:35   161  COBOL/370, no purge