About debugging errors

In some situations, it may be necessary to run a debugging program to uncover or identify program errors. Debugging is normally a task best delegated to WorkZone support, but you can run the debugging program yourself to get the debug results or to see if there are obvious causes for the error. You can send the debug results to WorkZone support if requested.

Usually, a debug report will be requested if the reported error cannot readily be localized or identified in the accompanying error report. The results of the debugging are not easy to interpret and is usually sent to WorkZone support for additional analysis.

The SJ-Debug program

The SJ-Debug program is used to debug errors in WorkZone. When run, the program will start collecting information from the running system, which means that WorkZone must be running in order to capture process information correctly.

The SJ-Debug program collects data and information from all aspects of WorkZone, including information from other databases and agents. In order to ensure stable operations, it is advised to conduct debugging in a system with as few active users logged as possible. Debugging a system with limited user activity also makes it easier to locate and isolate any errors that need further analysis.

Important: The SJ-Debug program can potentially display confidential information and is therefore password-protected. Please contact WorkZone support or your WorkZone representative for access to the SJ-Debug program.

The SJ-Debug program is installed by default on the WorkZone Content Server and can be accessed and started directly from Windows in the server.

To start the SJ-Debug program on the server:

  1. In windows, press Start or click the Windows button and type SJ-Debug. You can also press ALT+R in windows to open the Run window and type SJ-Debug.
  2. The Logon to SJ-Debug form is displayed. Use the password supplied by WorkZone support to log on.
  3. The SJ-Debug program will open and start debugging automatically when you have logged on.

When the SJ-Debug program has run a set amount of time, ideally from before the error occurs to after the error has occurred, the debugging can be stopped. The results can then be copied into a text-editor (such as Notepad), saved as an ordinary text-file (.txt), and sent to WorkZone support.

Common SJ-Debug actions

Send debug results to Notepad

In the SJ-Debug form, click File > To Notepad (or press CTRL+P) to copy the debug results, open Notepad and insert the results.

You can save the Notepad file as a.txt file and send it to WorkZone support for further analysis.

Start/stop/reset debugging

  • Start: In the SJ-Debug form, click Debug > Start (or press F5) to restart debugging. The Enter Header form is opened and you can insert a text in the debug results to help you locate where you started the debugging again.
  • Stop: In the SJ-Debug form, click Debug > Stop (or press SHIFT+F5) to stop debugging.
  • Reset: In the SJ-Debug form, click Debug > Reset (or press CTRL+R) to stop debugging and clear the results.

Insert a line

You can insert a line consisting of a series of dashes (-------- -------- -------- -------- --------) in the debug results to mark an area. This enables you to better visually locate that area again when analyzing the results. You can only insert a line when the debugging is running.

  • In the SJ-Debug form, click Debug > Insert line (or press CTRL+L) to enter a line in the results.

Set the Debug level

Each error type has an assigned Debug level. You can reduce the number of lines (and thereby amount of debug results) you have to analyze by setting an upper limit which debug levels to include in the debug results. The default debug level is 100

  • In the SJ-Debug form, click Debug > Debug level (or press CTRL+D) to open the Set Debug level form. In the Set Debug level form, set the maximum debug level to include in the debug results and click OK.