Parameters

The KCM version to upgrade.

Enter version number in the format Major.Minor

Example: 5.4

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

If omitted, defaults to the root path of the old KCM installation.

The internal host name of the KCM server. This must match the Subject Alternative Name of the internal certificate.

This parameter becomes required when the old KCM installation is of version 5.7 or earlier.

The starting point for the ports that must be opened on the internal KCM network.

When you upgrade from KCM 5.7 or later, the default value is the starting point of the previous KCM installation. Otherwise, the default value is 10500.

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

When you upgrade from KCM 5.7 or later, the default value is the starting point of the previous KCM installation. Otherwise, the default value is 10600.

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.

If omitted, KCM will use the same Java installation as the previous KCM installation.

The full version number of a Tomcat installation on your system.

This Tomcat installation is used for the KCM web applications.

If omitted, KCM will use the same Tomcat installation as the previous KCM installation.

The user account used for the installed services.

• This user must be a member of the local Administrators group.
• This user must have the Logon as a service rights.

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 .\myuser

The password for the services user.

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.
• Read permissions on the SSL certificate file for the Contract Manager.

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 .\myuserws

The password belonging to the user provided through Webserver!ServiceUser.

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 topic.
• If set to False, anyone with access to the Contract Manager can execute any SOAP call on its interface without additional authentication.

Optional*

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

  At the moment, Microsoft Word does not support TLS 1.3. If you use TLS 1.3 only, you cannot open Word documents in KCM Designer.

When omitted, defaults to TLS_11_12_13.

The parameter's default value is False.

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

• If set to True, users can login 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.

Required* if ContractManager!UseLDAP was set to True

Specifies the location of a folder where the shared objects for import and export, such as project files and reference projects, are stored.

If omitted, defaults to <deploy root>\KCM\Work\<version>\SharedResources

Can be omitted if Windows authentication is used.

Can be omitted if Windows authentication is used.

Mutually exclusive with Instance!LicenseServerUrl.

Shared default value for the Instance#n! parameters of the same name.

Mutually exclusive with Instance!LicenseFile.

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

Required when Instance!LicenseServerUrl has a value.

Shared default value for the API key to access the license server.

Defaults to false when omitted.

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

If set to True, it indicates that execution should continue even when the database access check returns a negative result. This parameter is used both for the KCM and the B&OM.

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

The type of the database to be used by the KCM Repository of the instance #n. Specify SQLServer or Oracle.

The ODBC connection string to be used by the KCM Repository server of the instance #n 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.

The database user account that KCM Repository Server of the instance #n will use to connect to the database.

Required to connect to Oracle database or to SQL Server database using SQL Server authentication. In the latter case, this user must have the database owner role assigned and use dbo schema.

The password that KCM Repository Server of the instance #n needs to connect to the database.

Mutually exclusive with Instance#n!LicenseServerUrl.

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

If both Instance#n!LicenseFile and Instance#n!LicenseServerUrl are omitted, the license for instance 'n' reverts to the default license, set by either Instance!LicenseFile or Instance!LicenseServerUrl.

Mutually exclusive with Instance#n!LicenseFile.

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

If both Instance#n!LicenseFile and Instance#n!LicenseServerUrl are omitted, the license for instance 'n' reverts to the default license, set by either Instance!LicenseFile or Instance!LicenseServerUrl.

The API key for the license server access.

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

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 file — set to maximum allowed.
• For all other licenses — set to 4.

Can be omitted if Windows authentication is used.

The database user that the old KCM Repository of instance 'n' uses to connect to its database.

Can be omitted if Windows authentication is used.

The password that the old KCM Repository of instance 'n' uses to connect to its database.

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

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.

Can be omitted when 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.

Can be omitted when using Windows authentication.

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

Otherwise, cannot be used.

Full path to a copy of the repository.config file.

Otherwise, cannot be used.

Full path to a copy of the UserRepository.config file.

The type of the runtime database that is configured into the system with the name OutputManagement!RuntimeDatabaseSystemName.

The connection string of the runtime database that is configured into the system with the name OutputManagement!RuntimeDatabaseSystemName. If not specified, no runtime database is configured in any system.

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. Defaults to the port used in the old KCM installation. Not permitted when the old KCM installation does not have a Contract Manager.

The main access port for the Contract Manager to use.

Optional. Defaults to the port used in the old KCM installation. Not permitted when the old KCM installation does not have KCM Control Center.

The port for KCM Control Center to use.

Optional. Permitted only if OutputManagement!RuntimeDatabaseConnection has a value.

Omit this parameter if you are using Windows authentication.

The database user account that B&OM server uses to connect to the runtime database that is configured in the system with the name OutputManagement!RuntimeDatabaseSystemName.

Optional. Permitted only if OutputManagement!RuntimeDatabaseConnection has a value.

Omit this parameter if you are using Windows authentication.

Specifies the password that Batch & Output Management uses to connect to the runtime database that is configured in the system with the name OutputManagement!RuntimeDatabaseSystemName.

The name of the system in which the runtime database is configured.

Default value is RefSystem58.

Optional. Defaults to True when omitted.

You cannot specify this parameter if the old installation does not contain KCM Control Center.

A boolean flag that determines whether KCM Control Center requires authentication of users at an OAuth2 server.

Optional.

Required when the old installation contains KCM Control Center, and ControlCenter!UseOAuth2 is True. Otherwise, you should not specify this parameter.

The tenant of the OAuth2 configuration for KCM Control Center.

Optional.

Required when the old installation contains KCM Control Center, and ControlCenter!UseOAuth2 is True. Otherwise, you should not specify this parameter.

The client of the OAuth2 configuration for KCM Control Center.

Optional.

Required when the old installation contains KCM Control Center, and ControlCenter!UseOAuth2 is True. Otherwise, you should not specify this parameter.

The secret of the OAuth2 configuration for KCM Control Center.

Optional.

Required when the old installation contains KCM Control Center, and ControlCenter!UseOAuth2 is True. Otherwise, you should not specify this parameter.

The redirect base URL of the OAuth2 configuration for KCM Control Center.