Skip to main content
Kofax

Using the Kofax License Utility (KSALicenseUtility.exe) with KTA

3018450

Question / Problem: 

How can the Kofax License Utility (KSALicenseUtility.exe) be enabled for use on a Kofax TotalAgility system?

Answer / Solution: 

When troubleshooting certain licensing issues, it may be necessary to use the Kofax License Utility (KSALicenseUtility.exe).  However, when first run on a KTA system, it will show the following error:

KSALicenseUtility-VerifyTheRegistryKey.png
[7011] SALicClnt: The License Server cannot be found. Verify the registry key.

Enabling the utility

  • Download EnableLicenseUtility.zip
  • Extract the zip file to C:\ProgramData\Kofax\KSALic\Config\
  • Import SALicClient.reg
  • If needed:
    • Edit SALConfig.xml to replace localhost with the address of the license server
    • Edit SALConfig.xml to replace 3581 with the port of the license server
  • The license utility is now usable

For more detailed explanations, see the following sections.

Running the utility

  • The steps to enable the utility need to be performed on any system that needs to run it.
  • The utility can be opened from the following path on a KTA App server:
    • C:\Program Files\Kofax\TotalAgility\Licensing\KSALicenseUtility.exe
  • The utility can be run from any system by copying the following folder from the KTA install source: \TotalAgility\Licensing\SDK\Client
  • The Connected Stations tab shows information that is not visible in KTA’s License Statistics, and can be useful in troubleshooting certain license issues.

KSALicenseUtility-ConnectedStations.png

Additional Details

Registry

SALicClient.reg contains the following registry entry.  This points to the folder that will contain SALConfig.xml.

Windows Registry Editor Version 5.00

[HKEY_LOCAL_MACHINE\SOFTWARE\Kofax\SALicClient]
"SharedLicenseServerFileUnc"="C:\\ProgramData\\Kofax\\KSALic\\Config\\"

Note that if this key is not present, the license utility will fall back to looking in the 32-bit location:
HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Kofax\SALicClient

XML

SALConfig.xml needs to be in whichever folder is specified in the registry key, and contains the following:

<?xml version="1.0" encoding="utf-8"?>
<licensing>
  <servers>
    <server port="3581" isEnterprise="False">localhost</server>
  </servers>
  <opts>
    <delaySeconds>30</delaySeconds>
    <totalTimeoutSeconds>300</totalTimeoutSeconds>
    <useDefaultWebProxy>False</useDefaultWebProxy>
    <remoteSite>False</remoteSite>
  </opts>
</licensing>

Note that by default the file specifies a license server on localhost with the default port of 3581, but this can be edited to match the environment.

Applies to:  

Product Version
KTA ALL