1. Extract the virtualviewer.zip file to a directory.

  2. The extracted .zip file includes the virtualviewer.war file.

  3. Save the virtualviewer.war file to the location where you want to install it. Please note that the application needs to be added to a web server before it can be run. Most Java web servers can use and expand the WAR file automatically, but if necessary you can expand the virtualviewer.war file in an archive utility such as 7-zip.

  4. Find the web application (webapps) directory where you want to install the files. For example: C:\Program Files\Apache Software Foundation\Tomcat 9.0\webapps for Tomcat on Windows, or /usr/local/tomcat/webapps for Tomcat on Linux.

  5. If you would like to change the default path from /virtualviewer, please see Changing the Default Directory for more information.

  6. Copy the virtualviewer.war{.filepath} or expanded virtualviewer directory to the webapps directory. If you are using a web server other than Tomcat this may be a different location.

Note: For other web servers, you may need to take web application deployment steps that are specific to that type of web server. If you have trouble installing PrizmDoc® for Java, try exploding the .war file. First, uninstall the application, then extract the contents of the .war file and deploy using the root directory /virtualviewer.

Note: If you are upgrading PrizmDoc® for Java from a version earlier than 5.0, please see Upgrading to PrizmDoc® for Java v5.x from an earlier version

Verifying your installation

After allowing a few minutes for it to start up, verify that PrizmDoc® for Java is running by accessing it with your browser. The default path for a local installation on Tomcat is http://localhost:8080/virtualviewer, but that may differ depending on your configuration. The hostname (“localhost”) and port (“8080”) will depend on your web server configuration, and the path (/virtualviewer) will depend on the name of your WAR file or application directory in the /webapps folder.

If the PrizmDoc® for Java main page loads, then it has been installed successfully.

Viewing sample documents

PrizmDoc® for Java provides sample documents and an example content handler with the installation to get you started. The example content handler loads those sample documents from the local filesystem, by default sample-documents/ subdirectory in the application directory. This folder can be configured by the filePath parameter in web.xml.

To view the sample documents, enter the URL for your server into a browser and specify the document name after documentId with the document name as shown below:

http://**[your server:port]**/virtualviewer/index.html?documentId=**[someFile.tiff]**

So for example, if you wanted to view a permitting document and were running Tomcat locally on port 8080 (the default port for PrizmDoc® for Java), you might enter http://localhost:8080/virtualviewer/index.html?documentId=BostonPermit.tif into your browser.

If you are able to see all of the documents that came in the sample-documents directory of your PrizmDoc® for Java installation, then you have successfully installed it.

To view other documents, specify the filename after the documentId in the URL.

If you are not able to see the documents in the viewer, please see the Troubleshooting page. If you are still not able to see the documents, please file a ticket with Accusoft Support at https://www.accusoft.com/support/.

Viewing your documents

Once you’ve verified the sample documents, you can move on to verifying that your documents render correctly by placing them in the sample-documents directory and then specifying the document’s file name after the documentId in the URL.

For example, if you want to display the file named test.tif, add that file to your sample-documents directory and test.tif after documentId as shown in the following example:

<p class="example">http://localhost:8080/virtualviewer/index.html?documentId=test.tif</p>

The documentId should be a filename if the sample content handler is used. Otherwise, it can be whatever the custom content handler expects for a documentId. For more information about custom content handlers, please see Working with the Content Handler.