Troubleshooting Guide

Table of contents

Configuring the TraceOptions HTML parameter

You can configure HTML files to trace debugging information by adding the TraceOptions parameter to the APPLET tag in the HTML file. You can add the TraceOptions parameter to session HTML files in two ways:

Using the Deployment Wizard to add the TraceOptions parameter to a new HTML file

  1. Create a new HTML session file that includes the problem determination components.
    1. Click Advanced Options on the Additional Options panel.
    2. Click the Other tab. Click Yes to include the problem determination components.
    3. Click OK.
    4. Finish to create the new session HTML file.
  2. Edit the session HTML file you created to add the TraceOptions parameter.
    1. Start the Deployment Wizard and open the new HTML file you have created.
    2. Click Next to reach the Additional Options panel, click Advanced Options, then select the Other tab.
    3. Type TraceOptions in the Name field.
    4. Type "SaveLocation=Local,OutputFile=c:\temp\trace.tlg,HOD.Session=3", excluding the quotes, in the value field. OutputFile can be any valid file name.
    5. Click set. The parameter is added to the Additional Parameters list.
    6. Click OK to return to the Additional Options page, and finish editing the HTML file.

Adding the TraceOptions parameter to the APPLET tag of a session HTML file

The TraceOptions parameter has already been added to the APPLET tag of the Cached client with problem determination (HODCachedDebug.html) and the Download client with problem determination (HODDebug.html), but is commented out. Use a text editor to uncomment the IPMonitor parameter to use the parameter with either of these clients.

You can only use the Deployment Wizard to edit files that you have created with the Deployment Wizard. You cannot use the Deployment Wizard to edit the Cached client with problem determination or the Download client with problem determination.

To add the TraceOptions parameter to HTML files you have created without using the Deployment Wizard, use a text editor to edit the HTML file. The session must first include the problem determination components. Change: 

<APPLET archive="hod.jar,sccbase.jar" CODE="com.ibm.eNetwork.HOD.HostOnDemand.class" WIDTH=584 HEIGHT=450>

to:

<APPLET archive="hoddbg.jar,sccbase.jar" CODE="com.ibm.eNetwork.HOD.HostOnDemand.class" WIDTH=584 HEIGHT=450>

and add add the following parameter to the applet tag:

<PARAM  NAME=TraceOptions    VALUE="[<option_tag=<option_value>,...]">
For example, 
<PARAM  NAME=TraceOptions   VALUE="SaveLocation=Local,OutputFile=c:\temp\trace.tlg,HOD.Session=3">
would start the trace facility, trace the HOD.session module at level 3, and save the trace file to c:\temp\trace.tlg on the client.

Enclose the string that follows VALUE= in quotes. Without quotes, the Host On-Demand server stops parsing the string as soon as it reaches a space. This may cause some of the TraceOptions settings you want to set to be discarded by the Host On-Demand server.

There is also a sample file, cmptrace.html that can show you how to use this parameter. It is located in the x:\hostondemand\hod\ibmserv directory.

Trace Option Supported Values Description
Functions, Components, and Levels HOD.JNILoad=1,2,3
HOD.PrtTerminal=1,2,3
HOD.Macro=1,2,3
HOD.Session=1,2,3
HOD.BlinkRemapModel_Trace=1,2,3
HOD.ImportExport=1,2,3
HOD.ColorRemapModel3270_Trace=1,2,3
HOD.Screen=1,2,3
HOD.Config=1,2,3
HOD.FUDOMA=1,2,3
HOD.Keypad=1,2,3
HOD.ColorRemap=1,2,3
HOD.CodePage=1,2,3
HOD.MacroManager=1,2,3
HOD.KeyRemap=1,2,3
HOD.FileTransfer=1,2,3
HOD.ServiceLocationProtocol=1,2,3
HACL.Printer=1,2,3
HACL.ECLScreenReco=1,2,3
HACL.ECLField=1,2,3
HACL.ECLErr=1,2,3
HACL.ECLOIAEvent=1,2,3
HACL.Transport=1,2,3
HACL.ECLOIA=1,2,3
HACL.ECLSession=1,2,3
HACL.ECLPS=1,2,3
HACL.DataStream=1,2,3
HACL.ECLScreenRecoEvent=1,2,3
HACL.ECLCommEvent=1,2,3
HACL.ECLPSEvent=1,2,3
HACL.ECLScreenDesc=1,2,3
HACL.ECLXFer=1,2,3
HACL.ECLRecoDebugEvent=1,2,3
HACL.ECLFieldList=1,2,3		 Host On-Demand components that can be traced. Contact IBM Service for which modules to trace. The numbers 1, 2 and 3 indicate the type of message logged: 1 for Informational, 2 for Warning and 3 for Error.
     
Save Location SaveLocation=Server,Local Determines if the trace file is saved on the client machine or on the Host On-Demand server machine. If SaveLocation is not specified, the trace file is saved on the Host On-Demand server machine in the private directory as SVRLOGANDTRACE.[user_name].user, where user_name is the user ID used to logon to the Host On-Demand session.
     
Local output file OutputFile=x:\filename.trc Specifies the trace file name and location when SaveLocation=Local. When SaveLocation=Server, the file is saved to the Host On-Demand server in the private directory as
SVRLOGANDTRACE.[user_name].user, where user_name is the user ID used to logon to the Host On-Demand session.
     
Number of trace entries NumberOfTraceEntries=1024 Limits the number of trace entries in the trace file.

Related topics:

Top of page Table of contents