Skip to main content
Kofax

Install KCM Core Web Services Interface ASP.NET

Article # 3033001 - Page views: 14

3033001

Summary 

The manual misses instructions for installing the KCM Core Web Services interface ASP.NET. This How-To article describes the steps for installing the KCM Core Web Services interface ASP.NET. 

Prerequisites

The following Windows Server features must be installed:

  • NET Framework 4.x Features -> .NET Framework 4.x

The following Windows Server role with features must be installed:

  • Web Server (IIS)
    • Web Server (IIS) -> Web Server -> Application Development -> ASP.NET 4.x (with default options)

Installation

01). Create a folder for hosting the web services interface. For example C:\KCM_Core_WSI
02). Copy the contents of ..\KCM\Programs\<version>\ITP Server\Apis\Web Services\ to the folder of step 1.
03). Open IIS Manager.
04). Fold open Sites.
05). Right-click Default Web Site -> Add Virtual Directory
6a). Enter the Alias. Alias is the site name. http://localhost/<alias>. 
6b). Enter the physical path. Physical path is the folder from step 1. E.g. C:\KCM_Core_WSI. 
Add_Virtual_Directory.png
07). Click Ok to close the dialog
07). Right click the new virtual folder and click Convert to Application.
08). In the 'Add Application' dialog click Select... and select the .NET v4.5 Classic Application pool. Click Ok to close the dialog.
Convert_To_Application.png

Configuration

01). In the folder of KCM Core WSI, open web.config.
02). Optionally change ITPServerHost to the hostname of the KCM machine. This is only required if KCM Core WSI is deployed on a different machine than the KCM machine.
03). Change the key ITPServerPort to the port of the KCM Core instance. To determine the port number, the following formula can be used: 3001 + ( n * 2 ).
E.g. the port for instance 1 is 3001+(2*1)=3003.
04). Change executionTimeout to 3600.
Although not required, it is recommended to uncomment the keys LogFile, MaxLogFileSizeKB, MaxLogCount. This will enable logging. Only the key LogFile must be changed to a location for the log file. It is recommended to configure the logfile in the KCM Core log folder. For example: 
<add key="LogFile" value="D:\KCM\Work\5.5\Instance_01\core\Log\KCM\WSI\itpserverws.log"/>

example configuration:

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <appSettings>
    <add key="ITPServerHost" value="localhost"/>
    <add key="ITPServerPort" value="3003"/>
    <add key="LogFile" value="D:\KCM\Work\5.5\Instance_01\core\Log\KCM\WSI\itpserverws.log"/>
    <add key="MaxLogFileSizeKB" value="1024"/>
    <add key="MaxLogCount" value="10"/>
  </appSettings>
  <system.web>
    <httpRuntime executionTimeout="3600"/>
  </system.web>
</configuration>

Testing

The WSDL of the web service can be retrieved from http://<hostname>/<alias>/itpserverwrapped.asmx?wsdl
For example if kcmcore is used as the alias name.
http://localhost/kcmcore/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.

Applies to:  

Product Version
KCM 5.3 and newer

 

  • Was this article helpful?