Choosing a method or methods for starting Debug Tool

Table 1 indicates that there are several different methods to start Debug Tool for each type of program. In this topic, you will read about the circumstances in which each applicable method works for each type of program. Then you can select which method would work best for your site. After you complete this topic, you will have selected the methods that work best for your programs.

Table 1. Methods for specifying the TEST runtime options and the subsystems that support these methods.
  TSO JES batch UNIX System Services CICS® DB2® DB2 stored procedures (PROGRAM TYPE=MAIN) DB2 stored procedures (PROGRAM TYPE=SUB) IMS™ TM IMS batch IMS BTS
Use the EQADBCXT user exit routine   X             X X
Use the EQADICXT user exit routine               X   X
Use the EQADDCXT user exit routine           X X5      
Use the DFSBXITA user exit               X X X
Use the CADP transaction       X            
Use the DTCN transaction       X            
Use the DB2 catalog           X2 X      
From within a program by coding a call to CEETEST, __ctest(), or PLITEST X X X X X X X X X X
Through CEEUOPT or CEEROPT X X X X1 X1 X1,2   X X X
Use the CEEOPTS DD statement in JCL or CEEOPTS allocation in TSO X X X   X       X X
Use the parameters on the EXEC statement when you start your program   X                
Use the parameters on the RUN statement when you start your program         X          
Use the parameters on the CALL statement when you start your program X                  
Through the EQASET transaction3               X3    
Through the EQANMDBG program4 X4 X4             X4 X4
Use the EQAD3CXT user exit routine   X       X X X X X
Note:
  1. You cannot use CEEROPT to specify TEST runtime options.
  2. The DB2 catalog method always takes precedence over CEEUOPT.
  3. This method is only for non-Language Environment® assembler programs.
  4. This method is only for non-Language Environment programs.
  5. This method is only for DB2 stored procedures invoked with the call_sub function.
  6. EQAD3CXT now also supports DB2 stored procedures (PROGRAM TYPE=SUB) if you set the RRTN_SW flag as x'01'.

For each subsystem, Table 1 shows that you can choose from several different methods of specifying the TEST runtime options. The following list can help you select the method that best applies to your situation, ordered by flexibility and convenience:

For TSO programs
  1. For programs that start in Language Environment, specify the TEST runtime options using the CEEOPTS allocation in TSO for the most flexible method of specifying the runtime options.
  2. Specify the TEST runtime options using the parameters on the CALL statement if you have a small number of runtime options or need to invoke EQANMDBG for a non-Language Environment program.
  3. If you specify the TEST runtime options by coding a call to CEETEST, __ctest(), or PLITEST, you will have to recompile your program every time you want to change the options.
For JES batch programs
  1. For programs that start in Language Environment, specify the TEST runtime options using the CEEOPTS DD statement in your JCL for the most flexible method of specifying runtime options.
  2. Specify the TEST runtime options using the parameters on the EXEC statement option if you have a small number of runtime options or need to invoke EQANMDBG for a non-Language Environment program.
  3. If you specify the TEST runtime options by coding a call to CEETEST, __ctest(), or PLITEST, you will have to recompile your program every time you want to change the options.
For UNIX System Services programs
  1. Specify the TEST runtime options by setting the _CEE_RUNOPTS environment variable.
  2. If you specify the TEST runtime options by coding a call to CEETEST, __ctest(), or PLITEST, you will have to recompile your program every time you want to change the options.
For CICS programs
  1. Specify the TEST runtime options using either the DTCN or CADP transaction to create and store a profile that contains the TEST runtime options.
  2. If you specify the TEST runtime options by coding a call to CEETEST, __ctest(), or PLITEST, you will have to recompile your program every time you want to change the options.
For DB2 programs
  1. Specify the TEST runtime options using the CEEOPTS DD statement in JCL or CEEOPTS allocation in TSO for the most flexible method of specifying runtime options.
  2. Specify the TEST runtime options using the parameters on the RUN statement option if you have a small number of runtime options.
  3. If you specify the TEST runtime options by coding a call to CEETEST, __ctest(), or PLITEST, you will have to recompile your program every time you want to change the options.
For DB2 stored procedures that have the PROGRAM TYPE of MAIN
  1. Specify the TEST runtime options using the Language Environment EQADDCXT or EQAD3CXT user exit routine. You can run the stored procedure with your own set of suboptions. Another user can run or debug the stored procedure with a separate set of suboptions. Therefore, multiple users can run or debug the stored procedure at the same time.
  2. If the exit routine is not available at your site, specify the TEST runtime options using the DB2 catalog. However, you are limited to specifying one specific set of suboptions, which means that every user that runs or debugs that stored procedure uses the same set of suboptions.

If you implement both methods, the Language Environment exit routine takes precedence over the DB2 catalog.

For DB2 stored procedures that have the PROGRAM TYPE of SUB
  • For programs invoked with the call_sub function, specify the TEST runtime options using the Language Environment EQADDCXT or EQAD3CXT exit routine. You can run or debug the DB2 stored procedure with your own set of suboptions, while another user can run or debug the DB2 stored procedure with a separate set of suboptions.

    If the exit routine is not available at your site, specify the TEST runtime options using the DB2 catalog. You are limited to specifying one set of suboptions, which means that every user that runs or debugs that stored procedure uses the same set of suboptions.

    If you implement methods, the Language Environment exit routine takes precedence over the DB2 catalog.

  • For programs invoked by any other method, specify the TEST runtime options using the DB2 catalog. You are limited to specifying one set of suboptions, which means that every user that runs or debugs that stored procedure uses the same set of suboptions.
For IMS TM programs
  1. Specify the TEST runtime options using the Language Environment EQADICXT or EQAD3CXT user exit routine.
  2. If your program is a non-Language Environment program, issue the EQASET transaction to setup your debugging preference.
  3. If the EQADICXT or EQAD3CXT user exit routine is not available at your site, specify the TEST runtime options using the DFSBXITA user exit routine.
  4. If the EQADICXT, EQAD3CXT, or DFSBXITA user exit routines are not available at your site, specify the TEST runtime options using CEEUOPT or CEEROPT.
  5. If none of the previous options are available at your site, specify the TEST runtime options by coding a call to CEETEST, __ctest(), or PLITEST. However, you will have to recompile your program every time you want to change the options.
For IMS batch programs
  1. For programs that start in Language Environment, specify the TEST runtime options using the CEEOPTS allocation in JCL because this method can be the most flexible method.
  2. Specify the TEST runtime options using the EQADBCXT or EQAD3CXT user exit routine.
  3. If your program is a non-Language Environment program, use the EQANMDBG program to start your debugging session.
  4. If the EQADBCXT or EQAD3CXT user exit routine is not available at your site, specify the TEST runtime options using the DFSBXITA user exit routine; however, you must specify PROGRAM rather than TRANSACTION.
  5. If the EQADBCXT, EQAD3CXT, or DFSBXITA user exit routines are not available at your site, specify the TEST runtime options using CEEUOPT or CEEROPT.
  6. If none of the previous options are available at your site, specify the TEST runtime options by coding a call to CEETEST, __ctest(), or PLITEST. However, you will have to recompile your program every time you want to change the options.
For IMS BTS programs
  1. For programs that start in Language Environment, specify the TEST runtime options using the CEEOPTS allocation in JCL because this method can be the most flexible method.
  2. Specify the TEST runtime options using the EQADICXT or EQAD3CXT user exit routine.
  3. If your program is a non-Language Environment program, use the EQANMDBG program to start your debugging session.
  4. If the EQADICXT or EQAD3CXT user exit routine is not available at your site, specify the TEST runtime options using the EQADBCXT user exit routine.
  5. If the EQADBCXT user exit routine is not available at your site, specify the TEST runtime options using the DFSBXITA user exit routine.
  6. If the EQADICXT, EQAD3CXT, EQADBCXT, or DFSBXITA user exit routines are not available at your site, specify the TEST runtime options using CEEUOPT or CEEROPT.
  7. If none of the previous options are available at your site, specify the TEST runtime options by coding a call to CEETEST, __ctest(), or PLITEST. However, you will have to recompile your program every time you want to change the options.

After you have identified the method or methods you will use to start Debug Tool, see Planning your debug session to determine the next task you must complete.

Parent topic: Planning your debug session