Installing KCM

This section describes the steps that you must take to execute basic KCM installation on a single machine.

You can find the Install.exe installation tool in the InstallServer folder of the KCM installation package.

How the tool works

Here is what happens when you run Install.exe:

  1. It checks the requirements needed for the installation.
  2. It configures the internal host name, the services account, the web services account, the ports, the Java installation, the Tomcat installation, and the certificates for the KCM installation.
  3. It installs a Contract Manager, a KCM instance ready for use, and, optionally, Batch & Output Management and/or KCM Control Center.

    If required, you can append additional KCM instances later, as described in the Instance installation section of this guide.

  4. The KCM instance is registered on the Contract Manager with the default contract:
    • Partner set to CCM

    • Customer set to Local

  5. All components are started automatically.

Execution steps

To perform basic installation, you should execute the following steps:

  1. Open the command line interface (CLI). It could be PowerShell or Command Prompt.

  2. In the CLI navigate to the InstallServer folder of the KCM setup package.

  3. Call the Install.exe file and provide the necessary parameters. The order of parameters is irrelevant. See an example of the call below:

    Install.exe Deploy!RootPath=D:\ Services!User=.\ccm Services!Password=testpassword WebServer!ServiceUser=.\ccm WebServer!ServicePassword=testpassword ContractManager!UseAuthentication=false PublicCertificate!KeystoreFile=c:\ccmsqa\ssl\public.p12 PublicCertificate!KeystorePassword=TESTPSWRD Instance!DatabaseType=SQLServer Instance!DatabaseConnectionString="Driver=SQL Server;Server=SomeServer;Database=KCM_01_5.8" Instance!DatabaseUser=ccm Instance!DatabasePassword=testpassword Instance!LicenseFile="c:\ccmsqa\lics\Your License File.xml" Instance!DesignerAdministratorAccountPassword=09876543210987654321 Registration!ExampleWebAppName=start Instance!ExampleProject=true ContractManager!UseLDAP=false Instance!NumberOfDPs=5 Instance!ContinueInstallationOnFailedDatabaseCheck=true Registration!UseExampleWebApp=True OutputManagement!Install=true OutputManagement!RepositoryDatabaseConnectionString="Server=SomeServer;Database=KCM_OM_5.8" OutputManagement!RepositoryDatabaseType=SQLServer OutputManagement!RepositoryDatabaseUser=ccm OutputManagement!RepositoryDatabasePassword=testpassword OutputManagement!RuntimeDatabaseConnectionString="Server=SomeServer;Database=KCM_OM_RT_5.8" OutputManagement!RuntimeDatabaseType=SQLServer OutputManagement!RuntimeDatabaseUser=ccm OutputManagement!RuntimeDatabasePassword=testpassword InternalCertificate!KeystoreFile=c:\ccmsqa\ssl\internal.p12 InternalCertificate!KeystorePassword=TESTPSWRD InternalCertificate!Thumbprint=ABCDEF0123456789ABCDEF0123456789ABCDEF01

    To simplify input, you can create a script with the required parameter values and then use it to run Install.exe.

    If everything is correct, the installation will run without errors. You will be able to follow the installation process by reading the CLI output.

    If the installation fails, use the Uninstall.exe tool described in the Uninstall KCM from a single machine section of this guide to remove the unfinished KCM deployment.

  4. Test your installation if necessary.

Troubleshooting

If the start operation fails during upgrade, we recommend that you follow the steps below:

  1. Open the corresponding log file located in the <setup package>\InstallServer\Logs folder.

  2. Start the component using the parameters and values specified in the log file.