Software Upgrades

Version 22.0.8342


Software Upgrades


This section describes the simple process of upgrading from an earlier release of CData Sync. For information about performing a fresh installation of CData Sync, see Installation and Server Startup.

Upgrading from CData Sync 2021

This section explains how to upgrade from CData Sync 2021 to CData Sync 2022 for both the Microsoft Windows Edition and the Java Edition.

Microsoft Windows Edition

Sync 2022 functions as a drop-in upgrade to Sync 2021. So, simply running the installer for Sync 2022 upgrades all necessary application resources.

The installer for Sync 2022 attempts to detect existing installations of Sync 2021 and preserve the connections, jobs, and settings from the existing installation. If Sync 2021 was not installed in the default location, you might need to point the Sync 2022 installer to the folder on disk where Sync 2021 is installed.

Java Edition

The Java Edition of Sync 2022 is provided through a setup.zip file. Follow these steps to upgrade an existing installation of the Sync 2021 Java Edition to Sync 2022:

  1. Stop the server in either of the following ways:

    • To stop server as a service, submit this command:

      sudo systemctl stop sync

    • To stop the service in-process, submit this command:

      java -jar sync.jar --stop

  2. Extract the contents of setup.zip to /opt/sync/.

  3. Submit the following upgrade command:

    sudo bash /opt/sync/upgrade.sh

    Optional: You can specify the -InstallDirectory parameter if your previous installation uses a nondefault path.

  4. Start the server in either of the following ways:

    • To start the server as a service, submit this command:

      sudo systemctl start sync

    • To start the service in-process, submit this command:

      java -jar sync.jar

Notes for Java users:

  • No matter how you choose to deploy Sync, the files and folders that are contained in ApplicationDirectory must be readable and writable by the user who runs the application. The service.sh script that is included with the Java Edition uses cdatasync as this user.

  • If the application was previously run as a different user and you want to restore the necessary permissions for a cdatasync user to run the application, submit a command that is similar to the following:

    sudo chown -R cdatasync:cdatasync /opt/sync

Upgrading from CData Sync 2020

This section explains how to upgrade from CData Sync 2020 to CData Sync 2022 for both the Microsoft Windows Edition and the Java Edition.

Microsoft Windows Edition

CData Sync 2022 functions as a drop-in upgrade to CData Sync 2020. So, simply running the installer for Sync 2022 upgrades all necessary application resources.

The installer for Sync 2022 attempts to detect existing installations of Sync 2020 and preserve the connections, jobs, and settings from the existing installation. If Sync 2020 was not installed in the default location, you might need to point the Sync 2022 installer to the folder on disk where Sync 2020 is installed.

Sync 2022 includes several improvements that might cause the application to behave differently from a Sync 2020 installation:

  • Sync 2022 manages users within the application rather than through server configuration. So, some user settings might not transfer.

  • Sync 2022 does not require Windows administrator privileges in order to run, by default. So, you might need to update some folder permissions.

Microsoft Windows Application Directory

The Windows Edition of Sync 2022 stores the application directory (ApplicationDirectory) in the C:\ProgramData folder by default. Earlier versions of Sync used the C:\Program Files folder to house the application directory. This change helps ensure that Sync 2022 can run without administrator privileges by default.

When you upgrade from Sync 2020 to Sync 2022, the application reuses the application directory from the previous (2020) installation. However, Sync still attempts to run without administrator privileges by default. As a result, you might need to set the access permission rules on ApplicationDirectory within C:\Program Files to allow Sync access with lower-level permissions.

User Management

Earlier versions of Sync managed users via the server configuration XML files (for example, Web.Config, server.xml). Sync 2022 brings user management into the application by introducing a Users tab on the Settings page.

Users that are configured in earlier versions do not persist in the new installation of Sync 2022. You should re-create those users, as necessary, on the Users tab.

Java Edition

The Java Edition of Sync 2022 is provided through a setup.zip file. Follow these steps to upgrade an existing installation of the Sync 2020 Java Edition to Sync 2022:

  1. Stop the server in either of the following ways:

    • To stop server as a service, submit this command:

      sudo systemctl stop sync

    • To stop the service in-process, submit this command:

      java -jar sync.jar --stop

  2. Extract the contents of setup.zip to /opt/sync/.

  3. Submit the following upgrade command:

    sudo bash /opt/sync/upgrade.sh

    Optional: You can specify the -InstallDirectory parameter if your previous installation uses a nondefault path.

  4. Start the server in either of the following ways:

    • To start the server as a service, submit this command:

      sudo systemctl start sync

    • To start the service in-process, submit this command:

      java -jar sync.jar

Notes for Java users:

  • No matter how you choose to deploy Sync, the files and folders that are contained in ApplicationDirectory must be readable and writable by the user who runs the application. The service.sh script that is included with the Java Edition uses cdatasync as this user.

  • If the application was previously run as a different user and you want to restore the necessary permissions for a cdatasync user to run the application, submit a command that is similar to the following:

    sudo chown -R cdatasync:cdatasync /opt/sync

Upgrading from CData Sync 2017, 2018, and 2019

The installer for CData Sync 2022 attempts to detect existing previous installations of Sync and to import previous settings. These imported settings include the following:

  • All jobs

  • All connections

  • Any external connectors

  • All Sync settings

Migrating Configurations

Migrating your Sync configuration enables you to export connections, jobs and application settings from one Sync installation to another. To migrate your Sync configuration to a new installation:

  1. Click the Settings tab on the Sync top navigation bar.

  2. Click the Migration tab on the Applications Settings screen. From this tab, you can export or import Sync settings.

    • Click Export to downloads all jobs, connections, and Sync settings into zipped CSV files.

    • Click Import to select a Sync settings file. Then, click Choose File and navigate to the correct ZIP file to import your previously saved settings.

Upgrading Marketplace Instances

When you use marketplace instances of Sync, CData publishes updated instances following new product enhancements and product releases. You can migrate your Sync configuration easily from the old instance to the new by following the steps listed earlier in Migrating Configurations.