The steps below detail how to install and configure VirtualViewer using a single server deployment model that includes the VirtualViewer within the same WebSphere instance as ICN.

The VirtualViewer web application is delivered as a ZIP archive. The zip archive must be reviewed and modified by the target environment user to manage and manipulate the configuration of the web application before and during deployment to the target server.

Deploying VirtualViewer® web application

NOTE: The steps below identify how VirtualViewer® is deployed on WebSphere. Please adjust the steps accordingly based on the Application Server.

  1. Copy the updated virtualviewer.war file to a location accessible to the application server.

  2. Login to WebSphere Admin Console: 
    https://\<your-websphere-server\>:\<port\>/ibm/console/logon.jsp

  3. Select Applications > Application Types > WebSphere enterprise applications.

  4. Select the Install button.

  5. Browse to the location of virtualviewer.war, select it and then click Open. VirtualViewer and ICN single server deployment

  6. Select Next.

  7. Select Fast Path, select Next. VirtualViewer and ICN single server deployment

  8. Leave the default values in place on the “Select installation options” screen and click Next.

  9. Select the target “Clusters and servers:” and click Apply. Then select the check box for the Virtual Viewer Module and click Next. VirtualViewer and ICN single server deployment

  10. If required, map the appropriate Virtual hosts and click Next. VirtualViewer and ICN single server deployment

  11. Enter /virtualviewer as the Context Root and click Next. VirtualViewer and ICN single server deployment

  12. Review the Summary and if no changes are required click Finish.

  13. Wait for deployment completion. Select Save.

  14. On the host, please verify if the application files are copied to all nodes where the deployment was performed.

  15. Select the virtualviewer_war application checkbox and click the Start button.

Configuring the VirtualViewer® web application

P8ContentHandler.properties

Update the P8ContentHandler.properties file located at /virtualviewer/WEB-INF/classes, following the instructions within the file to set the following properties:

  1. CEUri - To locate your CEUri, follow the instructions in the section Where do I find my CEUri?.

  2. JaasStanza - To learn more about IBM’s available JaasStanza values, and which to use visit: https://www.ibm.com/support/knowledgecenter/SSNW2F_5.5.0/com.ibm.p8.ce.dev.ce.doc/sec_concepts.htm

  3. Admin ID and Password – Both of which are optional

  • The VirtualViewer P8ContentHandler can complete all required tasks to configure P8 to utilize Annotations within the VirtualViewer. To accomplish this, please provide an Admin ID that has been granted appropriate permissions to create a subclass of the Annotations class, as well as the ability to create a custom property. This ID can be removed once the Annotations configuration is complete. To learn more about VirtualViewer Annotations, please read the section titled “VirtualViewer Annotations Support”.

web.xml

Update the path for the “tmpDir” parameter to your desired location if it varies from the default value:

  1. \<param-name\>tmpDir\</param-name\>

  2. \<param-value\>/opt/IBM/P8/sbtmp\</param-value\>

config.js

The config.js file, located in /virtualviewer/user-config can be updated to customize the functionality of the VirtualViewer.

If any customizations are required, perform them now. Definitions of the parameters in the config.js file can be found in VirtualViewer® configuration.

SnowboundVirtualViewerPlugin.jar

Copy the SnowboundVirtualViewerPlugin.jar into the ICN Plugins Directory and configure the VirtualViewer Plugin. Instructions for this step can be found in Installing the VirtualViewer HTML5 ICN Connector.

Restart the application

Stop and restart the virtualviewer_war application in the WebSphere Management Console.