Skip to main content
Kofax

Example web application missing after installation

Article # 3035796 - Page views: 10

Issue

After installing Kofax Communications manager, KCM for short, the example web application is missing. You receive a HTTP 404 error when accessing the URL http://<hostname>:8081/start/home.html or https://<hostname>/start/home if you installed with HTTPS/SSL. The services manager (services.msc) shows that Apache Tomcat CCMRuntime is started (KCM 5.4 and earlier or that the service Apache Tomcat KCMRuntime is started (KCM 5.5 and later).

 

Cause

From Kofax CCM 5.1, the example web application is not installed by default. To install the example web application, you must use the deployment parameter:

  • ExampleWebApp!install=true for KCM 5.4 and earlier.
  • Registration!ExampleWebAppName=<app name> for KCM 5.5 and later

This deployment parameter is also used when adding an instance.

 

Solution

There are multiple possibities for adding the example web application.

Deploy the example web application via a configuration tool

From KCM 5.4 it is possible to deploy the example web application after installation using the configuration tool     "..\KCM\Programs\5.4\Management\ConfigurationTools\AddExampleWebApp.exe".

From KCM 5.5, the location of the configuration tool has been moved to "..\KCM\Programs\<version>\Management\AddExampleWebApp.exe".

Manually deploy the example web application 

When the example web application is manually deployed, it will not be removed when the associated instance is removed. 

  1. Go to the folder where the installation media is extracted: ..\InstallServer\Software\ITPi\
  2. Copy the folder Example to <Tomcat>\Instance-CCMRuntime-<version>\webapps-CM\ 
  3. Rename the folder Example to Start. ( <Tomcat>\Instance-CCMRuntime-<version>\webapps-CM\start )
  4. Open for editing config_<version>.js. in <Tomcat>\Instance-CCMRuntime-<version>\webapps-CM\Start\example\js\ 
  5. Change '%CUSTOMER%' to 'Local' .
  6. Restart Apache Tomcat CCMRuntime
  7. Open CCM Designer and import the export ..\InstallServer\Software\ITPi\reference.mdk as InstallationTest.

Note if you use a non-standard contract (CCM, Local), then you can enter a different partner/customer in the config_<version>.js file.

Reinstall KCCM 

Uninstall KCCM. Please refer to the installation guide Chapter Uninstallation for instructions for how to uninstall KCCM.
    .\uninstall.ps1 database!user=... database!password=...

Install KCCM again. This time add the additional deployment parameter ExampleWebApp!install=true
    .\install.ps1 Database!Prefix=.. .. .. ExampleWebApp!Install=true

Reinstall the instance 

Remove instance 1. Please refer to the installation guide Chapter 'Remove specific instances' for instructions for how to uninstall an instance.
    .\Removeinstance.ps1 Instance!Number=... database!user=... database!password=...

Add instance 1 again. This time add the additional deployment parameter ExampleWebApp!install=true
    .\AddInstance.ps1 Instance!Number=1.. .. .. ExampleWebApp!Install=true

Level of Complexity 

Moderate

 

Applies to  

Product Version Build Environment Hardware
Kofax Communications Manager 5.1 and newer n/a n/a n/a

 

  • Was this article helpful?