Configure KTA to connect to Kofax Clarity via proxy

Issue

What considerations are required for configuring KTA to connect to Kofax Clarity via a proxy server?

Solution

It is not a requirement to operate KTA via a proxy server. And as such, the information provided in this document is meant to provide general guidance only.

There may be other considerations which you may need to discuss with your local IT team.

Below you will find general guidance on the considerations to be given to the configuration in order to facilitate the communications.  

 

1. Whitelist the following URL's on the proxy:

https://licenseapi.kofax.com/Service.svc

https://www.googleapis.com/oauth2/v4/token

https://vision.googleapis.com/v1/images:annotate

2. Setup Transformation Service & Clarity extraction to use proxy

a) Add adapted system.net section similar to below to both config files

For Transformation Designer (if installed): C:\Program Files (x86)\Kofax\TotalAgility\Transformation Designer\Kofax.ProjectBuilder.exe

For Transformation Server: C:\Program Files\Kofax\TotalAgility\Transformation Server\Kofax.CEBPM.CPUServer.ServiceHost.exe.config

     (This Transformation Server config file is copied and used by the spawned ExtractionProcess.exe)

     <system.net>

           <defaultProxy enabled="True" useDefaultCredentials="True">

                <proxy bypassonlocal="false" proxyaddress="http://proxy.domain.com:8080" />

                <bypasslist>

                     <add address="127\.0\.0\.1" />

                     <add address="localhost" />

                     <add address="10\.\d{1,3}\.\d{1,3}\.\d{1,3}" />

                     <add address="172\.16\.\d{1,3}\.\d{1,3}" />

                </bypasslist>

           </defaultProxy>

     </system.net>

 

Note: This was added between the </exceptionHandling> and <unity… tags.

* Adapt the proxy address attribute as appropriate for the proxy.

* Adapt bypass list addresses entries as required. You will need to ensure access to other KTA servers bypass the proxy.

* Address attribute values need to be regular expression type format, e.g. periods need to be escaped to \.

b) Add *system* environment variable:

           Variable Name = HTTPS_PROXY

           Value = http://proxy.domain.com:8080

     Adapt value as appropriate for the proxy.

     (If required adapt the values for the HTTP_PROXY system environment variable similarly.)

 

3. Restart the transformation service and IISRESET.

4. Test runtime Clarity extraction.

Note: In an environment where there are multiple Transformation Servers you will need to configure each Transformation Server as required.

Level of Complexity 

 Moderate

 

Applies to  

Product	Version	Build	Environment	Hardware
KTA	7.8+

References

Add any references to other internal or external articles

 

Article # 3040481