Snowbound Virtual Viewer

Home » Support Library » Developer Support » New Installation Guidelines » Snowbound Virtual Viewer

Install Snowbound Virtual Viewer

Acquire the file “VirtualViewerJavaHTML5.zip”.  You can download a trial edition here:

http://www.snowbound.com/products/document-viewer/html5-document-viewer

Unzip the file to extract the VirtualViewerJavaHTML5.war file (the zip file also includes Virtual Viewer documentation).

Install another instance of Apache Tomcat 8.0.21 to run the Snowbound webapp.  We don’t recommend running ArkCase and Snowbound Virtual Viewer in the same Tomcat instance.

Configure this Apache instance to run as a system service.

Copy the VirtualViewerJavaHTML5.war file to the Tomcat webapps folder.

Configure Snowbound Virtual Viewer

Acquire this file from the ArkCase distribution site:

  • snowbound/acm-snowbound-integration-<version>-distribution.zip

You also need a Snowbound license, which will be in a file named ‘SnowboundLicense.jar’.  The evaluation comes with a 30-day license.  You can get a permanent license from your ArkCase sales person.

If the Snowbound webapp is running, undeploy the Snowbound webapp, then shutdown Tomcat.

Copy the Snowbound integration zip file to the same folder as the Snowbound war.

Unzip the zip file (unzip acm-snowbound-integration-<version>-distribution.zip).

You should now see several folders and files.

Make a lib folder under the WEB-INF folder, and put the SnowboundLicense.jar there.  You should now have WEB-INF/lib/SnowboundLicense.jar.

Edit the WEB-INF/web.xml file:

  • Find the codebase init-param. Make sure the param value is the right address for VirtualViewer war file.
  • Find the servletURL init-param. Make sure the hostname and port are correct.
  • Find the baseURL init-param. Make sure it is the ArkCase URL that works from the Snowbound host (will not always be the same URL you would use from a browser).
  • Find the tmpDir init-param. Make sure the value is appropriate.
  • Search for every occurrence of “VirtualViewerJavaHTML5”. Many of them will be full URLs to stamp image files.  Make sure all such URLs are correct.
  • Find the snowboundLicensePath env-entry. Make sure the path to the license is correct; since the license is in the war, make sure the path is the correct exploded path to the license.

Add files to the Snowbound war: for each folder and file that were unzipped from the distribution zip file, run this command:

  • zip -r VirtualViewerJavaHTML5.war <folder or file name>

Restart the Tomcat server, and deploy the updated VirtualViewerJavaHTML5 war file.

Logrotate (Linux hosts only)

Unfortunately, by default Tomcat’s catalina.out file is never truncated or removed, and ordinarily you have to shutdown Snowbound to clean it.  On Linux hosts with logrotate enabled, Armedia uses the following method to manage the size of the catalina.out file, with no Snowbound restarts needed.

Create the file ‘/etc/logrotate.d/snowbound’ with this content:

  • /opt/app/acm/apache-tomcat-snowbound/logs/catalina.out {
  •   copytruncate
  •   daily
  •   rotate 7
  •   compress
  •   missingok
  •   size 5M
  • }

Ensure the path to the catalina.out is correct.  Then create or update a cron schedule for the root user:

  • sudo crontab –u root -e

Add a line like this:

  • 30 2 * * * /usr/sbin/logrotate -f /etc/logrotate.d/snowbound

When you finish updating this crontab, run this command to verify the crontab was updated:

  • sudo crontab –l

The output should include the line you just added, to run the logrotate script at 2:30 AM each day.  Of course the cron expression can be updated to your taste.