Skip to main content
Kofax

Quick Start Guide (Deploying Kapplets in a standalone Tomcat Server)

3024021

Summary

Starting with version 11, Kapplets can be deployed  on a standalone Tomcat server. This is not possible with Kapplets version 10.x and earlier.

There are multiple ways to accomplish this; this article contains one method. For the purpose of this example, we'll use Tomcat 8.5 on Windows installed as a service.

Procedure

Management Console and Kapplets can be installed in the same Tomcat or in different environments. (e.g. : MC and Kapplets both deployed in Tomcat but in two different Tomcat services on the same machine or different machines. Or Management Console in embedded mode and Kapplets deployed into Tomcat).

To see the similar article for deploying Management Console in standalone Tomcat, see Knowledgebase article #12398.

  1. Prerequisites:
    • Java installed download - at least jre (e.g. from oracle.com)
    • Tomcat Windows Service installer download (from the Apache downloads page)
    • If deploying Kapplets - Database for the Kapplets  tables. Tomcat will need to be able to create tables in this database.
      If the user provided for it doesn't have rights to create tables, a DBA will have to create them in advance.
      The scripts to create tables are in the Kofax RPA (Kapow) installation folder under the documentation -> sql folder. The tables from the following folders should be created:
      • kapplets

If the user has rights to create tables, an empty database is enough.

If deploying Management Console and Kapplets in Tomcat (either same service or difference service) Management Console and Kapplets each need a database. You cannot use the same database for both applications.

  • JDBC driver for the database type.

    Check the version of

    • Java
    • Tomcat
    • Database
    • Operating System

     

    currently supported by Kofax RPA (Kapow) in the Technical Specifications file (from the User Guides section).

  1. Java Configuration
    • Install Java.
    • Configure JRE_HOME using the Environment Variables  window or by using the set command
      E.g.

      set JRE_HOME=C:\Program Files\Java\jre1.8.0_101
       
  2. Tomcat basic configuration
    • Install Tomcat and follow the prompts.
    • If needed, change the tomcat ports in server.xml
    • If needed, start the "Configure Tomcat" application and change the memory settings for Java.

      clipboard_e9ad241d659607f5aa4df8f91415759be.png
       
    • Start the Tomcat service to verify that Tomcat can be reached (by default Tomcat's url is http://localhost:8080)
       

      Steps from sections 2 and 3 are the general steps to install and configure Tomcat. For more specific details, please consult the Apache documentation.

  3. Deployment of Kapplets - expand war file
    • Stop the Tomcat service if it's running
    • Copy the kapplets.war file from <Kofax RPA installation folder>\WebApps to <Tomcat installation folder>\webapps

      E.g. from C:\Program Files\Kofax RPA 11.0.0.0 173 x64\WebApps to C:\Program Files\Apache Software Foundation\Tomcat 8.5_Tomcat8_kapplets\webapps
       
    • Start the Tomcat service
      Tomcat will expand the .war file but it won't be able to use it (configuration will be done in the next section) so ignore all errors from log and allow Tomcat at least 5 minutes to complete the task. In the end, the webapps folder under Tomcat will have a kapplets folder with content similar to:

      clipboard_e766fbe05d4e211cbdf550bcf41cb64f7.png
  4. Deployment of Kapplets - configuration
    • Stop the Tomcat service
    • Copy the JDBC .jar driver file into <Tomcat installation folder>\lib
    • Create the kapplets.xml context file in <Tomcat installation folder>\conf\Catalina\localhost with this content

      "kapplets" is case sensitive. the XML file name has to match the .war file name and application name from under the \webapps folder.

       

       <Context useHttpOnly="true">

              <!-- Default set of monitored resources -->

              <WatchedResource>WEB-INF/web.xml</WatchedResource>

              <Resource name="jdbc/kapow/kapplets" auth="Container" type="javax.sql.DataSource"

               maxActive="100" maxIdle="30" maxWait="-1"

              username="UserToAccessDB" password="PasswordForPreviousUser"

              driverClassName="Driver Class Name for your Database Type"

                      validationQuery="Validation Query for your Database Type" testOnBorrow="true"

                     url="URL Connection String for your Database Type"/>
      <Environment name="spring.datasource.jndi-name" value="jdbc/kapow/kapplets"   type="java.lang.String" override="false"/>         
       <Environment name="spring.jpa.database-platform" value="DB Server Dialect here"  type="java.lang.String" override="false"/>         
       <Environment name="kapplets.services.mc.connection.url" value="Management Console URL here"   type="java.lang.String" override="false"/>         
       <Environment name="kapplets.services.mc.connection.username" value="MC User here"   type="java.lang.String" override="false"/>         
       <Environment name="kapplets.services.mc.connection.password" value="password for MC User"   type="java.lang.String" override="false"/>

          </Context>

      See attached a few examples of context file for the Kapplets application that use different database types.

      kapplets_MSSQL.xml

      kapplets_mySQL.xml

    • Restart the Tomcat service. If all settings are correct, the Kapplets application will reach to the database, create tables in it and start using them.
    • Test kapplets by loading this url (replace hostname and port if needed)

      http://localhost:8080/kapplets

      "kapplets" is case sensitive. Therefore

      • kapplets.war from under the \webapps folder
      • kapplets folder from under \webapps folder
      • kapplets.xml from under \conf\Catalina\localhost folder
      • the url http://localhost:8080/kapplets

      have to use the same case!

      A successful deployment means the website is prompting for login (use admin/admin).
      If the website is throwing an error, at least one of the configuration settings is not correct. In this case, check the Tomcat stdout and strerr log files (from <Tomcat installation folder>\logs). The most common error is "Could not connect to the platform database" - see Knowledgebase article 306641.

      More detailed information about the Kapplets deployment can be found in the Installation Guide > Install Kofax RPA > Install on Windows > Install Kapplets

 

 

Applies to:  

Product Version
RPA 11.0 and Later