Skip to main content
Kofax

Quick Start Guide: Deploying Kapplets in a standalone Tomcat Server

Article # 3035396 - Page views: 207

Issue

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.

Solution

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 Knowledge Base Article #3035405.

1-Prerequisites:
  • Java installed download - at least jre (e.g. from oracle.com) Please make sure to check Technical Specification Document for the version you're using to make sure you're installing a supported JAVA version.
  • 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
Note-Icon.png

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.
    product_documentation_-_user_guides_Important-Icon.png

    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).

2-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
     
3-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.

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

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

4-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:

    Folders.png
5-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. The content of the file has changed in RPA v11.3, please see the Installation Guide for the correct settings.
    product_documentation_-_user_guides_Important-Icon.png

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

     
    Tip-Icon.png

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

    RPA 11.2 and earlier RPA v11.3 and later

    kapplets_MSSQL.xml

    kapplets_mySQL.xml

    kapplets_11.3_MSSQL.xml
    kapplets_11.3_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
    product_documentation_-_user_guides_Important-Icon.png

    "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!

    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 Knowledge Base Article #3035410
    Note-Icon.png

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

NOTE:

In 11.3 Kapplets xml has changed because now we use OAuth to connect MC and Kapplet web app.

Please see Page 40 Tomcat installation from Installation guide which has the new xml syntax.

https://docshield.kofax.com/RPA/en_US/11.3.0_5cdzhlgb3t/print/KofaxRPAInstallationGuide_EN.pdf

Level of Complexity 

Moderate

Applies to  

Product Version Build Environment Hardware
Kofax RPA 11.0 and higher      

References

 

 

Article # 3035396
  • Was this article helpful?