Skip to main content

Submitting a Debug Package

  • Updated

Submitting a Debug Package

If the Admin Console > General > Other Settings > Debug Password is set, a client will have the ability to submit Debug Packages automatically to Exago, Inc. via the internet.

A copy of the report definition, the Exago configuration file, and the data set used to generate the report will be transmitted to Exago’s Support Team.

Automatically Creating a Debug Package

To send a Debug Package to Exago Support automatically through the Web Application user interface:

red exclamation point

The automatic debug packager only works with single Advanced Reports, TreeAdvancedReport.pngCrossTab Reports, TreeExpressReport.pngExpress Reportsand TreeExpressView.pngExpressViews. Contact Exago’s Support Team directly when troubleshooting Advanced Reports with linked reports (a.k.a. drilldowns), TreeChainedReport.pngChained Reports or TreeDashboardReport.pngDashboards.

  1. From the Report Tree, select the report under test.
  2. Press Ctrl + Shift + X.
  3. In the Debug Package dialog:
    firefox_FjglTqTkwj.png

    Debug Package dialog

    1. Enter the Debug Password (set in the Admin Console > General > Other Settings).
    2. Enter either the ticket ID number or the entire URL to the ticket in the Exago Support Ticket URL or Ticket ID field.
    3. Enter a Contact Email Address.
  4. Click Okay to begin the report execution process. If the report has any prompting filters or parameters, enter values for them when prompted.

A success/failure message will display when the process finishes. Click Dismiss. A confirmation email will be sent to the email in the Contact Email Address field.

Debug package successfully sent to Exago, Inc.

Manually Creating a Debug Package

If a debug package cannot be sent automatically, a package may be created manually instead. The files can be zipped and directly attached to a ticket request.

red exclamation point

Before manually creating a debug Package verify that Admin Console > General > Scheduler Settings > Enable Remote Report Execution is set to False

To manually create a Debug Package:

light bulb

This topic references <WebApp>/, <WebSvc>/ and <Sched>/as a placeholder for the Web Application, Web Service API and Scheduler Service's install location respectively. The default install location is C:\Program Files\Exago\ExagoWeb\ (/opt/Exago/ on Linux), C:\Program Files\Exago\ExagoWebApi\ ( /opt/Exago/WebServiceApi/ on Linux) or C:\Program Files\Exago\ExagoScheduler\ (/opt/Exago/Scheduler/ on Linux); however, these directories can be changed during installation.

  1. Create the <WebApp>/Debug folder if it doesn’t already exist in the file system.
  2. Make sure <WebApp>/Debug has the same read/write permissions as the Report and Temp Folders.
  3. Set Admin Console > General > Other Settings > Enable Debugging to True.
  4. Execute the report under test.
  5. Zip the contents of the <WebApp>/Debug together and attach them to the next response to your request.
red exclamation point

Each time a report is executed, the Debug directory will be cleared. Be sure to save any needed files before creating a new package.