Skip to main content
Kofax

Change the license of KCM

Goal

This article describes how you can change the licenses for KCM. After following this article you have successfully replaced the license for KCM.

Prequisites

  • You need local administrator access to the KCM machine.
  • You need the new license XML file(s).

Identify the license XML files

There are 2 type of license XML files.

  • The main license XML file for KCM. The main license XML file is required for KCM. KCM will not function without this license.
  • The license XML file for DID development. The DID development license is only required for creating DIDs in Designer. It is not required for using created DIDs.

 

The main license XML file has the following structure:

<?xml version="1.0" encoding="UTF-8"?>
<ccm:Licence Version="1" xmlns:ccm="http://www.aia-itp.com/licence">
    <ccm:Product Name="ITP Server" Product="CCM Core">
        <ccm:SubLicence Type="Base" Product="Base">
            <ccm:CompanyName>Kofax</ccm:CompanyName>
            <ccm:NumberOfDocumentProcessors>0</ccm:NumberOfDocumentProcessors>
            <ccm:ExpirationDate>20201231</ccm:ExpirationDate>
            <ccm:Certificate>0000000000</ccm:Certificate>
            <ccm:Environment>Development and Test</ccm:Environment>
            <ccm:LicenceCode>AAAAA-AAAAA-AAAAA-AAAAA-AAAAA-A</ccm:LicenceCode>
        </ccm:SubLicence>
        <ccm:SubLicence Type="OnLine" Product="CCM ComposerUI">
            <ccm:ExpirationDate>20210117</ccm:ExpirationDate>
            <ccm:Certificate>0000032939-1</ccm:Certificate>
            <ccm:NumberOfUsers>250</ccm:NumberOfUsers>
            <ccm:LicenceCode>AAAAA-AAAAA-AAAAA-AAAAA-AAAAA-A</ccm:LicenceCode>
        </ccm:SubLicence>
    </ccm:Product>
    <ccm:Product Name="ITP MDK Repository" Product="CCM Repository">
        <ccm:SubLicence Type="Base" Product="Base">
            <ccm:CompanyName>Kofax</ccm:CompanyName>
            <ccm:ExpirationDate>20201231</ccm:ExpirationDate>
            <ccm:Certificate>0000000000</ccm:Certificate>
            <ccm:Environment>Development or Test</ccm:Environment>
            <ccm:NumberOfUsers>1</ccm:NumberOfUsers>
            <ccm:LicenceCode>AAAAA-AAAAA-AAAAA-AAAAA-AAAAA-A</ccm:LicenceCode>
        </ccm:SubLicence>
        <ccm:SubLicence Type="Model Developer" Product="Model Developers">
            <ccm:CompanyName>Kofax</ccm:CompanyName>
            <ccm:ExpirationDate>20201231</ccm:ExpirationDate>
            <ccm:Certificate>0000000000-2</ccm:Certificate>
            <ccm:Environment>Development or Test</ccm:Environment>
            <ccm:NumberOfUsers>999999</ccm:NumberOfUsers>
            <ccm:LicenceCode>AAAAA-AAAAA-AAAAA-AAAAA-AAAAA-A</ccm:LicenceCode>
        </ccm:SubLicence>
        <ccm:SubLicence Type="Textblock Editor" Product="Textblock Editor">
            <ccm:CompanyName>Kofax</ccm:CompanyName>
            <ccm:ExpirationDate>20201231</ccm:ExpirationDate>
            <ccm:Certificate>0000000000-3</ccm:Certificate>
            <ccm:Environment>Development or Test</ccm:Environment>
            <ccm:NumberOfUsers>999999</ccm:NumberOfUsers>
            <ccm:LicenceCode>AAAAA-AAAAA-AAAAA-AAAAA-AAAAA-A</ccm:LicenceCode>
        </ccm:SubLicence>
    </ccm:Product>
</ccm:Licence>

 

The DID license XML file has the following structure:

<?xml version="1.0" encoding="UTF-8"?>
<ccm:License xmlns:ccm="http://wwww.aia-itp.com/licence" Version="1">
    <ccm:Product Name="ITP Legacy Licence">
        <ccm:SubLicense Type="ITP SDK/MP">
            <ccm:CompanyName>Kofax</ccm:CompanyName>
            <ccm:NumberOfUnits>0</ccm:NumberOfUnits>
            <ccm:ExpirationDate>20201231</ccm:ExpirationDate>
            <ccm:Environment>Development and Test</ccm:Environment>
            <ccm:Certificate/>
            <ccm:LicenseCode>AAAAA-AAAAA-AAAAA-AAAAA-AAAAA-A</ccm:LicenseCode>
        </ccm:SubLicense>
    </ccm:Product>
</ccm:License>

 

Replace the main KCM license

KCM 5.5 and newer

For KCM 5.5 and newer, the main KCM license can be replaced using the SetInstanceLicense tool. To Replace the license:

  1. Open command prompt as administrator.
  2. Navigate to ..KCM\Programs\<version>\Management\Instance
  3. SetInstanceLicense.exe instance!number=<instance number> instance!licensefile=<path to license XML file>
    where instance!number is the instance for which the license must be replaced

For example if the instance number is 1 and the license XML file is located at c:\temp\license.xml:
SetInstanceLicense.exe instance!number=1 instance!licensefile=c:\temp\license.xml

KCM 5.4 and earlier

For KCM 5.4 and earlier, the main KCM license can be replaced using the ConfigureInstance tool. This tool replaces the licenses of all instances. To replace the license:

  1. Open command prompt as administrator.
  2. Navigate to ..\KCM\Programs\<version>\ITP Server\bin
  3. ConfigureInstance.exe /ReplaceLicense /version=<version> /file=<path to license XML file>

For example if the KCM version is 5.4 and the license XML file is located at c:\temp\license.xml:
ConfigureInstance.exe /ReplaceLicense /version=5.4 /file=C:\temp\license.xml

Replace the DID development license

KCM 5.5 and newer

For KCM 5.5 and newer, the DID development license can be replaced using the SetInstanceLicense tool. To Replace the license:

  1. Open command prompt as administrator.
  2. Navigate to ..KCM\Programs\<version>\Management\Instance
  3. SetInstanceLicense.exe instance!number=<instance number> instance!licensefile=<path to license XML file>
    where instance!number is the instance for which the license must be replaced

For example if the license of instane 1 must be replaced and the license XML file is located at c:\temp\license.xml:
SetInstanceLicense.exe instance!number=1 instance!licensefile=c:\temp\license.xml

KCM 5.4 and earlier

For KCM 5.4 and earlier, the DID development can only be replaced with Designer for Windows.

  1. Open Designer for Windows.
  2. Log in with an user who has "log in as administrator" permission.
  3. Go to menu File -> Log in as administrator.
  4. Log in with an user who has "log in as administrator" permission.
  5. Go to menu View -> License...
  6. Click on 'Edit' for the item DID development (SDK/MP) license.
  7. Enter the license details and close all dialog windows. In the license dialog window the following details must be entered.
    1. Company name: Enter the value from the element CompanyName in the DID license XML.
    2. Expiration Date: Enter the value from the element ExpirationDate in the DID license XML.
    3. Key: Enter the value from the element LicenseCode in the DID license XML.
  8. After closing the dialog windows, the license is immediately in use.
  • Was this article helpful?