Skip to main content
Kofax

Specify the connection string for installing KCM

Article # 3035675 - Page views: 46

Issue

Since Kofax Communications Manager 5.4, KCM 5.4 for short, it is required to specify the database connection string for the connection to the database. This allows for more flexibility when installing KCM for the used Database. This also allows for specific functionality that was not possible before.

Solution

Install KCM with SQL Server with Windows Authentication 

NOTE: All the following examples are for KCM 5.5. For KCM 5.4 the relevant installation parameter is database!connectionstring=<ODBC connection string>

The below examples use the Powershell prompt. In command prompt the multi-line character is ^ (in Powershell it is `  )

In Powershell strings must be enclosed by single quotes.

In Command prompt strings must be enclosed by double quotes. Single quotes are processed as normal text in command prompt.

When specifying the Connection String, you can use Windows Authentication as well. With Windows Authentication, KCM will use the currently logged in user for connecting to the database. After installation the configured service user (services!user=domain\user) is used for connecting to the database.

You can use Windows Authentication by adding the parameter "Trusted_Connection=yes" to the Connection String. When using this additional parameter, you do not need to specify the parameters:

  • Instance!DatabaseUser
  • Instance!DatabasePassword
  • OutputManagement!RepositoryDatabaseUser
  • OutputManagement!RepositoryDatabasePassword
  • OutputManagement!RuntimeDatabaseUser
  • OutputManagement!RuntimeDatabasePassword

An example installation command for KCM 5.5 looks like:

.\Install.exe `
Deploy!RootPath=C:\ `
Instance!DatabaseType='sqlserver' `
Instance!DatabaseConnectionString='Driver={ODBC Driver 17 for SQL Server};Server=localhost;Database=KCM_01_5.5;Trusted_Connection=yes' `
Instance!LicenseFile=C:\installserver\license.xml `
Instance!NumberOfDPs=1 `
Instance!DesignerAdministratorAccountPassword=thispasswordislongenough20characters `
Instance!ExampleProject=true `
Registration!ExampleWebAppName=start `
services!user=domain\user `
services!password=password `
webserver!serviceuser=domain\user `
webserver!servicepassword=password `
contractmanager!useauthentication=false `
ContractManager!UseSSL=True `
ContractManager!keystorefile='C:\Program Files\Apache Software Foundation\Tomcat 9.0\certificates\kcm.pfx' `
ContractManager!keystorepassword=password `
ContractManager!UseLDAP=false

An example installation command for KCM Batch and Output Management (B&OM) 5.5 looks like:

.\InstallOutputManagement.exe `
Deploy!RootPath=C:\ `
services!user=domain\user `
services!password=password `
OutputManagement!Secondary=false `
OutputManagement!DatabaseType=sqlserver `
OutputManagement!RepositoryDatabaseConnectionString='Server=localhost;Database=KCM_OM_5.5;Trusted_Connection=yes;' `
OutputManagement!RuntimeDatabaseConnectionString='Server=localhost;Database=KCM_OM_RT_5.5;Trusted_Connection=yes;' `
Install KCM on a SQL Server with SQL Authentication 

It is also possible to install KCM with SQL authentication enabled. When using SQL Authentication, the login credentials must not be specified in the connection string, but via the installation parameters:

  • Instance!DatabaseUser
  • Instance!DatabasePassword
  • OutputManagement!RepositoryDatabaseUser
  • OutputManagement!RepositoryDatabasePassword
  • OutputManagement!RuntimeDatabaseUser
  • OutputManagement!RuntimeDatabasePassword

An example installation command for KCM 5.5 looks like:

.\Install.exe `
Deploy!RootPath=C:\ `
Instance!DatabaseType='sqlserver' `
Instance!DatabaseUser=DB_User `
Instance!DatabasePassword=DB_Password `
Instance!DatabaseConnectionString='Driver={ODBC Driver 17 for SQL Server};Server=localhost;Database=KCM_01_5.5' `
Instance!LicenseFile=C:\installserver\license.xml `
Instance!NumberOfDPs=1 `
Instance!DesignerAdministratorAccountPassword=thispasswordislongenough20characters `
Instance!ExampleProject=true `
Registration!ExampleWebAppName=start `
services!user=domain\user `
services!password=password `
webserver!serviceuser=domain\user `
webserver!servicepassword=password `
contractmanager!useauthentication=false `
ContractManager!UseSSL=True `
ContractManager!keystorefile='C:\Program Files\Apache Software Foundation\Tomcat 9.0\certificates\kcm.pfx' `
ContractManager!keystorepassword=password `
ContractManager!UseLDAP=false
Use a DSN (Data Source Name) for installing KCM Repository Server 

Instead of specifying the database server, port, instance and name directly in the Connection String during installation of KCM, you can instead use a Data Source Name, DSN for short, for the KCM Repository Server (NOT for Batch and Output Managment). The DSN can be configured in the ODBC Data Source Administration (64-bit) in Windows (%windir%\system32\odbcad32.exe). Be aware that only the 64bit version of the odbcad tool can be used, not the 32bit version. The DSN must be added as a System DSN. In the DSN it is required to set 'Change the default database to' to the target KCM Repository database.

For installing with a DSN, you use the parameter "DSN=<DSN Name>" only.

An example installation command for KCM 5.5 with the DSN KCM_DB looks like:

.\Install.exe `
Deploy!RootPath=C:\ `
Instance!DatabaseType='sqlserver' `
Instance!DatabaseConnectionString='DSN=KCM_DB' `
Instance!LicenseFile=C:\installserver\license.xml `
Instance!NumberOfDPs=1 `
Instance!DesignerAdministratorAccountPassword=thispasswordislongenough20characters `
Instance!ExampleProject=true `
Registration!ExampleWebAppName=start `
services!user=domain\user `
services!password=password `
webserver!serviceuser=domain\user `
webserver!servicepassword=password `
contractmanager!useauthentication=false `
ContractManager!UseSSL=True `
ContractManager!keystorefile='C:\Program Files\Apache Software Foundation\Tomcat 9.0\certificates\kcm.pfx' `
ContractManager!keystorepassword=password `
ContractManager!UseLDAP=false

In the above example, the DSN is configured to use Windows Authentication. If it was configured with SQL Authentication, then the following parameters must be specified as well:

  • Instance!DatabaseUser
  • Instance!DatabasePassword

Level of Complexity 

Moderate

 

Applies to  

Product Version Build Environment Hardware
Kofax Communications Manager 5.4 and newer.      

 

  • Was this article helpful?