APPXGuiILFDebuggerEs < Main

Tags: view all tags
---+ APPX ILF Debugger

_Effective with Release 5.0.0, the original character mode ILF Debugger has been replaced with a GUI ILF Debugger._ 

<br />%TOC%
---++ Overview

The APPX ILF debugger is a powerful debugging tool that enables the APPX application designer to examine field values and to observe how field values change as individual ILF statements are executed. The APPX ILF Debugger is invoked as the result of executing a TRAP statement when testing a process or automatically as the result of encountering a runtime error such as a Numeric Overflow.

<img width="670" alt="APPXILFDebugger.PNG" src="%PUBURL%/Main/APPXGuiILFDebugger/APPXILFDebugger.PNG" height="593" />
---+++ Main Debugger Window

The main window of the ILF debugger displays the ILF statements which precede and follow the next line to be executed. If the ILF debugger is displayed as the result of encountering a TRAP statement, the next line to be executed will be the TRAP statement. In the example below, the TRAP statement is highlighted with a light blue background. The white arrow in the red circle points to the statement to further hightlight it.

<img width="670" alt="ILFDebugTRAP.PNG" src="%PUBURL%/Main/APPXGuiILFDebugger/ILFDebugTRAP.PNG" height="593" />

If a runtime error causes the ILF debugger to be invoked, the statement which caused the error will be highlighted with a light blue background color.  The white arrow in the blue circle points to the statement to further hightlight it. In the example below, notice that the value for the fields for the current statement are displayed in the field value window on the bottom of the screen.

<img width="670" alt="ILFDebugOverflow.PNG" src="%PUBURL%/Main/APPXGuiILFDebugger/ILFDebugOverflow.PNG" height="593" />

The following icons are used to mark ILF statements for the benefit of the application designer: 

<img width="24" alt="stop.png" src="%PUBURL%/Main/APPXGuiILFDebugger/stop.png" height="24" /> Identifies an ILF command that has a stop point (trap) enabled.

<img width="24" alt="current.png" src="%PUBURL%/Main/APPXGuiILFDebugger/current.png" height="24" /> Identifies the next ILF command line to execute.

<img width="24" alt="stopcur.png" src="%PUBURL%/Main/APPXGuiILFDebugger/stopcur.png" height="24" /> Identifies the next ILF command line to execute and indicates that the line has a stop point (trap) enabled.

Field values can also be viewed in a popup tooltip by moving the mouse pointer over any ILF statement which references a field.

<img width="670" alt="ILFDebugFieldValues.PNG" src="%PUBURL%/Main/APPXGuiILFDebugger/ILFDebugFieldValues.PNG" height="593" />
---+++ Toolbar Buttons

The Toolbar contains a variety of buttons that facilitate debugging of a process:

<img width="24" alt="return.gif" src="%PUBURL%/Main/APPXGuiILFDebugger/return.gif" height="24" /> Go [Option 0]- Resume normal execution.

<img width="24" alt="cancel.gif" src="%PUBURL%/Main/APPXGuiILFDebugger/cancel.gif" height="24" /> Cancel [Ctrl+F8]- Abort process being debugged.

<img width="24" alt="stepOver.png" src="%PUBURL%/Main/APPXGuiILFDebugger/stepOver.png" height="24" /> Single Step [RETURN] - Execute the current line and stop on the next line in the current routine.

<img width="24" alt="stepInto.png" src="%PUBURL%/Main/APPXGuiILFDebugger/stepInto.png" height="24" /> Step Into [Option 1] - Execute a process or subroutine and stop on the first statement of the routine.

<img width="24" alt="stepOut.png" src="%PUBURL%/Main/APPXGuiILFDebugger/stepOut.png" height="24" /> Step Return [Option 2] - Resume execution and stop on the next RETURN statement.

<img width="24" alt="stepEnd.png" src="%PUBURL%/Main/APPXGuiILFDebugger/stepEnd.png" height="24" /> Step End [Option 3] - Resume execution of the current routine and stop on the last statement in the routine.

<img width="22" alt="stopToggle.png" src="%PUBURL%/Main/APPXGuiILFDebugger/stopToggle.png" height="24" /> Toggle Trap [F3] - Enable/Disable a trap on the current statement.

<img width="24" alt="editValues.png" src="%PUBURL%/Main/APPXGuiILFDebugger/editValues.png" height="24" /> Edit Values [F12] - Edit the value of the variables on the current statement.

<img width="24" alt="inspect.png" src="%PUBURL%/Main/APPXGuiILFDebugger/inspect.png" height="24" /> Inspect/Edit Value [F11] - Inspect and/or edit the value of a specified variable

<img width="24" alt="stack.png" src="%PUBURL%/Main/APPXGuiILFDebugger/stack.png" height="24" /> View Process Stack [Ctrl+1]

<img width="24" alt="watch.png" src="%PUBURL%/Main/APPXGuiILFDebugger/watch.png" height="24" /> Watchpoint [F10] - Set or Clear watch points on individual variables

Execute Next [F9] - Set next statement to execute

---++ Watchpoints

Watch points can be very helpful when debugging a process. An APPX watchpoint is a field name that you want APPX to "watch". Anytime the value of the field changes, APPX will invoke the ILF Debugger and alert you to the change in value.

<img width="670" alt="Watchpoints.PNG" src="%PUBURL%/Main/APPXGuiILFDebugger/Watchpoints.PNG" height="593" />
---++ Process Stack

When debugging a process, it is sometimes useful to be able to view the process stack. The process stack is simply a list of the "ancestor" processes of the process that is currently running. In the example below, the level 1 process is the current input process named DEBUG which displays the process stack list. The level 2 process is the process that is currently being debugged. In this example, the process being debugged is an input process in application DMO named PROSPECT FILE MAINTENANCE. The level 3 and higher processes identify the various processes in application design that were run to design and then test the PROSPECT FILE MAINTENANCE input process.

<img width="670" alt="ProcessStack.PNG" src="%PUBURL%/Main/APPXGuiILFDebugger/ProcessStack.PNG" height="593" />
---++ How to Revert to the Original ILF Debugger

If you prefer to use the original character mode ILF Debugger, you can disable the GUI ILF Debugger and revert to the original ILF Debugger by setting the following environment variable:

APPX_OLD_DBG=&lt;any_value&gt;

The easiest way be ensure that this environment variable is set for all APPX sessions is to define it in the appx.env configuration file. Simply add the environment variable to the appx.env file. You may assign &lt;any_value&gt; to the variable to enable it. The example below assigns a value of 1 thereby enabling the original ILF debugger.

<pre><blockquote dir="ltr"><p> </p>#=============================================================================
# Revert to original ILF Debugger
#=============================================================================
APPX_OLD_DBG=1
</blockquote>
</pre>

---++ Comments:

_Read what other users have said about this page or add your own comments._

The toolbar needs a button for: Execute Next [F9] - Set next statement to execute

-- SteveFrizzell - 30 Sep 2008 %COMMENT%

-- SteveFrizzell - 26 Sep 2008
Topic revision: r1 - 2010-01-27 - RayPelegrino