Debug & Troubleshoot

Recommendations for Resolving Problems

Use the Annotation Server logging capability. The Annotation Server will capture useful information, including error information, and include it in the log.
Review security/file permission settings:

If you are using the file system as the persistent store:

Make sure the directory specified by the RootAnnotPath value in the configuration file is correctly specified.

Make sure the folders and files that contain the annotation data can be accessed by the account that the web
server is operating (read/write)

If you are using a database as the persistent store:

Make sure the DSN specified in the configuration file is correct.

Make sure the account that the web server is operating has access to the database containing the annotation data (read/write). If you are using a Microsoft Access database, check the security on the database file, as well as any database security you may be using.

Annotation Server Logging

Annotation Server Logging is available in both versions of the samples. However, configuration of logging is different between the two versions as described below.

ASP.NET

Logging for the ASP.NET sample is available using the IIS Trace facility. You will need to modify the <trace> element in the Web.config file to enable the trace facility. Setting enabled=true will allow you to see the trace information by entering http://(server)/(application folder)/trace.axd in your browser address bar. If you want to be able to view the trace log on a computer other than the server, you will need to set localOnly=false in the <trace> element as well.

JSP

Logging for the JSP sample will create a ASCII file located on your hard drive. You need to modify the logPath and logLevel parameters in the web.xml file to enable logging.

Annotation Server Error Number Codes

These values are values that are set in the HTML error response that Prizm Viewer is expecting when an error occurs processing a request for annotation retrieval or storage. These codes are specific to the implementation of Prizm Annotation Server developed by Accusoft and can be customized in any manner seen fit.

Error Code	Description
200	No Error
405	The request method was not set by the Web Server. This method is set by Prizm Viewer, and should not occur.
502	Annotation server busy. This error should occur only when the web server cannot save/retrieve the annotation data from the persistent store in the allotted time frame. This could be due to file sharing issues, database timeout, etc.
510	The URL specified in the “F” parameter (for a request), or in the annotation header (for a post), is invalid.
513	Could not save the annotation data to the persistent store.
522	The annotation data sent to the Annotation Server was corrupt (did not appear to adhere to the XML schema). The HTML document returned may contain additional information about the problem.
523	Internal Error. The description may contain additional information about the error.