Upgrading Communications Manager

Upgrade.exe is a command-line tool designed to upgrade an existing Communications Manager installation to version 2025.3. Upgrade is supported for Communications Manager 5.7.0, 5.6.0, 5.5.0.

The tool works as follows:

1. It upgrades all Communications Manager components on a local server to Communications Manager 2025.3.
2. Configuration of the existing Communications Manager instances is preserved, except for the following:
   • For each Communications Manager instance, a new database is used for the Communications Manager Repository. However, the content of the old database is transferred automatically to the new one.
   • For each Communications Manager instance, the license is configured anew.
3. The Contract Manager configuration is set as follows:
   • Authentication and LDAP flags of the Contract Manager are configured anew, along with their configuration files.
   • The upgrade preserves the contracts with which the instances were associated on the Contract Manager.

     The upgrade does not automatically add new default contract types to existing contracts. Instead, you must add them manually after the upgrade. For more information, refer to the following section: Adding new default contract types.

4. Communications Manager Control Center configuration is set as follows:
   • OAuth2 authentication is configured anew.
5. B&OM upgrade. For more information, refer to the following topic: Upgrading B&OM.
6. After the upgrade, Communications Manager 2025.3 installation will be fully set up and started automatically.

7. (Optional) If an upgrade fails, an automatic rollback to the previous installation is attempted.

To upgrade Communications Manager, you must execute the following steps:

1. Open the command line interface (CLI). It could be PowerShell or Command Prompt.

2. In the CLI, navigate to the InstallServer folder of the new Communications Manager installation package.

3. Call the Upgrade.exe file and provide the necessary parameters. The order of parameters is irrelevant.

   To simplify input, you can create a script with the required parameter values and then use it to run Upgrade.exe.

   If everything is correct, the upgrade will run without errors. You will be able to follow the installation process by reading the CLI output.

When a Communications Manager version introduces a new default contract type, the Upgrade.exe tool does not automatically add these new contract types to the existing contracts. To start making use of the new default contract types, follow these steps:

1. Perform the usual upgrade operation including the starting of all components.

2. On the Contract Manager server, go to the following folder: <Deploy Root>\CommunicationsManager\Programs\2025.3\Management\Contract Manager.

3. For each existing contract and each new default contract type, execute the following command:

   ManageCM /addcontracttypetocontract /partner=<partner> /customer=<customer> /name=<newcontracttypename> /version=<newcontracttypeversion>

4. Run the following command:

   ManageCM /reloadconfiguration

Now you can use the new default contract types in your Communications Manager instances.

The following default contract types have been added in the following Communications Manager versions:

If the start operation fails during upgrade, we recommend that you follow the steps below:

1. Open the corresponding log file located in the <root folder>\CommunicationsManager\Work\2025.3\Management\Logs folder.

2. Start the component using the parameters and values specified in the log file.