Setting up the MVS Batch Db2 environment

You trigger the CLIP agent back-end in MVS™ batch applications by using the Language Environment TEST option. This option triggers LE to attach the CLIP agent back-end to the application when the application is started. The values that are passed on the TEST option include the IP/hostname and port of the CLIP agent front-end. Prefix the IP address or hostname with RIT& so that the CLIP agent back-end can co-exist with other debuggers and tools that might be installed on the z/OS computer. For information about coexistence with other debuggers, see the Supported Environments section of Testing with IBM Db2 on z/OS systems.
The format of the TEST option is:
TEST(,,,RIT&abc.example.com%8003:*)

You typically specify the TEST option in the startup JCL of the application. Make available the load module dataset that contains the CLIP agent back-end on STEPLIB of the application.

See this sample JCL to start an MVS batch COBOL/PL/I program. In this sample:
  • The application to be started is called SAMPLE, and is connected to the Db2 subsystem DBID.
  • The CLIP agent front-end is listening on port 8003 at abc.example.com
  • RIT.HRVD871.HRELOAD refers to the installed location of the CLIP agent back-end (probe) load module dataset:
  • The AQE_DBG_DB2SSID environment variable is set to DBID. This variable must be specified to provide the unique SSID (identifier) of the Db2 subsystem that is accessed by the application.
  • The AQE_DBG_DBRM environment variable is set to the names of the datasets containing the DBRMs associated with the program being tested.
  • The AQE_DBG_RIT_ID environment variable is set to 192.168.1.1. If the CLIP front end is connected to more than one instance of HCL OneTest API, the events detected by the CLIP agent back-end will only be forwarded to the HCL OneTest API instance on host 192.168.1.1. For more information about this environment variable, see Understanding the Compiled Language Interception Processor (CLIP).
//RITRUN JOB ,
// MSGCLASS=H,MSGLEVEL=(1,1),TIME=(,4),REGION=70M,COND=(16,LT)
//RUNSTEP  EXEC PGM=IKJEFT01
//STEPLIB  DD DSN=SHARE.DSNG10.VERS2.SDSNEXIT,DISP=SHR
//         DD DSN=SHARE.DSNG10.VERS2.SDSNLOAD,DISP=SHR
//         DD DSN=USER1.COBOL.LOAD,DISP=SHR
//         DD DSN=RIT.HRVD870.HRELOAD,DISP=SHR
//SYSTSPRT DD SYSOUT=A
//CEEOPTS  DD  *
TEST(,,,RIT&abc.example.com%8003)
ENVAR("AQE_DBG_DBRM=//'USER1.COBOL.DBRM'://'USER1.COBOL.DBRM2'",
      "AQE_DBG_DB2SSID=DBID")
//SYSTSIN  DD *
  DSN SYSTEM(DBID)
  RUN PROGRAM(SAMPLE) -
    LIB('USER1.DB2.COBOL.LOAD') -
    PLAN(USER1)
  END
/*
// 
Feedback