Parameters

Parameter

Required / Optional

Description

ContractManager!UseAuthentication Optional

Boolean flag that specifies whether to enable authentication for executing SOAP calls on the Contract Manager.

  • If set to True, then the calling application should supply an application name as the user name and its application key as the password. For more information, see the Applications section in Kofax Communications Manager Getting Started Guide.
  • If set to False, anyone with access to the Contract Manager can execute any SOAP call on its interface without additional authentication.
ContractManager!UseSSL Optional Boolean flag that specifies whether the integrating applications need to use a secure protocol for connections to the Contract Manager.
  • If set to True, connections are secure, using the HTTPS protocol (HTTP over SSL).
  • If set to False, connections are not secure, using the HTTP protocol.
ContractManager!TLSVersions

Optional when ContractManager!UseSSL=True.

Not allowed otherwise.

The versions of the TLS protocol that are supported by the Contract Manager. Possible values are:
  • TLS_11_12_13. Allows TLS 1.1, TLS 1.2 and TLS 1.3 .
  • TLS_11_12. Allows TLS 1.1 and TLS 1.2 .

  • TLS_13. Allows TLS 1.3 .

When omitted, defaults to TLS_11_12_13.

TLS 1.3 requires support in Java, and support in .NET on the server OS. If you choose to use TLS_13 only, make sure that these requirements are met.
ContractManager!KeyStoreFile Only required if ContractManager!UseSSL was set to True The location of the SSL certificate file.
ContractManager!KeyStorePassword Only required if ContractManager!UseSSL was set to True The password of the SSL certificate file.
ContractManager!UseLDAP Optional

Boolean flag that specifies whether users can log in to KCM Designer using LDAP authentication.

  • If set to True, users can log in to KCM Designer with their LDAP user accounts.
  • If set to False, users can log in to KCM Designer with internal user accounts that are managed by the KCM Repository server.
ContractManager!LDAPPropertiesFile

Required if ContractManager!UseLDAP was set to True

The configuration file for LDAP authentication.

ContractManager!ImportConfigurationFile Optional

Path to exported configuration file that will be loaded automatically when the Contract Manager is started.

See the Export Contract Manager configuration section in the Kofax Communications Manager Getting Started Guide for details.

ContractManager!ImportInfrastructure Required when ContractManager!ImportConfigurationFile has a value. Boolean flag that specifies whether the exported configuration should be loaded with or without infrastructure.

See the Export Contract Manager configuration section in the Kofax Communications Manager Getting Started Guide for details.