Best practices for Migrating CData Sync from a previous .NET version to V24 Cross-Platform in an IIS Deployment

Userlevel 2

Starting with Sync 2024, the .NET edition of the application is deprecated.  

A general guide about “Migrating CData Sync from the .NET Edition to the Cross-Platform Edition” can be found on the following article: Migrating CData Sync from the .NET Edition to the Cross-Platform Edition | Community .     

Among the users that need to migrate their current .NET edition of Sync to the Cross-Platform edition are the ones using the .NET version of Sync deployed on the Microsoft IIS web server.  

This article provides general recommendations and detailed steps for performing this migration seamlessly, ensuring minimal disruption and maintaining the integrity of your data.  

I. Recommendations:  

1. Setup a Development or Trial instance  

Before proceeding with the migration on your production server, consider using a separate instance (either a development or trial instance):  

  • If you already have a license that includes a key for development, you can use that instance to install the newer version of Sync.  

  • Otherwise, to set up a trial instance, you can download Sync from theCData website.  

This will allow you to test the migration process and ensure all configurations work as expected.  

2. Deploy Sync on IIS after verifying that everything works correctly  

Initially, you can avoid involving IIS. Simply install Sync 2024 version, export your settings from the previous version and then import them to V24. After ensuring that everything was imported successfully and works correctly, you can start the process of deploying CData Sync to Microsoft Internet Information Services (IIS).  

3. Backup your existing setup  

Backup your existing setup by renaming the application directory and installation folders. This way, if you encounter any issues with the new installation, you can revert by renaming the files back.  


II. Step-by-step guide:  

1. If you are using the default SQLite application database, you must export your settings because the Cross-Platform edition of Sync uses the Apache Derby database by default. You can export your settings by using the Migration tab on the Settings page in Sync:  




2. Rename the .NET application directory and installation folder so that the new Cross-Platform edition will be installed in a separate folder (the default paths are “C:\ProgramData\CData” and “C:\Program Files\CData\CData Sync”).   

Before renaming the folders above, you must first stop the Sync application so that the files are not in use. Since the application is hosted on IIS, to stop the application you can stop the site where the application is configured or its dedicated application pool.  

3. Download and install the Cross-Platform edition of Sync from the CData website.   

During the installation of Sync, in one of the windows you will be prompted to choose the components to install. You can uncheck the CData Sync Service since you will deploy Sync on IIS.  

4. Run Sync manually  

To start CData Sync without creating a service, use the Command Prompt (CMD) to open the sync.jar file in the installation directory, as shown here:  

java -jar sync.jar  

5. In your browser, navigate to http://localhost:YourPortNumber/ to access Sync:  




Once done, you can register on our license portal to manage and upgrade your license, as V24 will require a new license key:   

Note: The default port number is 8181.  

6. Import the settings that you exported in step 1:  




Please note that if in your previous .NET installation of Sync, you’ve had scheduling enabled in any of your jobs, you will have to re-enable it after migrating to the Cross-Platform edition. That’s because scheduling configuration will be saved but not enabled.  

7. After making sure that everything is intact and works correctly, close the command prompt that you used to start Sync and start the process of deploying CData Sync to Microsoft Internet Information Services (IIS) by referring to the next steps.  

8. Deploy CData Sync to Microsoft Internet Information Services (IIS) following the steps as per the documentation here: CData Sync - Configuring the Server   

9. In your browser, navigate to access Sync:  




And that’s it. You should be good to go.   

Note: In this article we first ran Sync manually (without creating a service) to make sure that everything works correctly on v24 before proceeding with deploying Sync on IIS. However, you can absolutely skip this step and start directly with deploying Sync on IIS and then import the settings.  

Please reach out to if you run into any issues.  

This topic has been closed for comments