Appendix I. Installing the IBM Debug Tool DTCN and DTSP Profile Manager plug-in

Debug Tool ships the IBM Debug Tool DTCN and DTSP Profile Manager plug-in, which adds the following views to the Debug perspective of the remote debugger:

To install this plug-in, do the following steps:

  1. Verify that your system administrator has completed the following tasks described in the Debug Tool Customization Guide:
  2. Transfer, in binary format, from your z/OS system to your workstation the following data set:
    hlq.SEQABIN(EQACDPLG)
  3. Rename the file to com.ibm.pdt.debugtool.profile_2.0.0.jar.
  4. Move that file to the specified directory of any of the following Eclipse-based applications:
    CICS Explorer™
    CICS_Explorer_install_directory\dropins
    Eclipse
    Eclipse_install_directory\dropins
    Rational Developer for System z
    C:\Program Files\IBM\SDP\plugins
  5. Restart your Eclipse-based application. If you installed a previous version of either plug-in, specify the -clean option when you restart your Eclipse-based application.
  6. Specify the settings needed to establish a connection between the DTCN profiles view and you z/OS system by doing the following steps:
    1. Click on Window>Show view>Others....
    2. Type in "DTCN" in the text box at the top of the window. Select DTCN profiles and click OK.
    3. Click on Window>Preferences.
    4. Click on Debug Tool>DTCN (CICS) in the list.
    5. Fill in all of the following fields:
      Host Name
      TCP/IP name or address of the z/OS system as described in "Defining the CICS TCPIPSERVICE resource" in the Debug Tool Customization Guide.
      Port Number
      Port number of the z/OS system as described in "Defining the CICS TCPIPSERVICE resource" in the Debug Tool Customization Guide.
      User Id
      ID that you use to log on to the CICS system.
      Password
      Password that you use to log on to the CICS system.
    6. Click on Test Connection. If you see a message that indicates the test was successful, click on OK to close the Preferences window. Otherwise, review the information you entered, correct any mistakes, and retry the connection test. You can also review the trace file (see Locating the trace file of the DTCN Profiles or DTSP Profile view) for diagnostic information that can help identify a mistake.
  7. Specify the settings needed to establish a connection between the DTSP Profile view and you z/OS system by doing the following steps:
    1. Click on Window>Show view>Others....
    2. Type in "DTSP" in the text box at the top of the window. Select DTSP Profile and click OK.
    3. Click on Window>Preferences.
    4. Click on Debug Tool>DTSP (non-CICS) in the list.
    5. Fill in all of the following fields:
      Host Name
      TCP/IP name or address of the z/OS system, which is set by the system administrator according to the instructions in "Installing the server components for IBM Debug Tool DTCN and DTSP Profile Manager" of the Debug Tool Customization Guide.
      Port Number
      Port number of the z/OS system, which is set by the system administrator according to the instructions in "Installing the server components for IBM Debug Tool DTCN and DTSP Profile Manager" of the Debug Tool Customization Guide.
      User Id
      ID that you use to log on to the z/OS system. The DTSP Profile substitutes this ID for the &userid token in the Profile name pattern field.
      Password
      Password that you use to log on to the z/OS system.
      Profile name pattern
      Specify a naming pattern that matches the default naming pattern set by system administrator according to the instructions in "Modifying the naming pattern" of the Debug Tool Customization Guide. The naming pattern must contain the &userid token, but not the &pgmname token.
      Note:
    6. Click on Test Connection. If you see a message that indicates the test was successful, click on OK to close the Preferences window. Otherwise, review the information you entered, correct any mistakes, and retry the connection test. You can also review the trace file (see Locating the trace file of the DTCN Profiles or DTSP Profile view) for diagnostic information that can help identify a mistake.

In the views, you can right click anywhere to see a list of actions available. If you need to change your connection settings, you can right click in any area of the view and select Preferences.

Locating the trace file of the DTCN Profiles or DTSP Profile view

When you do actions in the DTCN Profiles or DTSP Profile view, the views save information about the actions and results of the actions in the following files:

The views save these files in the \.metadata folder of your workspace. (To find the name of the path of your workspace, click on File>Switch Workspace>Other... in your Eclipse-based application.) The following topic show an example of what the file might contain after you do a common action and the result of that action.

Example: .debugtool.dtcn.trace file

The following example shows what the file might contain after you send a request to create a profile for Debug Tool for z/OS, Version 10:

15 Oct 2009 16:06:11 PDT
Request URI: http://tlba07me.torolab.ibm.com:33000/dtcn/smith02?clientversion=0102
Request method: PUT
<?xml version="1.0"?>
<profile>
<terminalid></terminalid>
<transactionid></transactionid>
<program>
<loadname></loadname>
<pgmname></pgmname>
</program>
<userid>smith02</userid>
<netname></netname>
<clientip></clientip>
<commareaoffset>0</commareaoffset>
<commareadata></commareadata>
<containername></containername>
<containeroffset>0</containeroffset>
<containerdata></containerdata>
<urmdeb>NO</urmdeb>
<activation>ACTIVE</activation>
<trigger>TEST</trigger>
<level>ALL</level>
<sesstype>TCP</sesstype>
<sessaddr>9.30.247.101</sessaddr>
<sessport>8001</sessport>
<commandfile>*</commandfile>
<preferencefile>*</preferencefile>
<otheropts></otheropts>
</profile>
Server response code = 201
Server response msg  = Profile_Created_OK
Server response details = <?xml version="1.0"?><profile><profileversion>0102</prof
ileversion><serviceid>DBGTPROF</serviceid><clientversion>0102</clientversion><serv
erversion>0102</serverversion></profile>

The last line of the trace is one line; however, the line is wrapped in this example so that you can see the entire contents of the line.

Examples: .debugtool.dtsp.trace files

The following example shows what the file might contain after you click on Test Connection in the DTSP (non-CICS) Preferences page:

Test Connection button clicked -----
getSocketIO parameters are below.
Host: tlba07me.torolab.ibm.com
Port: 5555
UserId: vikram
Pattern: &userid.dbgtool.eqauoptsStart Service successful. The message was:
 Connected to DebugToolProvider DTSP query response: File exists.
 Connection was successful ---

The following example shows what the file might contain after you click on Finish in the update wizard:

---- DTSP Finish button clicked ----
Profile dataset: vikram2.dbgtool.eqauopts
UEWizard: Read successful.
DT_Update request worked fine. ------
Retrieving Profile -----
GetOtherProfiles: Socket is good -----
GetOtherProfiles: Hashmap contains {otheropts=sto(ff), sessport=8002,
 sessaddr=9.65.111.33, level=ERROR, preferencefile=*, commandfile=*,
 trigger=TEST, sesstype=TCPIP, profiledataset=vikram2.dbgtool.eqauopts}

16.
Beginning with Rational® Developer for System z®, Version 7.6.1, you can use CICS® debug configurations to manage DTCN profiles. To learn more about CICS debug configurations, see the topic "Debugging CICS applications" in the Rational Developer for System z, Version 7.6.1, information center. If you choose to use CICS debug configurations, you do not need to follow the rest of the instructions in this topic.