Performing a Communication or HLLAPI Trace in an IBM Host session with Reflection Desktop

  • 7021506
  • 06-Jul-2007
  • 16-Sep-2021

Environment

Reflection Desktop (including Pro or for IBM) 16.0 and higher
Reflection 2014
Reflection Pro 2014
Reflection for IBM 2014
Reflection for IBM 2011
Reflection Standard Suite 2011

Situation

While troubleshooting an IBM emulation problem, Technical Support may request that you obtain one or more traces. This technical note describes how to generate the following Reflection traces: Host Data (*.hst), Command (*.cmd), and HLLAPI (*.tmp).

Resolution

Generating a Host-Data (*.HST) or Command (*.CMD) Trace

A host-data trace captures information passed between a terminal, or printer, and the host during a 3270 or 5250 session. This type of trace is useful when a host connection is working, but the terminal or printer session does not behave as expected. For instance, a host-data trace would be useful when troubleshooting problems with colors, cursor movements, print job formatting, or IND$FILE transfer problems (for 3270 sessions). Host traces are not useful when a connection to the host cannot be established.

Note: HST traces capture both *.HST and *.RIT data.

Command traces capture actions within Reflection. An action taken, such as clicking a button or entering text, each represents an individual command. Command traces are useful in determining if commands are correct in a script, macro, or program using OLE automation.

Command traces also can be used to determine which command to use when writing a script. Use a text editor to view the command trace and determine which commands are needed to accomplish the task.

Follow the steps below to generate a host-data or command trace.

  1. In the Reflection Workspace, open or create a new session document.
  2. On the Tools ribbon, from the Tracing group, click Start Trace.
  3. Specify a name for the trace file. Save as type:
    • Host Data (*.HST)
    • Commands (*.CMD)

Note: If you have spoken with a support technician about this issue, you can use your call ID number as the name of your trace file.

  1. Click Save. "Tracing started…" will display in the Reflection status bar, indicating the trace is active.
  2. Perform the actions that reproduce the problem you want recorded in the trace.
  3. To end the trace, click Stop Trace from the Tracing group.

See the section below on "Sending a Trace to Support".

Generating a HLLAPI Trace (.TMP)

HLLAPI is a standard API for automating terminal tasks. HLLAPI traces are available in Reflection Desktop 16 and higher, Reflection 2014, or Reflection 2011 products. A HLLAPI trace will enable you to see the HLLAPI calls the application is making, including return codes.

Included below are instructions to generate a HLLAPI trace with Reflection 2014 R1 SP1 or higher or Reflection 2014 R1 or Reflection Standard Suite 2011.

Reflection 2014 R1 SP1 or higher (Including Reflection Desktop 16 and higher)

Follow the steps below to generate a HLLAPI trace with Reflection 2014 R1 SP1 or higher:

  1. In the Reflection Workspace Settings, select the Configure Workspace Attributes. Then check the box to Enable HLLAPI logging, and specify a HLLAPI log file name in a location where the user has the appropriate permissions to create and save a file.
View Full Size
Figure 1. Configure Workspace Attributes screen with Enable HLLAPI logging selectedFigure 1. Configure Workspace Attributes screen with Enable HLLAPI logging selected
  1. In the Reflection Workspace, open or create a session document to connect to your IBM host, and start the HLLAPI application. Perform the actions that you want recorded in the trace.
  2. Close the HLLAPI application.
  3. The trace file is automatically saved under the default name of hllapi.log and is located in the folder selected when the trace was started.

See the section below on "Sending a Trace to Support".

Reflection 2014 R1 or Reflection 2011

Follow the steps below to generate a HLLAPI trace with Reflection 2014 R1 or Reflection 2011:

  1. Click Start. In the Start Search box, type win.ini and press Enter. This will open your Win.ini file in Notepad.
  2. Add the following two lines to the end of the Win.ini file:
[Reflection HLLAPI]
ExtTraceOn=1
  1. Save the Win.ini file (click File > Save).
  2. In the Reflection Workspace, open or create a session document to connect to your IBM host, and start the HLLAPI application. Perform the actions that you want recorded in the trace.
  3. Close the HLLAPI application.
  4. The trace file is automatically named Hll*.TMP. The * is a randomly generated hex number. The file is located in the PC's TEMP directory, if a TEMP directory has been defined in the System Environmental settings. Otherwise, it is located in the root Windows directory.
  5. Re-open the Win.ini file (see step one) and set the ExtTraceOn setting to zero:
[Reflection HLLAPI]
ExtTraceOn=0

Sending a Trace to Support

If you are already working with Technical Support, see the instructions at https://support.microfocus.com/kb/doc.php?id=7024990 on how to upload any files gathered.  If you experience issues with getting the FTS credentials from the Support Portal, contact your Support Engineer who can assist and provide the URL, username, and password for the upload.

Additional Information

Legacy KB ID

This document was originally published as Attachmate Technical Note 2228.