Installing VirtualViewer® for ICN on a single server environment
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 Snowbound 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.
-
Copy the updated
virtualviewer.war
file to a location accessible to the application server. - Login to WebSphere Admin Console:
https://\<your-websphere-server\>:\<port\>/ibm/console/logon.jsp
-
Select Applications > Application Types > WebSphere enterprise applications.
-
Select the Install button.
-
Browse to the location of
virtualviewer.war
, select it and then click Open. -
Select Next.
-
Select Fast Path, select Next.
-
Leave the default values in place on the “Select installation options” screen and click Next.
-
Select the target “Clusters and servers:” and click Apply. Then select the check box for the Virtual Viewer Module and click Next.
-
If required, map the appropriate Virtual hosts and click Next.
-
Enter
/virtualviewer
as the Context Root and click Next. -
Review the Summary and if no changes are required click Finish.
-
Wait for deployment completion. Select Save.
-
On the host, please verify if the application files are copied to all nodes where the deployment was performed.
- 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
-
Follow the instructions within the file to set the appropriate
http CEUri
,JaasStanza
,Admin User ID(optional)
andPassword(optional)
. -
To locate your
CEUri
, see Where do I find my CEUri?. -
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
web.xml
Update the path for the “tmpDir” parameter to your desired location if it varies from the default value:
-
\<param-name\>tmpDir\</param-name\>
-
\<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 Snowbound 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.
Have questions, corrections, or concerns about this topic? Please let us know!