Overview

Kofax TotalAgility (KTA) is a Smart Process Application (SPA) platform that transforms and simplifies business interactions. Many people thinks Kofax TotalAgility as merely a document capture software but it actually does more than just an OCR software. KTA is an enterprise solution for document management and business process automation platform with OCR is just part of the whole suite.

As in any enterprise-level application, KTA can be easily customized with the provided SDK. This tutorial will show you how to setup a Visual Studio project to create a KTA Web Service in ASP.NET.

Caveat

At this time, you cannot use ASP.NET Core to call KTA SDK. Hopefully this will be addressed in future version.

Requirements

1. Visual Studio (2019 is used for this example)
2. Kofax TotalAgility version 7.7 or later
3. .NET Framework 4.8 (minimum version 4.7)

Steps to Create Visual Studio Project

1. Launch Visual Studio and create a new Project.

   

2. On the Create a new project window, select the following settings: C#, Windows, Web. Click Next.

   

3. On the Configure your project screen, type in your Project Name and the Location for your project. Under Framework select .NET Framwework 4.8. Click Create button.

   

4. Select Web API on the Create a new ASP.NET Web Application and click Create button once again.

   

5. Open File Explorer to the project’s bin folder and add the following KTA DLLs. You can copy them from
   C:\Program Files\Kofax\TotalAgility\Agility.Server.Web\bin folder in your KTA installation.

   1. Agility.Sdk.Model.dll
   2. Agility.Server.Common.dll
   3. Agility.Server.Core.dll
   4. Agility.Server.Core.Model.dll
   5. Agility.Server.Integration.Common.dll
   6. TotalAgility.Sdk.dll

   Depending on the need of your application, you may need to copy other DLLs, but I found that this is the minimum you need in order to make it work.

   

6. Next, we want to right-click on References on the right window and click Add Reference… to all the above DLLs. From time to time, you will encounter an error such as ReferenceManagerPackage package did not load correctly. Make sure you take care of that issue first by following these steps.

   

7. Select Browse on the left and click on Browse button.

   

8. Select all the DLLs you just copied from KTA installation by pressing SHIFT-key while clicking on each of them. Click on Add button when done.

   

9. Press OK button. Make sure all the DLLs are added under the References.

   
   

Now you are ready to code KTA Web Service in ASP.NET. Happy coding!

Reference

Kofax Knowledgebase