Tutorial: Document Capture Server Configuration

Document Capture Server Configuration

This section covers documents to Kofax Import Connector.

Connect to KIC

These instruction are for configuring an application to connect to an existing Kofax Import Connector server.

Extend the KicHandler

  1. Open the web application project in you development environment.
  2. Add a generic handler to the project.
  3. Extend the handler that was just created with the KicHandler found in the Atalasoft.dotImage.WebControls.Capture namespace in the Atalasoft.dotImage.WebControls assembly.
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;

namespace TheApplicationNamespace
{
    public class MyKicHandler : KicHandler
    {

    }
}

Configure KicHandler

Add the KIC endpoints to web.config

To connect to Kofax Import Connector a WCF endpoint, a binding must be added to the application’s web.config. In the provided example a standard basicHttpBinding will be used, but other appropriate binding types are possible choices to use as the WCF binding.

<system.serviceModel>
  <client>
    <endpoint address="http://servername.domain.com:[port]/soap/tsl"  binding="basicHttpBinding" bindingConfiguration="importBinding" contract="importPortType" name="importPort" />
  </client>
</system.serviceModel>

Add the bindings to web.config

  • HTTP
<system.serviceModel>
  <bindings>
    <basicHttpBinding>
      <binding name="importBinding" closeTimeout="00:01:00" openTimeout="00:01:00" receiveTimeout="00:10:00" sendTimeout="00:01:00" 
               allowCookies="false" bypassProxyOnLocal="false" hostNameComparisonMode="StrongWildcard" maxBufferSize="1655360"
               maxBufferPoolSize="15242880" maxReceivedMessageSize="1655360" messageEncoding="Text" textEncoding="utf-8" 
               transferMode="Buffered" useDefaultWebProxy="true">
        <readerQuotas maxDepth="32" maxStringContentLength="256000" maxArrayLength="16384" maxBytesPerRead="4096" maxNameTableCharCount="16384" />
        <security mode="None">
          <transport clientCredentialType="None" proxyCredentialType="None" realm="" />
          <message clientCredentialType="UserName" algorithmSuite="Default" />
        </security>
      </binding>
    <basicHttpBinding>
  </bindings>
</system.serviceModel>
  • HTTPS
<system.serviceModel>
  <bindings>
    <basicHttpBinding>
      <binding name="importBinding" closeTimeout="00:01:00" openTimeout="00:01:00" receiveTimeout="00:10:00" sendTimeout="00:01:00" 
               allowCookies="false" bypassProxyOnLocal="false" hostNameComparisonMode="StrongWildcard" maxBufferSize="1655360" 
               maxBufferPoolSize="15242880" maxReceivedMessageSize="1655360" messageEncoding="Text" textEncoding="utf-8"
               transferMode="Buffered" useDefaultWebProxy="true">
        <readerQuotas maxDepth="32" maxStringContentLength="256000" maxArrayLength="16384" maxBytesPerRead="4096" maxNameTableCharCount="16384" />
        <security mode="Transport">
          <transport clientCredentialType="None" proxyCredentialType="None" realm="" />
          <message clientCredentialType="UserName" algorithmSuite="Default" />
        </security>
      </binding>
    <basicHttpBinding>
  </bindings>
</system.serviceModel>

Configure Kofax Import Connector

This is not intended to be a full set of instructions to install, setting up, and maintain a Kofax Import Connector server. The following information provides the minimum amount of configuration needed for the Web Capture Service to successfully connect, and import into Kofax Import Connector.

Required license

For the KIC web server to accept documents imported from the Web Capture Service the license must be installed on your KIC server.

To verify that the correct minimum license has been installed go to the Message Connector Monitor, which by default is located on the KIC server at https://localhost:25086/file/index.html under the Status -> license section.

Configure the web service

The Web Capture Service connects via KIC’s web service via a server-side handler that extends the KicHandler found in the Atalasoft.dotImage.WebControls assembly.

Once in the message connector, go to the “General” section, and verify that

  1. From the App Programs list, select Kofax > KIC Electronic Documents > Message Connector Configuration. The message connector opens.
  2. In the General section, verify the Own Computer Name is filled in with the current server’s domain qualified name.
  3. Next, go to the Web-Service Input section.
    • If only a HTTP based connection is desired set the HTTPS port to 0. This will be the port which the endpoint in the application's will point to. If HTTPS is desired, then enter the port which will be used.
    • If HTTPS is enabled the HTTP port will not be able to be connected to, and the endpoint in the application's will need to point at the URL using the HTTPS port.
  4. Once all of the desired changes to the KIC Message Connector have been made save, and restart the Message Connector service.

Configure the Electronic Documents plugin

In the Kofax Capture (KC) Administration application, open the 'Electronic Documents -> Configuration' window, and configure the necessary Connections, and Destinations.

When finished, stop and start the service.

Test the configuration

To test that the KIC server has been minimally configured correctly in a browser either on the server, or at a client that might connect to the server enter the following URLs:

  • HTTP enabled webservice
http://[kic_servername]:[http_port]/soap/tsl/Import?<OwnerReference>myref</OwnerReference><Address>importaddr</Address><Part><ContentType>text/plain</ContentType>    <Content><Text>hello</Text></Content></Part>
  • HTTPS enabled webservice
https://[kic_servername]:[https_port]/soap/tsl/Import?<OwnerReference>myref</OwnerReference><Address>importaddr</Address><Part><ContentType>text/plain</ContentType>    <Content><Text>hello</Text></Content></Part>