Rational Developer for System z

Creating a debug configuration for a CICS application

You can create debug configuration to activate as a DTCN profile that stores information used to invoke the CICS® debugger.
Support for CICS debug configurations requires the following software:

Before you can create a debug configuration for CICS, you need to have defined at least one CICS connection.

Some fields in the CICS Debug Configuration wizard are specific to the version of IBM Debug Tool in use at your site. Use the CICS Debug Configuration preference page to specify the IBM Debug Tool version.

You can create a CICS debug configuration from the following views:
  • z/OS® Projects
  • CICS Explorer views (Programs or Transactions)
  • Enterprise Service Tools Project Explorer
Rational Developer for System z® allows you to create multiple debug configurations and store them on your client. On the remote system, only one debug profile at a time can be active. Activating any of the debug configurations on the client activates the remote profile and deactivates all other configurations on the client.

To create a CICS debug configuration:

  1. To start the CICS debug configuration wizard:
    Option Description
    From this environment: Do these steps:
    Debug menu Click the debug icon (Debug icon) and then select Debug Configurations.
    z/OS Projects view Select a z/OS project and then select CICS Debug > Debug Configurations from the pop-up menu.
    CICS Explorer views (Programs or Transactions) Select programs or a transaction and then select Debug > Debug Configurations.
    Enterprise Service Tools Project Explorer Select a Single Service (XSE) Web Services for CICS project or an SFM flow and then select Debug > Debug Configurations.
    The Debug Configurations wizard opens
  2. From the list on the left, right-click Remote CICS Application and select New. The CICS debug configuration wizard opens.
  3. Type a name for the new debug configuration in the Name field.
  4. Complete the required fields and any other optional fields in the wizard and click Apply to save the configuration. After you click Apply, the new configuration is saved on the client and the remote debug profile is created or updated. The Debug button remains disabled because this wizard does not provide the ability to run the CICS transaction. This wizard contains four tabbed pages: CICS, Debug Options, Connections, and Advanced. The following table describes the fields on each page.
    Table 1. CICS Debug Configuration fields
    Page Field Description
    CICS Target CICS Region Select the CICS region name. You need to have defined at least one CICS connection to be able to view CICS regions. This field is required.
      Transaction Name Specify the CICS transaction to debug. This field, or the Program Name field, is required.
      Program Name Specify the program or programs that you want to debug. This field, or the Transaction Name field, is required.
    Note: This option appears if your site is running IBM Debug Tool version 9.1 on the remote system. Use the CICS Debug Configuration preference page to specify the IBM Debug Tool version. To open this preference page, click the Preferences link.
      Load Module and Compile Unit Specify the load module name and compile unit name combination(s) that you want to debug. This field, or the Transaction Name field, is required. Use the Add, Edit, and Remove buttons to specify the load module name and compile unit name combination that you want to debug.
    Note: This option appears if your site is running IBM Debug Tool version 10.1 on the remote system. Use the CICS Debug Configuration preference page to specify the IBM Debug Tool version. To open this preference page, click the Preferences link.
      User ID Specify the user identifier associated with the transaction you want to debug.
      Netname Specify the four-character name of a CICS terminal or a CICS system that you want to use to run your debugging session.
      IP The client IP name or IP address that is associated with a CICS application. All IP names are treated as uppercase. you can specify wildcard characters (* and ?). Debug Tool is invoked for every task that is started for the client.
      Profile activation Select one of the following radio buttons to activate or inactivate the current profile:
    • Activate this configuration as the debug profile on the remote system
    • Inactivate this configuration
    Although you can create multiple CICS debug configurations on the client, only one profile associated with your user ID can be active on the remote system. When you activate one debug configuration, all others are automatically inactivated.
    Debug Options Test option Specify TEST or NOTEST. This option specifies the conditions under which Debug Tool assumes control during the initialization of your application.
      Test level Specify ALL, ERROR, or NONE. This option specifies what conditions need to be met for Debug Tool to gain control.
      Commands file A valid fully qualified data set name that specifies the primary commands file for this run. Do not enclose the name of the data set in quotation marks (") or apostrophes (').
      Prompt level Specifies whether Debug Tool is started at Language Environment® initialization.
      Preference file A valid fully qualified data set name that specifies the preferences file to be used. Do not enclose the name of the data set in quotation marks (") or apostrophes (').
      Language Environment options Any other valid Language Environment options. You can change any Language Environment option that your site allows you to override except the STACK option. For additional information about Language Environment options, see the z/OS Language Environment Programming Reference or contact your CICS system programmer.
    Connection Workstation IP Either the IP address or host name of the workstation that will display the debug screens. This field is filled automatically by using the Java API (InetAddress) to retrieve the client's TCP/IP address. There are a few scenarios in which the Java API might fail to give the correct IP address, such as double firewalls and NAT. If the correct IP address is not recorded, you must update the IP address manually.
      Port Specifies the TCP/IP port number that is listening for debug sessions on your workstation. The default is 8001. The port number is retrieved using the Debug Tool client API (that is, the Debug Daemon port specified in the Debug Daemon preference page).
    Advanced COMMAREA Offset The offset of data in a COMMAREA passed to a program on invocation. The offset can be given in character format (such as 12) or in hexadecimal (such as X'C').
      COMMAREA Data A data pattern to be matched against a COMMAREA passed to a program on invocation. The data pattern can be given in character format (such as ABC) or in hexadecimal (such as X'C1C2C3') with an even number of digits.
      Container Name The name of a container within the current channel passed to a program on invocation. The container name is case sensitive.
      Container Offset The offset of data in the named container passed to a program on invocation. The offset can be given in character format (such as 12) or in hexadecimal (such as X'C').
      Container Data A data pattern to be matched against a container within the current channel passed to a program on invocation. The data pattern can be given in character format (such as ABC) or in hexadecimal (such as X'C1C2C3') with an even number of digits.
      URM Debugging A flag that specifies whether to include the debugging of URMs as part of the debug session.

Terms of use | Feedback

This information center is powered by Eclipse technology. (http://www.eclipse.org)