Using the IMS Connect Extensions trace

Tracing events are additional event records produced by IMS Connect Extensions when tracing is activated. Use the IMS Connect Extensions ISPF dialog to start and stop tracing for an active IMS Connect system.

You can also use the following alternate methods to start and stop tracing:

Use the Status Monitor in IMS Connect Extensions Operations Console for z/OS Explorer. For more information, see Using conditional trace.
Use the QUERY commands and the TRACE command in the IMS Connect Extensions host command environment for REXX to query, start, and stop tracing. See members CEXRXC11 and CEXRXC45 in the SCEXSAMP library for details.

In addition to logging IMS Connect events, IMS Connect Extensions can optionally write trace event records that expose the raw messages entering and exiting IMS Connect. These messages include the IMS request message (or IRM) from the client, the response to the client, and the OTMA messages that IMS Connect exchanges with IMS. These trace event records are useful for diagnosing problems such as malformed messages. Optionally, IMS Connect Extensions can include application data in these trace event records, such as the application data that typically follows an IMS request message.

For a list of the IMS Connect trace records, see IMS Connect Extensions trace records. The current tracing status and tracing level are included in the X'00' event record.

From the IMS Connect Extensions primary option menu, select option 2 Operations.
Set View to option 2 Systems.

To set tracing options for an IMS Connect system, enter line action TR next to the desired system.

Figure 1. Accessing IMS Connect Extensions tracing options from the Operations dialog

  File  Menu  Help 
──────────────────────────────────────────────────────────────────────────────
                          Operations - Systems View          Filter Mode: More 
Command ===>                                                  Scroll ===> PAGE

Group  . : NY       

Filter . .           Exclude inactive systems . . 2  1. Yes  2. No  

                             Coll.  - Journal -  Sockets OTMA      ODBM
/   System    Status  Events Level  Active Used  Used    Plan      Plan     
    RAPI03    ACTIVE  OFF        4  
TR  RAPI04    ACTIVE  ON         4  P03     57%       8%
    RAPI05    ACTIVE  ON         4  P03     13%      27%
    RAPI06    ACTIVE  ON         4  P03     16%       7%
******************************* Bottom of data ********************************

The Set Tracing dialog is displayed. The Activate Tracing option displays the current tracing status.

Figure 2. Activating IMS Connect Extensions tracing using the Set Tracing panel

  File  Menu  Help 
──────────────────────────────────────────────────────────────────────────────
                                 Set Tracing 
Command ===>                                                                  

System Definition . . : RAPI04   
Description . . . . . : NY Inventory Gateway

Make changes then press Enter to generate commands.

/  Activate Tracing    
      Reactivate tracing after system restart     

   Tracing Level . . . 2      (1-2)
   Port  . . . . . . . *      (LOCAL, 1-65535, or * for all ports)

   Select a conditional trace resource:
      1. Client Name  . .          
      2. Transaction  . .          
      3. Message Exit . .          
      4. User ID  . . . .          
      5. LTERM  . . . . .          
      6. IP Address . . .

Starting the trace:

To start tracing, complete the following steps:
1. Enter / next to the Activate Tracing option.
2. Set the following conditional tracing options as desired:
  
  Reactivate tracing after system restart
  
  Select this option to make tracing persist across system restarts.
  Note: You can only make a trace persistent at the same time as you activate it.
  
  Tracing Level
  
  Set the level of tracing for IMS Connect Extensions:
  
  1
  
  IRM, CSM, RSM, OTMA, XML, and DRDA structures.
  
  2
  
  IRM, CSM, RSM, OTMA, XML, DRDA structures, and client application data (useful for OTMA workloads).
  
  Port
  
  Apply tracing only to a specific port. Only activities directed at that port are traced. Use an asterisk (*) to trace on all ports.
  
  Conditional trace resources (for OTMA workloads)
  
  IMS Connect Extensions will only record messages that match the specified tracing condition. Specify an optional condition (one only) using the following fields:
  
  Client Name
  
  The name of the client.
  
  Transaction
  
  The transaction.
  
  Message Exit
  
  The message exit.
  
  User ID
  
  The user ID.
  
  LTERM
  
  The logical terminal.
  
  IP Address
  
  The host IP address. If you enter a DNS name it will be sent to the server to be resolved to the IP address.
3. Press Enter to generate the necessary commands.
  The Command Processor panel is displayed.
4. Type / (slash) next to the listed commands and then press Enter.
  The Response column shows all zeros (0000), indicating that the commands were successful.
  Figure 3. The IMS Connect Extensions Command Processor panel showing successful trace activation
```
  File  Menu  Help 
──────────────────────────────────────────────────────────────────────────────
                              Command Processor                Row 1 to 2 of 2 
Command ===>                                                                  

Enter "/" to select commands then press Enter to process.

  Command                                                              Response
  RAPI04   SET TRACING CONDITION FOR PORT ONLY                         0000 

  RAPI04   SET TRACING ACTIVE                                          0000 

******************************* Bottom of data ********************************
```
5. To return to the previous screen, press the Exit function key (F3).
  A slash (/) next to the Activate Tracing option in the Set Tracing panel indicates that tracing is now active.
  Tip: You can also review the status of your request by entering line action L next to the IMS Connect system on the Operations dialog.

Stopping the trace:

To stop tracing, complete the following steps:
1. Deselect the Activate Tracing option by removing the slash (/).
2. Press Enter to generate the necessary command.
  The Command Processor panel is displayed.
3. Type / (slash) next to the listed command and then press Enter.
  The Response column shows all zeros (0000), indicating that the command was successful.
4. To return to the previous screen, press the Exit function key (F3).
  A blank next to the Activate Tracing option in the Set Tracing panel indicates that tracing has stopped.