Skip to main content
Kofax

Specify the connection string for installing KCM

Goal

Since KCM 5.4, 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.

 

Install KCM on a SQL Server with Windows Authentication

With earlier versions of KCM, installing KCM could only be done when the SQL Server for the Repository Database had SQL Authentication enabled. When specifying the Connection String, you can now use Windows Authentication as well.

You can do this by adding the parameter "Trusted_Connection=yes" to the Connection String. When using this additional parameter, you do not need to specify the parameters  "Database!User", "Database!Password", "OMRepositoryDB!User", "OMRepositoryDB!Password", "OMRuntimeDB!User" and "OMRuntimeDB!Password". This will use the currently logged in user for connecting to the database.

An example installation command looks like this:

.\Install.ps1 
'deploy!rootpath=D:\' 
database!type='sqlserver'
database!connectionstring='Driver={​ODBC Driver 17 for SQL Server}​;Server=localhost;Database=KCM_01_5.4;Trusted_Connection=yes'
services!user=.\user
services!password='password'
webserver!serviceuser=.\user
webserver!servicepassword='password'
license!file='d:\installserver\license.xml'
contractmanager!useauthentication=false
ContractManager!keystorefile='D:\Tomcat9.0\certificate\kcm54.pfx'
ContractManager!keystorepassword=password
ExampleWebApp!Install=true
instance!numberofdps=1
DesignerAdministratorAccount!Password=thispasswordislongenough20characters
OMRepositoryDB!ConnectionString='Server=localhost;Database=KCM_OM_5.4;Trusted_Connection=yes;'
OMRuntimeDB!ConnectionString='Server=localhost;Database=KCM_OM_RT_5.4;Trusted_Connection=yes;'
outputmanagement!install=true

 

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 "Database!User", "Database!Password", "OMRepositoryDB!User", "OMRepositoryDB!Password", "OMRuntimeDB!User" and "OMRuntimeDB!Password".

An example installation command looks like this:

.\Install.ps1 
'deploy!rootpath=D:\' 
database!type='sqlserver'
database!connectionstring='Driver={​ODBC Driver 17 for SQL Server}​;Server=localhost;Database=KCM_01_5.4'
database!user=user
database!password=password
services!user=.\user
services!password='password'
webserver!serviceuser=.\user
webserver!servicepassword='password'
license!file='d:\installserver\license.xml'
contractmanager!useauthentication=false
ContractManager!keystorefile='D:\Tomcat9.0\certificate\kcm54.pfx'
ContractManager!keystorepassword=password
ExampleWebApp!Install=true
instance!numberofdps=1
DesignerAdministratorAccount!Password=thispasswordislongenough20characters
OMRepositoryDB!ConnectionString='Server=localhost;Database=KCM_OM_5.4'
OMRepositoryDB!User=user
OMRepositoryDB!Password=password
OMRuntimeDB!ConnectionString='Server=localhost;Database=KCM_OM_RT_5.4'
OMRuntimeDB!User=user
OMRuntimeDB!Password=password
outputmanagement!install=true

 

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.

The above example command would change like this (the DSN in this example is called "KCM_DB"):

.\Install.ps1 
'deploy!rootpath=D:\' 
database!type='sqlserver'
database!connectionstring='DSN=KCM_DB'
services!user=.\user
services!password='password'
webserver!serviceuser=.\user
webserver!servicepassword='password'
license!file='d:\installserver\license.xml'
contractmanager!useauthentication=false
ContractManager!keystorefile='D:\Tomcat9.0\certificate\kcm54.pfx'
ContractManager!keystorepassword=password
ExampleWebApp!Install=true
instance!numberofdps=1
DesignerAdministratorAccount!Password=thispasswordislongenough20characters
OMRepositoryDB!ConnectionString='Server=localhost;Database=KCM_OM_5.4;Trusted_Connection=yes;'
OMRuntimeDB!ConnectionString='Server=localhost;Database=KCM_OM_RT_5.4;Trusted_Connection=yes;'
outputmanagement!install=true

In the above example, the DSN is configured to use Windows Authentication. If it was configured with SQL Authentication, then the parameters "Database!User", "Database!Password", "OMRepositoryDB!User", "OMRepositoryDB!Password", "OMRuntimeDB!User" and "OMRuntimeDB!Password" must be specified as well.

  • Was this article helpful?