Upgrade Tosca Commander

This topic describes the upgrade of Tosca Commander to version 2024.2, which is part of your Tricentis Tosca upgrade workflow.

Please note that instructions only apply to upgrades from these versions:

  • Versions that are supported around the time of the 2024.2 release: 2024.1 and 2023.2

  • Versions that are in extended support around the time of the 2024.2 release: 2023.1, 16.0, 15.2, and 15.0.

For information on how to organize upgrades for end-of-life versions, check out "Upgrade end-of-life versions".

Before you start

Have you tested the new version in the recommended staging environment and scheduled downtime?

About schema and XEngine migrations

Schema migrations update your repository database, while XEngine migrations update Standard subset Modules and their connected TestCases.

To learn whether you need to migrate—and how—check out "Schema migrations" and "XEngine migrations".

Perform the upgrade

To upgrade Tosca Commander, follow this basic workflow:

  • Back up your data.

  • Perform the upgrade.

  • Finalize your upgrade.

Please choose your use case:

Back up your data

Before you get started, create your backups:

  • Back up your configuration files in the %COMMANDER_HOME% directory and its child folders. When you upgrade, Tosca installs new versions of these configuration files, overwriting the old.

  • Back up customizations such as engines, controls, keywords, recovery scripts, and so on.

  • Back up your repositories. This is just a precaution; typically, you don't need to restore repositories after an upgrade.

You don't need to back up settings that you've changed in the Settings dialog. Tosca keeps these settings intact. You can find the underlying files in the %TRICENTIS_ALLUSERS_APPDATA%\Settings directory.

Perform the upgrade

To upgrade Tosca Commander to 2024.2, follow these steps:

  1. Uninstall the old version in one of the following ways:

  2. Uninstall your customizations.

  3. Remove all remaining files from the %COMMANDER_HOME% directory.

  4. Install the new version in one of the following ways:

Finalize the upgrade

To finalize your upgrade, re-add your customizations, plugins, and settings:

  1. Recompile customizations and AddOns and save them in their respective locations. You need to do this before starting Tosca Commander for the first time.

    • Save customizations to C:\Program Files (x86)\TRICENTIS\Tosca Testsuite\TBox

    • Save AddOns to %COMMANDER_HOME%

  2. Recompile any code you've created that's based on the Tosca Commander API.

  3. Install Firefox and Chrome plugins for XBrowser, if necessary.

  4. Review and update your configurations. The upgrade process installs new versions of all config files, which means the new version overwrites the settings of the previous installation. To reestablish configurations, perform these actions:

    • Go to %TRICENTIS_ALLUSERS_APPDATA%\ConfigBackup<timestamp>\ToscaCommander, where you'll find backups of the old files.

    • Manually update the new versions of the .dll.config files with the information from the backups.

Only use your backup files as a reference.

  • Don't replace any new version files with your backup files.

  • Don't paste the entire content from your backup files without checking for differences between settings in the new and the old version.

You don't need to restore any Tosca Commander settings that you changed in the Settings dialog. Tosca keeps these settings intact.

Back up your data

Before you get started, create your backups:

  • Back up your configuration files in the %COMMANDER_HOME% directory and its child folders. When you upgrade, Tosca installs new versions of these configuration files, overwriting the old.

  • Back up customizations such as engines, controls, keywords, recovery scripts, and so on.

  • Back up your repositories. This is just a precaution; typically, you don't need to restore repositories after an upgrade.

You don't need to back up settings that you've changed in the Settings dialog. Tosca keeps these settings intact. You can find the underlying files in the %TRICENTIS_ALLUSERS_APPDATA%\Settings directory.

Perform the upgrade

To upgrade Tosca Commander to 2024.2, follow these steps:

  1. Uninstall the old version in one of the following ways:

  2. Uninstall your customizations.

  3. Remove all remaining files from the %COMMANDER_HOME% directory.

  4. Install the new version in one of the following ways:

Finalize the upgrade

To finalize your upgrade, re-add your customizations, plugins, and settings:

  1. Prepare your AddOns:

    • Migrate to .NET 8. Effective 2024.1, Tosca Commander runs on .NET 8.

    • Deselect the Prefer 32 bit option. Effective 2024.1, we deprecated 32 bit support.

    • Set the PropertyGroup attribute TargetFramework to net8.0-windows.

    After migrating to .NET, AssemblyInfos.cs is no longer necessary. If you want to remove it, you can include all settings in the csproj file according to Microsoft best practices.

  2. Prepare any code you've created that's based on the Tosca Commander API (opens in new tab):

    • Migrate to .NET 8. Effective 2024.1, Tosca Commander runs on .NET 8.

    • Deselect the Prefer 32 bit option. Effective 2024.1, we deprecated 32 bit support.

    • Set the PropertyGroup attribute TargetFramework to net8.0-windows.

    • Set the PropertyGroup attribute UseWindowsForms to true.

  3. Recompile customizations and AddOns and save them in their respective locations. You need to do this before starting Tosca Commander for the first time.

    • Save customizations to C:\Program Files (x86)\TRICENTIS\Tosca Testsuite\TBox

    • Save AddOns to %COMMANDER_HOME%

  4. Recompile any code you've created that's based on the Tosca Commander API.

  5. Install Firefox and Chrome plugins for XBrowser, if necessary.

  6. Review and update your configurations. The upgrade process installs new versions of all config files, which means the new version overwrites the settings of the previous installation. To reestablish configurations, perform these actions:

    • Go to %TRICENTIS_ALLUSERS_APPDATA%\ConfigBackup<timestamp>\ToscaCommander, where you'll find backups of the old files.

    • Manually update the new versions of the .dll.config files with the information from the backups.

Only use your backup files as a reference.

  • Don't replace any new version files with your backup files.

  • Don't paste the entire content from your backup files without checking for differences between settings in the new and the old version.

You don't need to restore any Tosca Commander settings that you changed in the Settings dialog. Tosca keeps these settings intact.