Debugger Client Beta documentation

Introduction

This page describes any beta versions of the Janus/TN3270 Debugger Workstation Client that are available.

Build 63, Tag 1 Beta

Run Until, White lists, Black lists with Daemons

When used with Model 204 Version 7.6 and higher, Client Build 63 extends to sdaemon threads the procedure-name matching for Run Until, White List, and Black List processing that formerly ran only at the main/master thread level. For example, runUntil desiredProc now stops if a Daemon thread includes the desiredProc procedure.

HTTP URLs for PAC file

The Janus Debugger Client supports Proxy Auto Config (PAC) files, providing a method to control which web requests are routed through the Janus Debugger Client when you use the Internet Explorer (IE) or Chrome browser.

IE and Chrome use a URL to reference PAC files. Prior to Build 63 of the Debugger Client, the Client supported only file-mode URLs (file://), so the PAC files it generated had to be stored on the local file system of the workstation running the Client. As of its version 11, IE is deprecating the use of file URLs for PAC files in favor of HTTP (http://) URLs. Eventually file URLs will not be supported at all.

To provide an HTTP URL, the Client will:

• Upload to an HTTP server the PAC files it generates in the existing "New Pac" or "Merged Pac" modes.
• Set the PAC URL in IE or Chrome to an HTTP-style URL that points to the PAC that was generated and uploaded.

Setting up an HTTP server for PAC files

Before changing Client settings, you must provide an HTTP (Web) server to hold the PAC files. You can use any web server that supports HTTP PUT and GET. This document provides an example of how to set up a Janus Web Server to handle HTTP-based PAC files.

Note: Note that the PAC files are temporary: when the Client starts, a new PAC is generated and uploaded. This prevents the problem of HTTP PAC files being out of date, since they are workstation-based configuration files which can change at any time.

The following SOUL program takes one command line argument, a TCP/IP port number, and it creates a Janus Web server for uploading and serving PAC files:

begin variables are undefined local subroutine closeFile(%iFile is string len 8 input) * Close the file whose name is passed. Messages supressed. %rc is float $resetn('MSGCTL', 6, %rc) $close('FILE ' with %iFile) $resetn('MSGCTL', 0, %rc) end subroutine local function openFile(%iFile is string len 8 input) is float * Open the file whose name is passed and return 0 for success or * non-zero for failure. Messages supressed. %rc is float $resetn('MSGCTL', 6, %rc) openc file %iFile $resetn('MSGCTL', 0, %rc) return $status end function * Get and validate the command line argument: port number %args is object stringlist %args = %(system):arguments:unspace:parseLines(', ') %portNumber is float if (%args:count eq 0) then print 'No port number specified' stop elseif (%args:count > 1) then print 'Too many arguments' stop elseif (%args(1) is not like '/2-5(#)') then print 'Invalid port number' stop else %portNumber = %args(1) end if %pacRepo is string len 8 initial('JDPACREP') %worker is object daemon auto new %workForDaemon is object Stringlist auto new * See if the memory file for a PAC repository is there, if not create it if (%(local):openFile(%pacRepo) eq 0) then printText Memory file {%pacRepo} already present  %(local):closeFile(%pacRepo) else printText creating memory file {%pacRepo} text to %workForDaemon = new ALLOCATE {%pacrepo} WITH MEMORY PAGES=300 CREATE {%pacrepo} PARAMETER BSIZE=1, DSIZE=250 END OPENC {%pacrepo} IN {%pacrepo} INITIALIZE CLOSE {%pacrepo} end text %worker:run(%workForDaemon):print end if * Set up a simple Janus web server with web rules for loading * serving and listing PAC files generated by the debugger client. %portName is string len 8 initial('JDPACSRV') * Get rid of any earlier one, so this script can be rerun as needed text to %workForDaemon = new JANUS DRAIN {%portName} JANUS DELETE {%portName} end text %worker:run(%workForDaemon) * Create the server and its rules text to %workForDaemon = new * Create a web server JANUS DEFINE {%portName} {%portNumber} WEBSERV 20 TRACE 7 * Allow upload of PAC files via HTTP PUT of a URL of format /pacman/xxx.js JANUS WEB {%portName} ON PUT /PACMAN/*.JS OPEN FILE {%pacRepo} RECV *.JS BASE64 JANUS WEB {%portName} ALLOW PUT /PACMAN/*.JS * Provide HTTP GET access for URLs of format /pacman/xxx.js JANUS WEB {%portName} ON GET /PACMAN/*.JS OPEN FILE {%pacRepo} - SEND *.JS BINARY EXPIRE +0 * Start the web server JANUS START {%portName} end text %worker:run(%workForDaemon):print end

Since the PAC files are temporary, they are stored in an in-memory file (not persistent between runs) which does not need any disk files, DD cards, etc. The PAC files are stored as Model 204 procedures. The name of a PAC file procedure created by the Client (see the following sections) is based on the IP number of the Client workstation to avoid conflicts.

DebuggerConfig.xml changes

Once the HTTP server is set up to accept and serve PAC files, the Debugger Client configuration must be updated to identify it. You do this with the new httpPacURL tag in the debuggerConfig.xml file:

<debuggerConfig version="1.0"> <httpPacURL>http://pacServerHost:pacServerPort/pacman</httpPacURL>

Where:

• pacServerHost is the host name or IP number of the PAC Janus Web Server described above.
• pacServerPort is the port number passed to the SOUL program shown above. It must not be the same as any port being used for debugging.
• pacman is a qualifier in the PAC file URL. See the JANUS WEB commands in the Janus Web Server definition in the example above in Setting up an HTTP server for PAC files. pacman is part of the httpPacURL tag specification only because PACMAN is specified in the JANUS WEB commands.

When the Debugger Client is started, and httpPacURL is specified in the configuration, the URL is validated with an HTTP PUT and GET of a test file. If there is a problem with httpPacURL, an error is displayed in the Client's Audit Trail tab. For example:

Preferences UI changes

Once the server is set up and the Client configuration includes httpPacURL, you enable the HTTP PAC feature through Client user preferences or through the setIEmode command:

1. Start the client.
2. Select File > preferences.
3. Select newPac or mergedPac for an IE Mode.

   This enables the PAC Options button:

   

4. Click the PAC Options button.

   This displays the PAC Options dialog box:

   

5. Select file:// or http:// mode for the PAC URL.

As an alternative to the Client GUI, you can use the setIEMode command, which is enhanced to support this feature.

setIEMode command changes

If you use a setIEMode command to invoke a PAC mode (newPac or mergedPac), specifying file or http controls the type of the PAC URL. file is the default:

setIEMode {none|proxy|newPac|mergedPac} [file|http]

ShowIE command changes

ShowIE output has been enhanced (see <== New line comments below) to display URL info for any PAC file in use by the Debugger Client. For example:

Current ie mode: mergedPac Current ie settings ...Proxy flags=(5) ...Proxy server=() ...Proxy bypass=() ...Proxy autoConfigUrl=(http://pacServerHost:pacServerPort/pacman/PAC.10.111.2.82.JS) ...Raw flag byte=(05) ...Read from registry key=(HKEY_CURRENT_USER\Software\Microsoft\Windows\CurrentVersion\Internet Settings) Generated New Pac file: c:\debugger\stateFiles\debuggerInternalPac.js Added: 54 web servers from the configuration. Generated Pac File: pacURLMode: http <== New line httpPacUrl='http://pacServerHost:pacServerPort/pacman/' <== New line httpPac upload filename: 'PAC.10.111.2.82.JS' <== New line

New retryHttpPac command

If you have an error on the validation of the HTTP PAC server when you bring up the Client, and then you fix the HTTP server, you can issue the retryHttpPac command from the Client as an alternative to restarting the Client.

Note: The Client must not be in proxy mode when you issue the command.

New &&currentPacFile function

The &&currentPacFile function returns the URL of the PAC file in use, or it returns "" if no PAC file is in use. The URL returned could be either a file: or http: URL.

Command: echo &&currentPacFile Macro message: http://pacServerHost:pacServerPort/pacman/PAC.10.111.2.82.JS

Other new commands

Developing and testing the HTTP URL support added these commands for general use:

• httpPutFile file url — Do an HTTP PUT file upload for the file and URL specified.
• httpPutString string url — Do an HTTP PUT file upload for the string and URL specified.
• httpGet url — Do an HTTP GET for the URL specified; display in Client console.