VERIFIED SOLUTION i
X

How to Deploy Vault 7.4 ServiceWeb2.war on various platforms

UPDATED: April 28, 2017


These steps can also be found on the Vault install media in the InstallSet-Vault\common\sample-java\ServiceWeb2\docs directory, in the file called ServiceWeb2-Deployment.txt and ServiceWeb2-Setup.txt

######################################################
#the files included in distribution packages

1. j2ee_libs.jar is including below libs:
   javaee-api-5.jar
   servlet-api-2.4.jar

2. log4j-1.2.16.jar is for logging lib used in ServiceWeb2

3. ServiceWeb2.war is the war file can be deployed in a web-server.



######################################################
#TOMCAT deployment

1. remove the old ServiceWeb2.war and related files:
   <TOMCAT>\conf\Catalina\localhost\ServiceWeb2.xml
   <TOMCAT>\work\Catalina\localhost\ServiceWeb2\
   <TOMCAT>\webapps\ServiceWeb2\
   <TOMCAT>\webapps\ServiceWeb2.war

2. other libs
   ServiceWeb2.war is already including log4j-1.2.16.jar.
   sometime, <TOMCAT> is includng different j2ee API libs. 
   If this is the case and ServiceWeb2 isn't compatible with the j2ee API libs inside TOMCAT, 
   please unzip j2ee_libs.jar (jar -xvf j2ee_libs.jar), and copy to <TOMCAT>\endorsed\.
   If there is no dir named <TOMCAT>\endorsed, please create one first,
   and then copy the files.

3. copy the newest ServiceWeb2.war to <TOMCAT>\webapps\
   or you can use the TOMCAT administrator manager to deploy ServiceWeb2.war

4. start TOMCAT : <TOMCAT>\bin\startup.bat


######################################################
#JBoss deployment

1. remove the old ServiceWeb2.war and related files.

2. copy ServiceWeb2.war to <JBOSS 4>\server\default\deploy\
   or copy ServiceWeb2.war to <JBOSS 5>\server\default\deploy\
   or copy ServiceWeb2.war to <BOSS 7>\standalone\deployments\
   or you can JBOSS administrator manager to deploy ServiceWeb2.war

3. start JBOSS : <JBOSS>\bin\run.bat


######################################################
#WebSphere deployment

1. download IBM WebSphere 8.5.5 package

2. get ready for installation on windows system

3. deployment under IBM WAS-8.55 under windows platform (win7)

3.0. use full-size (all denpendencies) of E2VaultWS.war;

3.1. install IBM installation manager;
3.2. via IBM installation manager, install WAS 8.55
3.3. after installation done, you can see "all programs" 
-> "IBM websphere" 
-> "IBM websphere application server v8.55" 
-> information center
   online support
   WebSphere Customization Toolbox
   profiles
   Tools 
   Tools -> Configuration Migration Tool
   Tools -> Profile Management Tool

3.4. run "WebSphere Customization Toolbox"
3.4.1. choose Profile Management Tool
3.4.2. click Create button
3.4.3. choose "Application Server"
3.4.4. click Next
3.4.5. choose "Typical profile creation"
3.4.6. click Next
3.4.7. uncheck Enable administrative security
3.4.8. click Next, review below parameters:

      location; (i.e. C:\Program Files (x86)\IBM\WebSphere\AppServer\profiles\AppSrv04 )
      disk sapce; (i.e. 200mb)

      profile name; (i.e. AppSvr04 )
      make this profile the default; (i.e. false)
      performance tuning settings; (i.e. standard )

      node name; (i.e. mymachine-node04)
      server name; (i.e. server1)
      host name; (i.e. mymachine.mydoname.com)

      deploy the administrative console (recommended); (i.e. true)
      deploy the default application; (i.e. true)
      deploy the installation verification tool application; (i.e. true)

      enable administrative security (recommended);(i.e.true)
      
      administrative console port; (i.e. 9063)
      administrative console secure port; (i.e. 9046)
      HTTP transport port; (i.e. 9083)
      HTTP transport port; (i.e. 9446)
      Bootstrap port; (i.e. 2812)
      SOAP connector port;  (i.e. 8883)

      run application server as service; (i.e. true)

      create a web server definition; (i.e. false)

3.4.9. click Create (waiting for some time)

3.4.10. getting a window of "Profile Creation complete":
      The Profile Management Tool created the profile successfully.
      check/not-check "Launch the first steps console".

      click Finish

3.4.11. if check "Launch the first steps console", 
      then a window of "Websphere application server - first steps - AppSvr04" will show up.

      you can do below operations, or you can fellow step3.3 -> profiles -> AppSvr04-> ...

3.4.12. after starting AppSvr04 (as administrator), running Administrative Console (as administrator)

3.5. install/uninstall, start/stop web-application from above Administrative Console.
   after running Administrative Console (i.e. http://localhost:9060/ibm/console), you will see a web interface.

3.5.1. click Application 
   -> New Application 
   -> New Enterprise Application 
   -> choose "Local file system" 
   -> Browser -> choose your web-application (i.e. ServiceWeb2.war) 
   -> click Next
   -> choose " Fast Path - Prompt only when additional information is required. " 
   -> click next
   -> click Next
   -> check "ServiceWeb2.war ......"
   -> click Next
   -> check "ServiceWeb2.war"
   -> click Next
   -> input "Context Root" : /ServiceWeb2
   -> click Next
   -> click Next
   -> click Finish

   you will see a page:
   ......
   Application ServiceWeb2_war installed successfully. 
   ...
   ->click Save

3.5.2. Application -> Application-Types -> Websphere enterprise applications, you will see ServiceWeb2_war is installed.
   -> check "ServiceWeb2_war"
   -> click Start

   after some time, you will see ServiceWeb2_war started.



######################################################
# test for log4j lib under different web-servers
#

  web-server  <======> SW2.war with log4j, can-work <==========> SW2.war no log4j, can-work

TOMCAT-6.0.23 <==========> loading OK,     YES      <==========> endorsed\log4j-1.2.16.jar, YES
TOMCAT-7.0.12 <==========> loading OK,     YES      <==========> endorsed\log4j-1.2.16.jar, YES
TOMCAT-7.0.40 <==========> loading OK,     YES      <==========> endorsed\log4j-1.2.16.jar, YES

JBOSS-4.2.1   <==========> loading errors, YES      <==========> no need to copy,           YES
JBOSS-5.1.0   <==========> loading error,  YES      <==========> no need to copy,           YES
JBOSS-7.0.2   <==========> loading OK,     YES      <==========> endorsed\log4j-1.2.16.jar, YES
JBOSS-7.1.1   <==========> loading OK,     YEs      <==========> endorsed\log4j-1.2.16.jar, YES

Websphere 8.5 <==========> loading OK,     YES      <==========> java\jre\lib\endorsed\log4j-1.2.16.jar , YES 

Configuring Serviceweb2.war (TOMCAT)

(1) Make sure that you have JRE 7 (or higher) installed
(2) Download and setup Apache Tomcat 8
(3) Deploy ServiceWeb2.war to your running Tomcat 8 instance

If using the Tomcat Manager application to deploy, deploy the WAR file
as follows:

    Context Path:        /ServiceWeb2
    XML Configuration file URL:    C:\ServiceWeb2.xml
    WAR or Directory URL:    C:\ServiceWeb2.war

By default, the ServiceWeb2 web application assumes that a Rendering
engine is already running on the current host system (localhost) on the
default Rendering engine port (6003).

If your Rendering engine is running on another host and/or a
non-standard port, then deploy the ServiceWeb2 application passing it
the following Context Parameters that will allow it to talk your
Rendering engine:

    Param name        Param value
    ===========================
    hostname        hostname of the Rendering engine (e.g. somehost.somedomain.com)
    port        port #   of the Rendering engine (e.g. 8003)

The context parameters have to be specified in an XML file
(e.g. ServiceWeb2.xml) as follows:

    <Context>
        <Parameter name="hostname" value="somehost.somedomain.com" override="false"/>
        <Parameter name="port" value="8003" override="false"/>
    </Context>

where the "value" attribute of the Parameter element should be set to
the desired value for the configuration parameter being set. Note that
for the Apache Tomcat 6.0.x app server, the "override" attribute must be
present and set to the value "false" when a context parameter is being
specified at deployment time.

Once correctly configured and deployed as per above, the Service Web
application is available at:

    http://localhost:8080/ServiceWeb2/Interface

Configuration/Context parameters
================================

The following is a list of the configuration (i.e. context) parameters
for the ServiceWeb2 application:

- hostname

  The hostname for the Rendering Engine that the ServiceWeb2 application
  will connect to. Defaults to "localhost".


- port

  The port number for the Rendering Engine that the ServiceWeb2
  application will connect to. Defaults to 6003.


-- needlogin 
  a flag of needing login or not.
  the default value is 0, which means no need to login.
  if set up as 1, then a login page will show up;
  user/password will be "admin/admin"


-- user_password
  the list of user names and passwords, the format is user=password;
  the default value is admin=admin, guest=guest


- forcepdf

  If set to true, all documents viewed in the browser interface will be
  rendered to and displayed as PDF. Defaults to false.


- maxresults

  The maximum number of search results to display. Defaults to 20.


- outputformat

  The image output format to which documents are rendered to for
  display in the browser interface. Defaults to GIF.
  Valid values are GIF or PNG.


- autosearchdates

  If set to true, automatically search and display all dates under the
  selected account (instead of rendering the first document under that
  account). Defaults to false.


- log4jconfigfile

  If non-null, use this absolute file path (on the same filesystem as
  the app server) as the Log4j configuration file. Defaults to null
  (i.e. unspecified).


- ssltruststorepath

  If non-null, use this as the SSL truststore for verifying the
  identity of the SSL-enabled Rendering Engine that the ServiceWeb2
  application will connect to. If this parameter is specified, then
  the ssltruststorepassword must also be specified.


- ssltruststorepassword

  If non-null, use this as the password to access the SSL truststore
  for verifying the identity of the SSL-enabled Rendering Engine that
  the ServiceWeb2 application will connect to. If this parameter is
  specified, then the ssltruststorepath must also be specified.




Setting up the SSL truststore for connecting to an SSL-enabled Rendering Engine
===============================================================================

The procedure for setting up a SSL truststore to use when connecting to
an SSL-enabled Rendering Engine is identical to the procedure used when
using the Vault Java Rendering API. Please consult the relevant
section in the "Customizing Vault Guide" for more details on how to do
this.




Logging
=======

The ServiceWeb2 application uses Log4j. By default, Log4j is initialized
using a default XML configuration file that's present inside
ServiceWeb2.WAR (in the WEB-INF/classes/log4jConfig.xml folder) and log
output will be written to:

    ${catalina.home}/logs/e2ServiceWeb2.log

To change this log file and/or to modify the logging configuration,
deploy the ServiceWeb2 application with the "log4jconfigfile" context
parameter set to the absolute path of your Log4j XML configuration
file e.g.:

    <Context>
        <Parameter name="log4jconfigfile" value="D:\e2-ServiceWeb2\myLog4jConfig.xml" override="false"/>
    </Context>


Browsers
=========
When display Vault document data, you can use IE and other browsers (i.e. FireFox, ...).
when display the collection format of .MHT, it is OK to use IE to display .MHT, 
but when using FireFox, you need some add-ons to display .MHT correctly. 
Please refer https://addons.mozilla.org/en-us/firefox/addon/unmht/

Environment Details

All supported environments, Windows, Linux, AIX

Downloads

  • No Downloads