Prizm Annotation Server source code does not have an installer available that deploys an annotation server on your application server. You need to deploy the appropriate files to your application server, using the information below as guidance.
ASP.NET
Modify the web.config file to set the values in the appSettings section to meet your system configuration:
- 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 tries to save annotation data, when a sharing problem arises. This value is used in conjunction with the shareRetryWaitTime value.
- shrareRetryWaitTime - This value is used to control the length of time the application should wait between attempts to access the persistent store when the persistent source is locked (sharing). This value is used in conjunction with the shareRetryLimit value.
Checks
- If you are using the file system as the persistent store, make sure the directory specified by the RootAnnotPath value in step 1 exists.
- If you are using a database as the persistent store, make sure the ODBC connection specified by "DatabaseConnection" value in step 1 exists.
- Ensure that any file system files and directories, databases, ect. have read/write access by the web server account.
Create, Modify & Configure Folders
- Create a folder where you want to locate the Prizm Annotation Server (e.g., c:\Inetpub\wwwroot\PrizmAnnotServer).
- Copy the files global.asax, web.config, and PrizmAnnotServer.aspx to the folder designated in the previous step.
- Create a folder named "bin" in the folder created earlier.
- Copy the file PrizmAnnotServer.dll to the bin folder.
- Open the Internet Information Services (IIS) Manager.
- Locate your website in the list of websites (e.g., "Default Web Site")
- If the Prizm Annotation Server folder is located under the root of the web site folder, you should see your folder listed under this website. If you placed the folder somewhere else, you need to create a virtual directory to map to the folder.
On Operating Systems prior to Windows Server 2008:
- Right-click the folder and choose Properties from the pop-up menu.
- Click Create to the right of the application name and enter "PrizmAnnotServer" in the application name field.
- Make sure the execute permissions are set to execute scripts.
On Windows Server 2008:
- Right-click the folder and choose Convert To Application from the pop-up menu.
- Click OK in the Add Application dialog that appears.
Test
- To test, execute the address in your browser: http://(server)/(application folder)/PrizmAnnotServer.aspx?f=test.tif&p=1&v=2.0. If everything is configured correctly, the annotation server returns the "default" XML content for a file where no annotations exists (no annotations). If you replace all & with ?, you should see an exception displayed instead.
- You can also use the IIS trace facilities to help work through problems. You need to modify the <trace> element in the web.config file to enable the trace facility. Set enabled=true, and localOnly = false. You are then able to see trace information by entering http://(server)/(application folder)/trace.axd in your browser address bar.
JSP
- Deploy the application by using the application server console to deploy a new application, and install the application archive (PrizmAnnotServer.war).
- Modify the web.xml file context parameters to tailor the configuration to suit your environment.
- The following context parameters are available in web.XML. All the source code for Prizm Annotation Server JSP is included in the archive.
- 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 storage.
- 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 storage.
- 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 the xml annotation data.
- shareRetryLimit - This value is used to control the number of attempts the annotation server tries to save annotation data, when a sharing problem arises. This value is used in conjunction with the shareRetryWaitTime value.
- shrareRetryWaitTime - This value is used to control the length of time the application should wait between attempts to access the persistent store when the persistent source 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.
- logPath - This value is used to specify the location of the log file, where logging information is captured when Prizm Annotation Server executes.
Locate Folders & Configuration
- Locate the folder where Prizm Annotation Server was loaded by your application server (You may have to search for PrizmAnnotServer.jsp to locate the installation location in your environment). The WAR file will deploy the application to /PrizmAnnotServer by default.
Test
- Execute the address in your browser: http://(server)/(application folder)/PrizmAnnotServer.jsp?f=test.tif&p=1&v=2.0. If everything is configured correctly, the annotation server returns the "default" xml content for a file where no annotations exist (no annotations). If you replace all & with ?, you should see an exception displayed instead.
- You can also use the logging facility to help work through problems. You need to modify the logPath and logLevel parameters in the web.xml file to configure the logging facility.
See Also
