Content Management and Capture

 View Only

Best Practices : Configuring ViewONE virtual from installation process

By Dhananjay Bhandarkar posted Mon June 14, 2021 04:58 AM


IBM® Daeja® ViewONE Virtual provides an HTML5-based image viewer that extends your web browser. You can use this viewer to view, annotate, zoom, magnify, scroll, pan, rotate, and print your images and image documents quickly and easily.

In this documentation we will illustrate how IBM Daeja ViewONE Virtual can be configured to web application server from installation process.

Note: Follow the directions from your web application server documentation to deploy the web application to the web application server. In this documentation we are referring locally deployed tomcat application server listening to http port 8080

Step 1: Install Daeja ViewOne using one of the 3 modes (GUI, Silent and command mode) as mentioned in
this documentation. This will install all required license chosen from entitlement during install, Server jar files and v1files for configuration.

Virtual viewer entitlements to select during installation process.

  • If you have not selected Microsoft office module entitlement, generated license file <Installed location>\server\WEB-INF\lic-server-virtual.v1 will block user to view MS office documents.

  • If you have not selected Permanent redaction module entitlement, generated license file <Installed location>\server\WEB-INF\lic-server-virtual.v1 will block user to apply permanent redaction feature.

Following installed files are needed for ViewONE virtual webapp configuration

Step 2: Create web.xml and as mentioned bellow.

web.xml :
This XML file defines the location of the core servlet class files ( If you are adding IBM Daeja ViewONE to an existing web application, you might already have a web.xml file. If you are creating a new web application, you might need to create the web.xml file.

<?xml version="1.0" encoding="ISO-8859-1"?>

<!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN" "">

      <display-name>ViewONE Servlet</display-name>
      <description>Servlet for returning image tiles</description>
</web-app> You use this file to configure and customize the virtual viewer servlet. more details


Step 3: Create viewone_virtual.html as below | Configures virtual viewer in carbon UI, displays document in thumbs panel at left. Also both annotation and redaction is enabled for all annotation types. more info


<!DOCTYPE html>
   <script type="text/javascript"
		<param name="annotate" value="True">
		<param name="annotateEdit" value="true">
		<param name="annotationsToggleBurn" value="mixed" >
		<param name="annotationDefaults" value="all {burnable=true}">
		<param name="designPackage" value="carbon">
		<param name="viewmode" value="thumbsleft">

Step 4:
Create a folder viewone in tomcat's webapps\viewone\WEB-INF directory that holds all required viewer configuration file as below (Create folders as needed below).

  • Copy    <daeja_install_dir>\server\WEB-INF   to   <tomcat_dir>\webapps\viewone\
  • Copy    <daeja_install_dir>\server\WEB-INF   to   <tomcat_dir>\webapps\viewone\
  • Copy    <daeja_install_dir>\client\Annot.xsl   to   <tomcat_dir>\webapps\viewone\WEB-INF\xsl\
  • Copy    <daeja_install_dir>\client\v1files   to   <tomcat_dir>\webapps\viewone\
  • Copy    web.xml and   to   <tomcat_dir>\webapps\viewone\WEB-INF\
  • Copy    <daeja_install_dir>\client\v1files   to   <tomcat_dir>\webapps\viewone\
  • Copy    viewone_virtual.html   to   <tomcat_dir>\webapps\viewone\demo\ (This is place holder for client html files)

Step 5: More configuration details here

Step 6: Now restart the tomcat application server and launch ViewOne virtual using http://localhost:8080/viewone/demo/viewone_virtual.html and enjoy ViewONE virtual experience.


1 comment



Fri February 10, 2023 11:30 AM

Thank you for the step by step guide. It is indeed helpful