Configure Annotation Server

Annotation Server Settings

The Prizm® Annotation Server samples can be configured to work in your environment without modifying the source code and building a new binary. Simply adjust the settings below to be able to get one of the Prizm Annotation Server samples deployed quickly to begin working with Prizm Viewer.

Each version of Prizm Annotation Server includes a configuration file. You need to configure the appropriate file, depending on the version you are going to deploy.

ASP.NET: See the Web.config <appSettings> section located in the root of the source code or
JSP: See the web.xml located in the /WebContent/WEB-INF folder; each setting is contained within a <context-param> element

Prizm Annotation Server Configuration Settings

Setting	Description
useDatabase	This value is set to “true” to use an ODBC database, “false” to use the file system
rootAnnPath	This value is set to the root folder where the annotation files are stored on your server. This value is only needed if you are using the file system as the persistent store.
annotFileExt	This value is appended to each of the annotation files, to help with identification of annotation storage files. For example, if you set this value to “.ann”, all annotation files are saved with this value appended to the end of the filename.
databaseConnection	This value contains the ODBC connection string used to connect to the ODBC source. This value is only needed if you are using a database as the persistent store.
validateXml	This value is set to “true” to cause the annotation server to validate all incoming (put) and outgoing (get) XML data. Setting this value to “false” results in no XML validation.
xmlSchema	This value is set to the location of the XML schema file used to validate XML annotation data
shareRetryLimit	This value is used to control the number of attempts the annotation server makes when attempting to save annotation data, when a sharing problem arises. This value is used in conjunction with the shareRetryWaitTime value.
shareRetryWaitTime	This value is used to control the length of time the application waits between attempts to access the persistent store when the persistent resource is locked (sharing). This value is used in conjunction with the shareRetryLimit value.
logLevel	This value is used to control the level of logging performed by Prizm Annotation Server. There are four settings available: NONE, SEVERE, WARNING, and INFO. Note: This setting only applies to the JSP sample.
logPath	This value is used to specify the location of the log file, where logging information is captured when Prizm Annotation Server executes Note: This setting only applies to the JSP sample

Host Environment Configuration

To ensure successful deployment of Prizm Annotation Server, review the minimum system requirements information for Prizm Annotation Server before deploying one of the samples to your platform. You can find this information in the Operating Requirements topic.

1. The following checklist of configuration steps may help you plan your deployment for Prizm Annotation Server:

Make sure you have installed the annotation server code into your environment completely. For ASP.NET, this includes configuring the folder containing the Annotation Server files as an ASP application, ASP.NET is enabled on the server, etc.
For JSP, you should first install the files using the WAR file, then make changes to the code
afterward.

2. Make sure you have completely configured the Annotation Server store settings.

The samples can be configured to use the file system (files), or an ODBC source for annotation storage (tables).
Ensure the store item is present (database file/tables are present, root where the annotation data files exists).
The database schema Prizm Annotation Server expects can be found in "Prizm Annotation Server - Annotation Data - Storage - Database" of the Technical Reference section.

3. The security context your Prizm Annotation Server must have permission to access the file system areas, or database tables, used for storing annotations.

The default security (log in) context is usually the account that your web server is using.

4. If you have made changes to the Annotation Server source files or configuration, you may need to re-start your Annotation Server application for those changes to take effect.

Redaction Functionality

In order to make redaction functionality available in Prizm Viewer 10, the annotation server must first return an annotation file with the PV_Redact_Redact_b_r attribute defined in the Page element within the PV10AnnotationsSchema, with either a True or False value. This value is the default value for the redaction attribute created while using this annotation file. If the redact attribute is not set in the page element, the redact function is disabled in the annotation menu.

If an annotation element does not have a redact attribute, it is considered to be set to false, regardless of the default value in the page (since that value only applies to new annotations).

Changing the value of the redact attribute is considered modifying the annotation, and is persisted back to the server.

This attribute does not support the 'I' value from previous versions of Prizm Viewer.

For specific PV10 Annotation Schema details and descriptions, refer to the Accusoft.PrizmViewer10.Admin.chm Help file which references the PV10AnnotationsSchema.