Upgrading the SAP Cloud Connector for Windows OS
Some months ago I performed an upgrade of the SAP Cloud Connector for the Linux OS. This worked very well and was a simple process overall. Check out my previous blog here. I am now attempting an upgrade of the SAP Cloud Connector on a Windows OS environment. I read the SAP help information associated with upgrades and it explained that an Uninstall then a new Install was required but that configuration settings would be preserved. Check standard help information here. I wondered how this would work given there are usually security certificates loaded into the SAP Cloud Connector as well as general configuration options – not to mention connectivity to the SAP Cloud Platform.
NOTE: This type of upgrade is only supported for the Installer variants (msi install files). There is additional information in the sap help around Portable Variant upgrades so please refer to this for assistance.
OK – time to upgrade.
Before carrying out the steps, make sure you have downloaded the software from the SAP Development Tools (https://tools.hana.ondemand.com) website selecting the [Cloud] menu item followed by the Windows install file as highlighted below.
Make sure to download the Windows msi file as highlighted above. This is the Installer variant. When you downloaded the file you will need to Agree to the End User License agreement. Click button I Have Read And Agree to start the download.
Save the install files to a known place as you will need this in later instructions.
The first thing to know is that there are different procedures required based on the OS installed on the boxes that the SAP Cloud Connector applications live on.In my upgrade blog on the Linux OS simple commands were required to upgrade the application. For windows, a complete de-installation and re-installation (of the new version) is required.
Additionally, the new version needs to be installed in the same directory. The key to retaining settings is to make sure the Configuration settings/files are retained. This will be explained below. Let’s first set the scene by looking at the current version that is in play with respect to the relevant OS versions.
Upgrade Pre-Checks (Windows OS)
Let’s firstly login to the current SAP Cloud Connector version and check the version. The current version can be found by navigating to the top right corner and clicking on the expand option at the side of the Userid. There is a menu option called [About]. This of course assumes you have already logged in as Administrator!
If you click on this another pop-up window will be displayed showing the Version information. You can see below the OS is Windows 10. Note the working directory as well.
In this case the current version is 188.8.131.52. You will also notice that on the initial login screen the application is described as SAP HANA Cloud Connector – this is before the name change.
With the new version of 184.108.40.206 out I will now attempt an upgrade, but first let’s check a few settings prior to the upgrade and make sure they are the same after the upgrade.
Let’s first check connectivity to the SAP Cloud Platform account. This is the first step, even before connecting to backend SAP systems, that is required.
You can see that we have successful connection to the SAP Cloud Platform account and the relevant secure tunnel is in place.
Next, let’s check backend connections exist and resources are available.
Lastly, let’s check some of the configuration settings as well as certificate information that exists in the current version – these need to be retained after the upgrade.We will check them now and after the upgrade.
System certificate that is installed exists.
CA certificate also exists.
ALL of these settings should be retained after the upgrade.
You can create a backup of configuration files to retain this information between upgrades. SAP recommends packaging the following 3 folders into an archive:
By default, a backup folder will be kept during the uninstallation process however this is an insurance policy.
The above folders can be found by navigating to the C:\SAP\scc20\ directory. One of the folders is detailed below as an example. You will see a number of files including an scc_config.ini file. You will see a jks file as well that will keep information about the certificates. You will also see a directory linked to the Hana trial account. In a productive environment this would actually include the production SCP account.
OK, now we have checked all of that let us now attempt to carry out an upgrade. Godspeed!
NOTE: If you have a Master AND Shadow instance as part of a HIGH AVAILABILITY environment you need to upgrade the shadow instance first. Once the upgrade on the shadow instance is complete you then use the [Switch Roles] function that will swap the previous Master (the SAP Cloud Connector instance that has NOT been upgraded) to the Slave. The Slave instance (which has been upgraded) will then become the master while the NEW slave is being upgraded.
If you have a single instance there will be downtime in the environment during the upgrade process, so please build this into your project timeline.
For more information on setting up High Availability check Simen Huuse blog here.
NOTE: Before carrying out an Uninstall please just make sure you have logged out of the SAP Cloud Connector otherwise files may be locked and the process may not work successfully.
The first step in the process is to Uninstall the previous version:
- Navigate to Windows icon on the footer bar then choose Windows Settings. In a Windows 10 environment you select the Settings cog as highlighted below.
The following Windows Settings screen will be displayed.
- Select the [Apps] option that will allow us to Uninstall the SAP Cloud Connector. The following screen will be displayed.
- Using the search option enter SAP HANA to find the Cloud Connector application. This should be displayed when it is found. You will see it is version 220.127.116.11.
- Click on the [Uninstall] icon – twice.
- During the uninstall process you will be asked whether you want to retain the SCC configuration files. This will save the configuration files in a newly created folder called config_backup.
Make sure you select YES here to retain the previous settings.
- Click on [Yes] to retain the SCC configuration files.
If we also try to run this now the SAP Cloud Connector should not be available. The desktop shortcuts should also not exist.
This is exactly as we expect. So, at this point we have completed the uninstallation process of the previous SAP Cloud Connector version.
Once the uninstall is complete locate the new version’s installer file and execute it. The latest version is 18.104.22.168 and this is the installation file.
- Double click the file to start the Install process. This will guide you through the installation process so please follow the steps.\
- Click on the [Next] icon to progress through to the next steps.
NOTE: Make sure the same directory is chosen so that the configuration files can remain.
- Select [Next] to progress to the Port setting screen.Keep the same port setting of 8443.
- Click [Next] to continue. You will then need to choose the JDK location. This should be the same location that was selected during the previously install.
- Click the [Browse] button to locate the JVM as you can see below.
- Click the [Next] button to continue. You will then see the successful installation message and whether you want to start the SAP Cloud Connector.
- Click the [Start SAP Cloud Platform cloud connector] checkbox and continue on with the [Next] button.You will then be asked to confirm the installation.
- Click on the [Next] button to confirm the installation of the new version.
You will then receive the successful installation pop-up window.
Great – the installation process went smoothly.
- Select the [Close] button to complete the installation. This would have started the SAP Cloud Connector application.
We can check the Windows services to confirm this.
We can see below that this service is running.
Hooray!!! Our upgrade was successful. Let’s now see if all of our previous set up is still in place – is it still there???
Login to the Cloud Connector using your Administrator password. This will be the same as it was before!
We can already see that the name has changed. With the recent changing of the SAP HANA Cloud Platform to SAP Cloud Platform this has also meant a change to the Cloud Connector naming convention to SAP Cloud Platform Cloud Connector.
- Login using the Administrator password. NOTE: The password is the same as it was previously.
Let us check the version again. We can see below that the version is now 22.214.171.124 – the new version! Awesome!
Connectivity to the SAP Cloud Platform accounts looks good as well. We can see some additional display elements and options as well (e.g. Subaccount Certificate button). Nice!
We can see that the Tunnel is connected and a Connector ID has been populated. Looking good.
The connection to backend systems looks intact as well.
Let’s now check the certificates. System certificate looks good. No changes. This is great.
CA certificate for Principal Propagation is also in place.
OK, so you can see that this task was not too painful and now I can utilize some of the new features in the 126.96.36.199 version. Awesome!!!
If I look at the log files as well, they are all intact.All of the previous history still exists. We did see the additional Logs directory kept after the install so this makes sense.
Looking at the directory structures also you can see the previous backup still exists.
All in all, this was not too cumbersome a process and good to see everything is still the same after performing an upgrade.
Well done SAP. Good job!
Nice blog, Phil!
Fun fact: If you previously changed the port number with the changeport.bat script, and then proceed to upgrade, you will still be prompted for a port number during the installation, but the value you enter will be ignored (i.e. the value in the backed up configuration takes precedence, as it should).
Nice Morten - thanks and agree. Good to see the configuration backup settings takes precedence. Thanks for sharing the fun fact and glad you enjoyed the blog.
[Removed by Moderator]
Very helpful blog, thank you!
But why SAP doesn't provide an automatic tool to update the SAP Cloud Connector? I think for many customers can be safer instead of uninstall and reinstall something
Thanks Davide Bruno - I guess this application is like any other one on Windows - you basically run the exe file and then upgrade previous versions. SAP can't be responsible for how their customers want to upgrade their applications but as the blog shows it is very simple to do. I have not had a lot of customers upgrade their old versions as yet which is not great - not surprising - but not great. Like any other application customers need to include this in their system maintenance strategy.
Glad you liked the blog and thanks for the comments!
What happens if during re-installation the working directory has changed?
Nimai Bibhar - can you provide some more information please. Are you saying you want to change the directory from C:\sap\scc20 to something else as an example? Not sure I understand why you would want to do this. My initial thoughts would be to the try and keep the same working directory.
If you provide some more detail I can look into it.
Hey thanks for replying.
What I wanted to say that, suppose unintentionally we provided the wrong working directory, then what corrections do we need to follow?
My current version of SAP Cloud connector is using the Java Runtime as Oracle JDK 7. Now we are going to update the SAP Cloud connector from 2.10.1 to 2.11.3 .
Can we change the JRE from Oracel JDK 7 to SAP JVM 8 while doing the upgrade(here the upgrade means re-installation because the SAP CC is running in windws 2008 R2).
If we change the JRE to SAP JVM 8, then what will be impact in the configuration w.r.t SAP CC also will it impact the application connecting to the cloud connector.
Interesting. The reality is that the upgrade on a Windows machine is a Reinstall anyway and during this process you point to the JVM that is used so based on this I believe this is completely doable. That is, just point to the SAP JVM in this step. I would take a double backup of the config settings though just in case but I see no reason why the changeover to a different JVM would make the configuration settings disappear.
The saving of the configuration settings is what makes the impact low - if this was not the case you would need to start again and configure from scratch.
I've performed alot of upgrades and never had a connectivity issue afterwards however I've always kept the configuration settings.
Always good to try this in DEV systems first to prove the method!
Thanks & Regards
Thanks for your reply.
Here we are in a situation where the development system is in Linux environment, so we are not able to test this scenario.
Any possibilities that you can try from your side by changing the JRE from Oracel JDK 7 to SAP JVM 8.
Can we upgrade only the Oracle JDK to 8, and is it OK, that the upgrade SAP Cloud connector can run with oracle JDK 8 or is it mandatory to change it to SAP JVM 8.
Also can you provide Oracle JDK upgrade document(like any prerequisite to be followed) specific to SAP Cloud connector 🙂
Thanks for the Post.
I have upgraded SCC on Window. and now my Connection link is not opening.
and log says servlets.FatalSccException: C:\\SAP\\scc20\\config_master\\org.eclipse.gemini.web.tomcat\\default-server.xml has unexpected configuration in Server-Service-Connector