Category:Debugger Home: Difference between revisions

Latest revision as of 14:55, 5 June 2023

This is a master category and page for all things Debugger (Janus/TN3270 Sirius Debugger).

About the Debuggers

The Janus Debugger is a tool designed for developers who create and maintain Janus Web Server applications. With software installed in the Model 204 Online, as well as on a workstation with a browser that can access the Web Server, the Janus Debugger lets you examine in statement by statement detail the SOUL code that the Web Server executes.

The TN3270 Debugger is designed for developers who create and maintain Model 204 3270 and Batch2 applications. With software installed on the Model 204 Online, it uses the same Debugger Client as the Janus Debugger, letting you examine 3270 and Batch2 applications.

An instance of the Debugger Client can be debugging a web application (acting as the Janus Debugger), or it can be debugging a 3270 or Batch2 application (acting as the TN3270 Debugger). At any given time, it may only be debugging one type of application. The title bar of the Debugger Client indicates the application type.

The basic operation

When you are running under the Janus Debugger, and Janus Web Server is about to run a request on your behalf, or you are running under the TN3270 Debugger, and you run a 3270 or Batch2 request:

Request source code is sent to the Debugger Client deployed on a workstation.
The Debugger Client displays the code, navigable to top and bottom, with search features available.
Program execution is paused, the Debugger awaiting the instructions you provide through the Client GUI.

The feature set

Both Debuggers provide these typical debugging capabilities:

Viewing code while running it
Stepping through the code one statement at a time
Examining variable values
Using a separate "watch window" for the display of specified data items
Setting breakpoints at which code execution pauses
Skipping over selected subroutines/methods

In addition, the Debuggers provide:

A compact Graphical User Interface with user configurable buttons and hot keys
Views of the Model 204 audit trail and code executed by daemons
Tracing of statements that modify variables in executed code lines, or tracing until a variable becomes a certain value
Saving of sets of variables to be watched, which are restorable at any time
Display of Web Server output (Janus Debugger) and screen variables (TN3270 Debugger)
A code line's Model 204 procedure details (subsystem, file, name, line number, text preceding dummy string substitution)
Filtering of program code to skip over all but the Model 204 procedure you identify or the procedures you selected (added to "White List")
Stepping out of a called subroutine, method, or daemon and continuing processing at the statement after the call to the subroutine, method, or daemon
Examination of longstrings, $lists, objects
System class methods that let you insert code in User Language that runs only under the Debuggers

The architecture

The following figure displays the principal components in a Janus Debugger configuration:

The main components in a TN3270 Debugger configuration parallel those in the Janus Debugger configuration, the principal exception being the absence of the web browser:

Per Debugger session for a Janus Web or 3270 or Batch2 application, these components are active in the Online and on the workstation:

Model 204 nucleus hooks (Assembler; not shown above)	Compiler: Capture source lines, before and after dummy string substitution. Note source of line (procedure and file). Evaluator: Can step one statement at a time, and can step over routines and methods. Can stop on breakpoints. Between statements, can get variable, field, and global values, to support display, trace, watch, etc.
Janus Web thread	`Janus Debugger` only.
3270/Batch2 thread	`TN3270 Debugger` only.
Worker threads (Assembler Language, one for each thread being debugged)	For each debugging session, a “worker thread” arbitrates between the thread being debugged and the workstation client. A worker thread does the following: Passes data between the thread being debugged and the Client. Controls the execution of the thread being debugged, at the behest of the Client.
Debugger Client (Windows GUI, written in VB.NET)	The Debugger Client resides on the developer's workstation. It is a proxy server in a `Janus Debugger` session: the browser no longer directly connects to the Web Server, but instead it "sends" to and "receives" from the Client. The Client GUI lets you control the application and view variable values, source code, traces, and for `Janus Debugger` sessions, the web output buffer.
Web browser	`Janus Debugger` only. Any web browser that allows proxy servers.

Versions and builds

Independent of the version of Model 204 being run, the Debugger Client has its own numbered sequence of "builds" that contain new and updated features. From build to build of the Debugger Client, the About box (accessed by the Help menu) provides a searchable list of the principal changes in each of the previous builds of the Debugger Client.

System requirements

The Online Configuration section of this document specifies the requirements for Model 204 product release levels, licenses, and maintenance, as well as Debugger product authorization. In addition are instructions for configuring a Model 204 Online that hosts the Debugger, which include User 0 parameter and TCP port definitions and increases in storage table and work area sizes for both of these:

The worker thread that services a debugging session
The thread on which the program to be debugged is running

Known limitations

The following are known limitations and issues concerning the Janus and TN3270 Debuggers:

You may not use either Debugger for DBCS data.
You may use the Janus Debugger on a Janus Web Legacy Support thread only if you also have a license for the TN3270 Debugger.
No asynchronous daemon or $COMMBG requests may be debugged. They are simply ignored by the Debugger (and they execute normally).
The client requires Windows 7 or higher
Both the Execution Trace tab (output from one trace) and the Web Buffer tab have 5000 line capacities. If the capacity is exceeded, the last 5000 lines are shown.

Check Prerequisites

Ensure you are running Version 7.5 or higher of Model 204. You can verify this by issuing the VIEW VERSION command at the Model 204 command prompt, for example:

VIEW VERSION VERSION 7.9.0A Release of Model 204

Installation and Configuration

This section describes how to install the Janus Debugger, the TN3270 Debugger, or both. Once you complete this installation, you can begin to use either or both products.

This section consists of two subsections of mostly cookbook-style directions. You should first complete the steps in the "Online Configuration" section, then complete the "Workstation Configuration" section.

Most of the steps are to be performed whether you are installing one or both Debugger products, and exceptions are noted.

If you will be using a local editor (Xtend or UltraEdit) with the Debugger, finish the Debugger installation first, then see Using a local editor.

For information about setting up at your site a centralized distribution of updated Debugger Client replacement files, see Providing updated versions of the Debugger Client.

Online Configuration

This section shows how to prepare a Model 204 Online for use of the Janus Debugger, the TN3270 Debugger, or both.

The installation tasks require Model 204 system manager privileges. Also, since you must set at least one User 0 parameter, a cycle of the Model 204 Online will be required.

The Online configuration tasks are listed below.

Workstation Configuration

This section specifies how to prepare a workstation for use by the Janus Debugger, TN3270 Debugger, or both.

These are the workstation configuration tasks:

Perform preliminary tasks

Run, check, and verify the Client installation

Customize the debuggerConfig.xml file

Configure the web browser (Janus Debugger only)

Test the end-to-end configuration

Menu Bar

The Debugger Client has multiple menus, each of which is described in the following subsections. Many of the menu options duplicate the actions of default Client buttons and keyboard shortcuts, and most menu options are associated with Client commands.

If a hot key is mapped to a command that is associated with a menu option, the hot key is displayed in parentheses next to the menu option.

The File menu options

The Window menu options

The Search menu options

The Breakpoints menu options

The Execution menu options

The Data Display menu options

The Error menu options

The Macros menu options

The Help menu options

Performing Basic GUI tasks

These sections describe how you perform basic operations using the Debugger:

Using Debugger Macros

A macro lets you execute one or more commands as a single unit of work to automate an often-repeated series of operations.

@@ Line 1: / Line 1: @@
-This is a master category and page for all things Debugger (Janus/TN3270 Sirius Debugger). '''It is currently under construction''', so it is subject to changes and formatting.
+This is a master category and page for all things Debugger (Janus/TN3270 Sirius Debugger).
 === About the Debuggers ===
@@ Line 14: / Line 14: @@
 : [[Category:Debugger_Home#The_basic_operation|Versions and builds]]
 : [[Category:Debugger_Home#The_basic_operation|System requirements]]
-: [[Category:Debugger_Home#The_basic_operation|Known limitations]] >
+: [[Category:Debugger_Home#The_basic_operation|Known limitations]] -->
-<!-- This is a comment -->
 ==== The basic operation ====
 When you are running under the <var>Janus Debugger</var>, and <var>Janus Web Server</var> is about to run a request on your behalf, or you are running under the <var>TN3270 Debugger</var>, and you run a 3270 or Batch2 request:
@@ Line 108: / Line 108: @@
 ==== System requirements ====
-The [[Online Configuration (Debugger)|Online Configuration]] section of this document specifies the requirements for <var>Model 204</var> product release levels, licenses, and maintenance, as well as Debugger product authorization. In addition are instructions for configuring a <var>Model 204</var> Online that hosts the Debugger, which include User</span><span class="f_ListNum1"> </span><span class="f_Para">0 parameter and TCP port definitions and increases in storage table and work area sizes for both of these:
+The [[#Online Configuration|Online Configuration]] section of this document specifies the requirements for <var>Model 204</var> product release levels, licenses, and maintenance, as well as Debugger product authorization. In addition are instructions for configuring a <var>Model 204</var> Online that hosts the Debugger, which include User</span><span class="f_ListNum1"> </span><span class="f_Para">0 parameter and TCP port definitions and increases in storage table and work area sizes for both of these:
 *The worker thread that services a debugging session
 *The thread on which the program to be debugged is running
@@ Line 114: / Line 114: @@
 ==== Known limitations  ====
 The following are known limitations and issues concerning the Janus and TN3270 Debuggers:
-*You may not use either Debugger for '''''DBCS data'''''.
+*You may not use either Debugger for '''DBCS data'''.
-*You may use the Janus Debugger on a '''''Janus Web Legacy Support''''' thread only if you also have a license for the TN3270 Debugger.
+*You may use the Janus Debugger on a '''Janus Web Legacy Support''' thread only if you also have a license for the TN3270 Debugger.
-*No '''''asynchronous daemon or $COMMBG requests''''' may be debugged. They are simply ignored by the Debugger (and they execute normally).
+*No '''asynchronous daemon or $COMMBG requests''' may be debugged. They are simply ignored by the Debugger (and they execute normally).
-*The client requires '''''Windows 7 or higher'''''.
+*The client requires '''Windows 7 or higher'''
-*Both the Execution Trace tab (output from one trace) and the Web Buffer tab have '''''5000 line capacities'''''. If the capacity is exceeded, the last 5000 lines are shown.
+*Both the Execution Trace tab (output from one trace) and the Web Buffer tab have '''5000 line capacities'''. If the capacity is exceeded, the last 5000 lines are shown.
 === Check Prerequisites ===
@@ Line 145: / Line 145: @@
 <span class="f_Para">The Online configuration tasks are listed below. </span>
-* [[Category:DebuggerHome#Check Prerequisites|Check prerequisites]]
+* [[Check Debugger Prerequisites|Check prerequisites]]
 * [[Authorize the Debugger|Authorize the Debugger]]
 * [[Set Model 204 system parameters|Set Model 204 system parameters]]
@@ Line 151: / Line 151: @@
 * [[Define and start a client socket port (TN3270 Debugger only)|Define and start a client socket port (TN3270 Debugger only)]]
-=== &&Functions ===
+=== Workstation Configuration ===
+<span class="f_Para">This section specifies how to prepare a workstation for use by the </span><var>Janus Debugger, TN3270 Debugger,</var><span class="f_Para"> or both. </span>
+<span class="f_Para">These are the workstation configuration tasks: </span>
+: [[Perform preliminary tasks|Perform preliminary tasks]] </span>
+: [[Run, check, and verify the Client installation|Run, check, and verify the Client installation]]</span>
+: [[Customize debuggerConfig file|Customize the debuggerConfig.xml file]]</span>
+: [[Configure web browser (Janus Debugger only)|Configure the web browser (Janus Debugger only)]]</span>
+: [[Test the end to end configuration|Test the end-to-end configuration]]</span>
+=== Menu Bar ===
+<span class="f_Para">The Debugger Client has multiple menus, each of which is described in the following subsections. Many of the menu options duplicate the actions of default Client buttons and keyboard shortcuts, and most menu options are associated with Client commands. </span>
+[[File:menubar2_zoom90.gif|687x93px|menubar2]]
+<span class="f_Para">If a hot key is mapped to a command that is associated with a menu option, the hot key is displayed in parentheses next to the menu option. </span>
+: [[File menu options|The File menu options]] </span>
+: [[Window menu options|The Window menu options]]</span>
+: [[Search menu options|The Search menu options]]</span>
+: [[Breakpoints menu options|The Breakpoints menu options]] </span>
+: [[Execution menu options|The Execution menu options]] </span>
+: [[Data Display menu options (Debugger)|The Data Display menu options]]</span>
+: [[Error menu options|The Error menu options]]</span>
+: [[Macros menu options|The Macros menu options]]</span>
+: [[Help menu options|The Help menu options]]</span>
+=== Performing Basic GUI tasks ===
+<span class="f_Para">These sections describe how you perform basic operations using the Debugger:</span>
+* [[Controlling the execution of program code|Controlling the execution of program code]]
+* [[Viewing and modifying program elements|Viewing and modifying program elements]]
+* [[Getting source file, audit trail, and web buffer information|Getting source file, audit trail, and web buffer information]]
+* [[Tracing program execution|Tracing program execution]]
+* [[Viewing programs that contain coding errors|Viewing programs that contain coding errors]]
+* [[Debugging requests that spawn daemons|Debugging requests that spawn daemons]]
+* [[Debugging Web Server persistent sessions|Debugging Web Server persistent sessions]]
+* [[Debugging multiple Web Servers|Debugging multiple Web Servers]]
+=== Using Debugger Macros ===
+<span class="f_Para">A macro lets you execute one or more commands as a single unit of work to automate an often-repeated series of operations.  </span>
+<span class="f_Para">Subsequent sections describe: </span>
+*[[Creating and running a macro|Creating and running a macro]]
+*[[Mapping a macro to a button or hot key|Mapping a macro to a button or hot key]]
+*[[Passing a command argument to a macro|Passing a command argument to a macro]]
+*[[Using the console and command line|Using the macro console and command line]]
+*[[Using the Macro Autorun feature|Using the Macro Autorun feature]]
+*[[Working with macro variables|Working with macro variables]]
+*[[Working with Client functions (Debugger)|Working with Client functions]]
+<!-- === &&Functions ===
 <div class="showVisit">
 <table class="wikitable">
-<tr class="head"><th>&&Function</th><th>Description</th></tr>
+<tr class="head"><th>&&Function</th><th>Description</th></tr> -->
 <!-- ************************************************************** -->
 <!-- Note that FUNSCHECK.WIKI depends on the format of the function name/description rows - *** SO DON'T MUCK WITH IT!!! *** -->
 <!-- ************************************************************** -->
-<tr><td>[[&&amDaemon]]</td><td>Returns a 1 if a Daemon tab contains the currently active code. Otherwise, the returned number is 0.</td></tr>
+<!-- <tr><td>[[&&amDaemon]]</td><td>Returns a 1 if a Daemon tab contains the currently active code. Otherwise, the returned number is 0.</td></tr>
 <tr><td>[[&&arg]]</td><td>Serves as a placeholder for a command argument ''within a macro'' (if used outside of a macro, an error is issued).</td></tr>
 <tr><td>[[&&assertFailureCount]]</td><td>Returns a count of the number of times that the result of an [[Assert command|assert]] command is a Failure.</td></tr>
@@ Line 200: / Line 250: @@
 <tr><td>[[&&verifyMatch]]</td><td>Returns the 1-based position (in ''string'') of the first character in ''string'' that is also in the characters in ''charSet''.</td></tr>
 <tr><td>[[&&verifyNoMatch]]</td><td>Returns the 1-based position (in ''string'') of the first character in ''string'' that is '''''not''''' in the characters in ''charSet''. If no character in ''string'' is not in ''charSet'', returns 0.</td></tr>
-<tr><td>[[&&windowStatus]]</td><td>Returns 1 if the named window is [[Opening an external window|open]], 0 otherwise. </td></tr>
+<tr><td>[[&&windowStatus]]</td><td>Returns 1 if the named window is [[Opening an external window|open]], 0 otherwise. </td></tr> -->
 <!--bypass FUNCHECK.WIKI-->
-</table>
+<!-- </table>
-</div>
+</div> -->