Skip to content

Debugger ​

The OIE Debugger steps through channel JavaScript execution interactively and shows variable state at each point in your scripts.

The debugger window opens on the server

The debugger is a window that the server process opens on its own display, not in the Administrator. A server started as shipped runs headless (-Djava.awt.headless=true in conf/base_includes.vmoptions), and there Debug Channel fails: the channel does not deploy, and the server log shows java.awt.HeadlessException. Debugging needs a server process that can open a window on a display you can see.

JavaScript Debugger is a community extension that debugs channel JavaScript from the Web Administrator instead, so the server needs no display. It supports OIE 4.6.0 and 4.7.0 and needs the Web Support extension.

Overview ​

The Debugger is built on the Rhino JavaScript engine's debugging API. When a channel is deployed in debug mode, a standalone debugger window opens where you can:

  • Set line-level breakpoints in JavaScript source
  • Step through execution one line at a time
  • Inspect this and local scope variables at each breakpoint
  • Evaluate expressions and set watches
  • Control execution flow (break, resume, step into/over/out)

Deploying in debug mode ​

  1. Select the channel in the Channels view or open it in the channel editor
  2. Click Debug Channel in the channel tasks panel
  3. In the channel editor, a confirmation prompt comes first: "This channel will be saved before it is deployed in debug mode. Are you sure you want to save and debug this channel?" when there are unsaved changes, otherwise "Are you sure you want to debug this channel?". A disabled channel is not deployed: "The channel is disabled and will not be deployed."
  4. A Debug Channel dialog appears with checkboxes to select which scripts to debug:
    • Deploy/Undeploy/Preprocessor/Postprocessor scripts
    • Attachment/Batch scripts
    • Source connector scripts
    • Source filter/transformer
    • Destination filter/transformer
    • Destination connector scripts
    • Destination response transformer
  5. Select the desired script types and click OK
  6. The channel deploys and the debugger window opens. When a script you selected runs, execution pauses at its first line

INFO

Debug mode affects performance.

Debugger window ​

The Debugger opens as a separate Rhino JavaScript Debugger window with two main areas: source windows for viewing code, and a context panel for inspecting variables.

Source windows ​

  • Display the JavaScript source for the scripts being debugged
  • A yellow arrow in the gutter indicates the currently executing line
  • Line numbers and breakpoint markers appear in the left gutter

Debug controls ​

ControlShortcutAction
BreakPausePause execution at the current point
GoF5Resume execution until the next breakpoint
Step IntoF11Step into the current function call
Step OverF7Execute the current line without entering sub-functions
Step OutF8Execute until the current function returns

F5, Pause, F7, and F11 work while the source pane has keyboard focus. F8 does not step out then, because the window's split pane takes the key. F8 works after you move focus to the menu bar (press F10), and the Step Out button works.

Context panel ​

The context panel has a Context dropdown to select the current stack frame, and two sets of tabs:

Variable tabs:

  • this. Displays properties of the current this object in a tree table
  • Locals. Displays local variables in the current scope

Evaluation tabs:

  • Watch. Shows watched expressions and their values
  • Evaluate. A text area where you can type and execute JavaScript expressions during a breakpoint

Debugger menus ​

File menu ​

  • Open. Open a JavaScript source file
  • Run. Load and run a JavaScript file
  • Exit. Clear all breakpoints, resume the paused script, and close the debugger window

Edit menu ​

  • Cut, Copy, Paste. Standard clipboard operations
  • Go to function. Jump to a function definition
  • Go to line. Jump to a specific line number (Ctrl+L)

Debug menu ​

  • Break, Go, Step Into, Step Over, Step Out. Execution control
  • Break on Exceptions. Pause when an exception is thrown
  • Break on Function Enter. Pause at each function entry
  • Break on Function Return. Pause at each function return

Window menu ​

  • Cascade. Cascade open source windows
  • Tile. Tile open source windows
  • Console. Show the console window
  • Lists open source file windows

Setting breakpoints ​

  1. In a source window, click in the left gutter next to a line number
  2. A breakpoint indicator appears on that line
  3. When execution reaches that line, the debugger pauses
  4. Inspect variables in the context panel and use step controls to continue

You can also use the right-click context menu in source windows to set or clear breakpoints.