Parameters

Required

The root drive or folder in which the KCM installation will be created.

The folder in which Java is installed in your system, either as JRE or JDK. This Java installation will be used for the KCM web applications.

The user account for KCM Windows services.

• This user must be a local Administrator.
• This user requires Logon as a service right.

You can specify a domain user account or a local user account. When specifying a local user, place a period and backslash (.\) at the beginning of the parameter.

Example .\AdminUser

The password for the KCM services user account.

The user account to run the KCM web applications. This account requires the following:

• Logon as a service right.
• Read & execute permission on the Tomcat installation folder.
• If you plan to use SSL connections, then also assign Read permission on the SSL keystore file. See the ContractManager!UseSSL parameter description below for details.

You can specify a domain user account or a local user account. When specifying a local user, place a period and backslash (.\) at the beginning of the parameter.

Example .\AdminUser

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.

  ContractManager!UseSSL parameter also must be set to True.

• If set to False, anyone with access to the Contract Manager can execute any SOAP call on its interface without additional authentication.

• 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.

Optional when ContractManager!UseSSL=True.

Not allowed otherwise.

• 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.

Required for HTTPS connections to Contract Manager on this KCM server

The location of the SSL certificate file.

Required for HTTPS connections to Contract Manager on this KCM server

The password of the SSL certificate file.

Required

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.

  ContractManager!UseSSL parameter also must be set to True.

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

Required if you want to enable LDAP authentication.

Optional

Optional

Optional

The starting point for the ports that must be opened on the internal KCM network. The default value is 10500.

Optional

The starting point for the ports that do not need to be opened on any network. The default value is 10600.

Required

Type of the databases that the deployment uses. Enter SQLServer or Oracle.

Required

The ODBC connection string to be used by the KCM Repository server to connect to the database.

Make sure that the database exists on the database server and is empty.

For SQL Server database, consider the following:

• Default authentication method is SQL Server authentication.
• Windows authentication is also supported. To enable it, leave out the database user and password parameters.

Required for connection to Oracle database or to SQL Server database using SQL Server authentication.

Can be omitted whenever you have a connection string that does not require a user and password, for example, for connection to SQL Server database using Windows authentication.

The database user account that KCM Repository server will use to connect to the database.

Required to connect to Oracle database or to SQL Server database using SQL Server authentication. Make sure the account has the required roles and privileges, as described in the Databases section of this guide.

Required for Oracle database user and for SQL Server connection using SQL Server authentication.

Optional. Either this or Instance!LicenseServerUrl is required.

The location of the .xml file with the license information.

Optional. Either this or Instance!LicenseFile is required.

The URL to the KTA license server API, for example, https://<machine name>/TotalAgility/Services/Sdk/LicenseClient.

Optional. Required when Instance!LicenseServerUrl has a value.

The API key for the license server access.

Optional. Defaults to false when omitted.

A boolean flag which determines whether the certificate of the license server should be verified (false) or ignored (true).

Optional

The number of Document Processors to create for the instance, between 1 and 99.

When using a capacity-based license XML file, this number must not exceed the maximum set in the license. For details, see the License section in this guide.

If omitted, default value will be used:

• For a capacity-based license XML file — set to maximum allowed.
• For all other licenses — set to 4.

Required

The password for the KCM Designer Administrator account (created automatically by the installation).

The password must be at least 20 characters long and may only consist of letters (a-z, A-Z), numbers (0-9), and the "-" and "_" characters.

If the specified password does not meet these requirements, a default password will be generated by the installation instead.

Optional

Boolean flag that specifies if the "InstallationTest" example project should be imported in the KCM Repository database.

If omitted, defaults to True.

Optional

If set to True, it indicates that execution should continue even when the database access check returns a negative result. It also applies to the B&OM databases.

This might result in a failure later, when the database connection cannot be established.

Optional . Defaults to false when omitted.

Boolean flag that determines whether B&OM will be installed.

Required if OutputManagement!Install is set to True.

The type of repository database to be used by the B&OM. Specify SQLServer or Oracle.

Required if OutputManagement!Install is set to True

Specifies the connection string that Batch & Output Management uses to connect to its repository database.

This cannot be an ODBC connection string. Depending on the OutputManagement!RepositoryDatabaseType parameter, this must be either a valid Oracle or SQL Server connection string.

• Primary B&OM installation must be connected to the new empty database.
• Secondary B&OM installation must be connected to the same database as the primary installation.

For SQL Server database, consider the following:

• Default authentication method is SQL Server authentication.
• Windows authentication is also supported. To enable it, leave out the database user and password parameters.

Optional. May be omitted if you are using Windows Authentication.

The database user account that B&OM server will use to connect to the B&OM Repository database.

Make sure the account has the required roles and privileges, as described in the Database section of this guide.

Optional. May be omitted if you are using Windows Authentication.

Specifies the password that Batch & Output Management uses to connect to its Repository database.

Required if OutputManagement!Install is set to True

The type of runtime database to be used by B&OM. Specify SQLServer or Oracle.

Required if OutputManagement!Install is set to True

Specifies the connection string that B&OM uses to connect to its Runtime database.

This cannot be an ODBC connection string. Depending on the OutputManagement!DatabaseType parameter, this must be either a valid Oracle or SQL Server connection string.

For SQL Server database, consider the following:

• Default authentication method is SQL Server authentication.
• Windows authentication is also supported. To enable it, leave out the database user and password parameters.

Optional. May be omitted if you are using Windows Authentication.

The database user account that B&OM server will use to connect to B&OM Runtime database.

Optional. May be omitted if you are using Windows Authentication.

Specifies the password that Batch & Output Management uses to connect to its Runtime database.

Required

A boolean flag that indicates whether an example web application will be created for this KCM instance.

Required if Registration!UseExampleWebApp was set to True.

The name of the example web application that will be created for the KCM instance.