Manually configuring Advanced debugging

Advanced debugging, including Transport and IPMON tracing, requires adding parameters to the APPLET tag in the HTML file. Starting with Host On-Demand V9, you can add these parameters using the Advanced Options > Problem Determination window of the Deployment Wizard. However, you may decide to add them manually by directly editing the HTML code. Take the following steps to add the parameters manually:

Transport trace
IPMON trace

Transport trace

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.

IPMON trace

The IPMonitor 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.

To add the IPMonitor parameter to HTML files you have created without using the Deployment Wizard, use a text editor to edit the HTML file. The session must 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 the following parameter to the applet tag:

<PARAM  NAME=IPMonitor    VALUE="[<option_tag=<option_value>,...]">

For example,

<PARAM  NAME=IPMonitor    VALUE="SessionName=My Session,TraceFile=c:\mydirectory\trace.trc">

adds the option Start Session with IPMonitor to the menu when you right click the icon for the session named "3270 to myhost" on the Host On-Demand desktop. Selecting this option starts the session and also starts IPMonitor. The trace file is saved to c:\mydirectory\trace.trc.

Enclose the string that follows VALUE= in quotes. Without quotes, the HTML parser stops parsing the string as soon as it reaches a space. This may cause some of the IPMonitor settings you want to set to be discarded by the HTML parser.

There is also a sample file, ipmon.html that can show you how to use this parameter. It is located in the x:\hostondemand\lib\samples\IPMonitor directory.

Trace Option	Supported Values	Description
`SessionName`	Any session name available on the Host On-Demand desktop, spelled exactly as it appears in the session properties, and as it is displayed below the session icon.	Specifies the name of the session that you want to have started along with IPMonitor. If no session name is specified, IPMonitor can be run by all 3270 display, 5250 display, and VT display sessions defined for the Host On-Demand desktop you logged on to.
`TraceFile`	Any valid file name.	Specifies the trace file name that the IPMonitor trace is saved to. If no file name is specified, IPMonitor saves the trace file to output.tlg in the path specified in the JVM system property "user.dir".

When you select Start Session with IPMonitor from the session icon's start menu, the IPMonitor v1.0 for Java, automatic mode appears first, and then the session starts.

Related topics: