Skip to main content
Kofax

Install KCM Core Web Services Interface J2EE

Article # 3035087 - Page views: 13

Article # 3035087 - Page views: 13

Issue

You want to install the KCM Core Web Service Interface for J2EE

Solution

The manual misses instructions for installing the KCM Core Web Services interface J2EE. This How-To article describes the steps for installing the KCM Core Web Services interface J2EE. It also describes how to deploy KCM Core WSI J2EE to the same Tomcat instance used for the KCM API (Contract Manager). After following this article the web service will be available via 8081 (HTTP) or 443 (HTTPS).

  1. Navigate to ..\KCM\Programs\<version>\ITP Server\Apis\Web Services J2EE\
  2. For KCM 5.4 and older. Copy itpserver.war to <Tomcat>\instance-CCMRuntime-<version>\webapps
    e.g. C:\Program Files\Apache Software Foundation\Tomcat 9.0\instance-CCMRuntime-5.4\
    For KCM 5.5 and newer. Copy itpserver.war to <Tomcat>\instance-KCMRuntime-<version>\webapps
    e.g. C:\Program Files\Apache Software Foundation\Tomcat 9.0\instance-KCMRuntime-5.5\webapps\
  3. Open elevated command prompt and run in the bin folder of Tomcat, tomcat<version>w.exe to open the configuration of the KCM Runtime instance.
    For example for Tomcat 9:
       <Tomcat>\bin\Tomcat9w.exe //ES/<Tomcat instance name>
    To retrieve the Tomcat instance name, open services.msc and open the properties of the KCM Apache Tomcat service and check the service name (not the display name). When the properties of a service are opened, the service name is already selected. Example:
       C:\Program Files\Apache Software Foundation\Tomcat 9.0\bin\Tomcat9w.exe //ES/Tomcat-KCMRuntime-5.5

    1.png
     
  4. On the tab Java, under Java options add the host/port configuration for KCM Core WSI. This is the host/port of the KCM Core instance.
       -Dcom.aia_itp.wsdl.itpserverhost=<hostname>
       -Dcom.aia_itp.wsdl.itpserverport=<port>

    e.g.
       -Dcom.aia_itp.wsdl.itpserverhost=localhost
       -Dcom.aia_itp.wsdl.itpserverport=3003

    Port 3003 is used by instance 1. To get the port number of an instance use the formula "3001 + (2 x instance number)".

  5. Click Apply and click Ok to close the program. Restart the Tomcat service.

    2.png
     

  6. To retrieve the WSDL use the URL: 
    HTTP:
       http://<hostname>:8081/itpserver/itpserverwrapped.asmx?wsdl
    HTTPS:
       https://<hostname>/itpserver/itpserverwrapped.asmx?wsdl

Further reading

For more information on using the KCM Core WSI, refer to the Core Developer's Guide. The hosted documentation can be accessed via https://docshield.kofax.com/ia-platform.html.

Level of Complexity 

High

 

Applies to  

Product Version Build Environment Hardware
Kofax Customer Communications Manager 4.4, 5.0, 5.1, 5.1.1, 5.2 n/a n/a n/a
Kofax Communications Manager 5.3 or newer n/a n/a n/a

  • Was this article helpful?