Difference between revisions of "Web Report Viewer Troubleshooting"

From ISoft Wiki
Jump to navigationJump to search
(7 intermediate revisions by the same user not shown)
Line 6: Line 6:
* Report Commander - command line application used to generate report PDFs by the Crystal Server (and Report Queue)
* Report Commander - command line application used to generate report PDFs by the Crystal Server (and Report Queue)
* Report Queue - python application that reads from reportqueue table to send emails and print to a printer. '''Report Queue is separate from Crystal Server, and the two systems do not interact.'''
* Report Queue - python application that reads from reportqueue table to send emails and print to a printer. '''Report Queue is separate from Crystal Server, and the two systems do not interact.'''
* reportqueue - a table in the database that logs report runs.
* reportparameter - a table in the database that associates parameters to reports


== Errors ==
== Common Errors ==


=== Error Running Report ===
=== Error Running Report ===


This means that Report Commander encountered an error running the report. Listed below are some common errors and their solutions
This means that Report Commander encountered an error running the report. If you get this error, check the reportqueue error for a more detailed error message. Listed below are some common ones.


==== "Missing parameter values" ====
==== "Missing parameter values" or "Double check the parameters..."====


This means that Report Commander did not receive all required parameters for the report. Often times, the report will run fine on desktop, because the Crystal SDK can "fill in the gaps", while the web Report Viewer cannot, and needs a row in reportparameter for every parameter.
This means that Report Commander did not receive all required parameters for the report. Often times, the report will run fine on desktop, because the Crystal SDK can "fill in the gaps", while the web Report Viewer cannot, and needs a row in reportparameter for every parameter.
Line 23: Line 25:
If it doesn't, the adder script could be out of date or otherwise missing parameters.
If it doesn't, the adder script could be out of date or otherwise missing parameters.


==== ??? ====
==== Parameter not found in report: <parametername> ====
 
This means that a report was passed a parameter it doesn't expect.
 
===== Solution =====
 
Make sure the report is up to date
 
==== (I can't remember the error message) ====


Missing / invalid ODBC configuration. I think this presents as "could not connect to the database" or something to that effect.
Missing / invalid ODBC configuration. I think this presents as "could not connect to the database" or something to that effect.
Line 29: Line 39:
===== Solution =====
===== Solution =====


Brian can make sure the ODBC connection is valid, and Charles can check that the ODBC connection name in the Crystal Server config is correct.
Brian can make sure the ODBC connection is valid, and give Charles the name to check that the ODBC connection name in the Crystal Server config is correct.


==== Invalid Value for <parameter> ====
==== Invalid Value for <parameter> ====
Line 50: Line 60:


Once or twice the cached .rpt file on Bunnahabhain was corrupted or something. We fixed it by reuploading the report to the customer's db and deleting the cached .rpt file.
Once or twice the cached .rpt file on Bunnahabhain was corrupted or something. We fixed it by reuploading the report to the customer's db and deleting the cached .rpt file.
<code>Error: WARNING: MYSQL_OPT_RECONNECT is deprecated and will be removed in a future version.</code> - Disable "Auto Reconnect" on ODBC. Presents as "Unkown Error" or "Internal Server Error" in the UI

Revision as of 12:30, 18 November 2024

This article applies to Presage Web and ITrack Chromium. The web Report Viewer will give a general error, error details are logged to the reportqueue table and can be viewed in the "History" (web) or "Print Queue" (desktop) tab of the Report Viewer screen.

Terms

  • Crystal Server - the Node.JS application that uses Report Commander to generate the report PDF. Runs on Bunnahabhain
  • Report Commander - command line application used to generate report PDFs by the Crystal Server (and Report Queue)
  • Report Queue - python application that reads from reportqueue table to send emails and print to a printer. Report Queue is separate from Crystal Server, and the two systems do not interact.
  • reportqueue - a table in the database that logs report runs.
  • reportparameter - a table in the database that associates parameters to reports

Common Errors

Error Running Report

This means that Report Commander encountered an error running the report. If you get this error, check the reportqueue error for a more detailed error message. Listed below are some common ones.

"Missing parameter values" or "Double check the parameters..."

This means that Report Commander did not receive all required parameters for the report. Often times, the report will run fine on desktop, because the Crystal SDK can "fill in the gaps", while the web Report Viewer cannot, and needs a row in reportparameter for every parameter.

Solution

Since this is caused by missing rows in the reportparameter table, re-running the adder scripts will generally fix the issue.

If it doesn't, the adder script could be out of date or otherwise missing parameters.

Parameter not found in report: <parametername>

This means that a report was passed a parameter it doesn't expect.

Solution

Make sure the report is up to date

(I can't remember the error message)

Missing / invalid ODBC configuration. I think this presents as "could not connect to the database" or something to that effect.

Solution

Brian can make sure the ODBC connection is valid, and give Charles the name to check that the ODBC connection name in the Crystal Server config is correct.

Invalid Value for <parameter>

Report Commander received an invalid value for the specified parameter

Invalid Session

This error is caused by the Crystal Server failing to verify the session token it was passed.

Solution

Most likely, if logging out and back in doesn't fix it, this means that the Crystal Server configuration is either missing, or configured with a different database host URL than the API. Charles can check the logs to double check, as well as update the config file. Brian can then restart the Crystal Server service to load the updated configuration.

Invalid Report

The Crystal Server failed to find the report with the specified name/type.

Other Errors

Once or twice the cached .rpt file on Bunnahabhain was corrupted or something. We fixed it by reuploading the report to the customer's db and deleting the cached .rpt file.

Error: WARNING: MYSQL_OPT_RECONNECT is deprecated and will be removed in a future version. - Disable "Auto Reconnect" on ODBC. Presents as "Unkown Error" or "Internal Server Error" in the UI