Prerequisites

Upgrade steps for the Apache Tomcat application server

Test your code

Getting support

With the release of CloverDX Server 7, important platform changes are being introduced to align with modern standards and ensure long-term support. While CloverDX 6 supports Apache Tomcat 9.x and runs on both JDK 11 and JDK 17, CloverDX 7 requires Tomcat 10.1 or Red Hat JBoss Web Server 6.0 with Tomcat 10.1 runtime and supports only JDK 17. This shift brings improved performance, enhanced security, and compatibility with the Jakarta EE 9+ ecosystem. 

If you typically upgrade using the official CloverDX Docker image or through our AWS or Azure marketplace offers, you don't need to follow the manual steps outlined here—you can simply deploy the updated image or offering as usual. This guide is intended for customers performing manual upgrades of their CloverDX Server environments. 

However, even when using the official Docker image or cloud marketplace offerings, you should still first upgrade your non-production environment and thoroughly test your graphs and custom code.  Follow the steps in the Test your code section to ensure compatibility and catch any issues early.

In this article, we’ll guide you through the steps to successfully upgrade your CloverDX Server environment to version 7. These steps can also be adapted for upgrades to Red Hat JBoss Web Server 6.0.

If you’d like assistance with the upgrade, our Data Engineering team is here to help—just reach out to your account manager to get started.

Prerequisites

• Some defaults or behaviors may have changed; consult the 9.0.x to 10.0.x and 10.0.x to 10.1.x Apache Tomcat Migration Guides. These guides provide detailed information on the changes between versions and offer valuable assistance during the upgrade process.
• Ensure that you are using a supported stack (OS, JDK version and provider, system database version and provider, and compatible driver). 
• Do not install Apache Tomcat 10.1 over your current Tomcat 9.x installation. This allows you to revert back to Tomcat 9.x if the upgrade fails. 
• Make sure to back up your CloverDX system database before the upgrade. 
• Back up your sandboxes before the upgrade. 
• Perform the upgrade on a non-production environment first and thoroughly test your code before upgrading your production. 

Upgrade steps for the Apache Tomcat application server

1.  Obtain Tomcat 10.1 and CloverDX 7 war file

• Visit the Apache Tomcat website and download the latest version of Apache Tomcat 10.1 (note that CloverDX 7 does not run on any other version of Tomcat).
• • For Windows users intending to run CloverDX Server as a service, download the 64-bit Windows Service Installer from the "Binary Distributions" section.
• Download the 7.0 clover.war file from our Customer Portal. 
• Alternatively, download the CloverDX Server Bundle, which includes a pre-configured Tomcat 10.1 and the clover.war file. This option is suitable for Linux environments or manual server operation on Windows.

2.  Installation/Extraction

• Extract the downloaded Tomcat 10.1 files into a newly created directory.
• If using the Windows Service Installer, install the service into a new, dedicated directory.
• If using a fresh Tomcat installation, place the clover.war file in the webapps folder. If you are using the CloverDX Server Bundle, you can skip this step. 

3. Java version

• Confirm that you are using the appropriate JDK version (check the JAVA_HOME environment variable):
  • When running on Apache Tomcat 10.1, only Eclipse Temurin JDK version 17 is supported. 
  • When running on Red Hat JBoss Web Server 6.0, only Red Hat OpenJDK 17 64-bit is supported.

4. CloverDX configuration file

• Copy the CloverDX configuration file to the new Tomcat 10.1 directory. The easiest way to find the location of the configuration file in your current environment is to navigate to Configuration > Setup > Configuration File in the Server console. 
• We recommend placing the configuration in the cloverconf folder within the Tomcat install directory.

5. Copy Tomcat configuration

• Copy the setenv.sh (Linux) or setenv.bat (when running Server manually on Windows) files from the bin directory of your existing Tomcat 9 installation into the bin directory in your Tomcat 10 installation. Review its content and modify it. Ensure that the path to the configuration file is correct in your new installation and review other configuration properties to see if they need to be modified.
• When running Tomcat as a Windows service, copy and modify the service settings accordingly. Refer to our documentation for more information. 
• If you had any customizations in server.xml, web.xml, or other Tomcat configuration files, please review them and assess whether they should be carried over. Keep in mind that there may be differences between Tomcat 9.x and 10.1.x—some changes may not be compatible or advisable to migrate (for example, the SSL setup uses different syntax in Tomcat 10). We recommended you consult the Apache Tomcat documentation to understand any differences and ensure compatibility.

6. Copy JDBC driver from the lib folder

• Copy your database JDBC driver used for your database connection to the system database to the lib folder in the new installation. If you previously used Java 11, you may need to download a different version of the driver.

7. Enable HTTPS 

If your Server uses HTTPS, you will need to re-configure it. This requires:

• Moving your keystore file to the conf directory within your Tomcat 10 installation.
• Enabling the HTTPS connector in the server.xml file. Note that the syntax for connector configuration in Tomcat 10 is different than in Tomcat 9.

For more information, see our documentation.

8. Log4j2 customization

• If you customized Server core or worker log4j2 logging in your environment, you will need to perform the customization again, using the 7.0 log4j2 configuration files. See our documentation for more information. 

9. Get latest Server license

• Get the latest version of your Server license from our Customer Portal. The portal always provides license files for the latest release. If you want to learn more about the license logic when upgrading, refer here.
  • If you use the license.fileor license.dir configuration properties in the CloverDX configuration file, make sure to place the 7.0 license(s) in the specified directory. 
  • If you load license files manually, you can do so in the Server console after the upgrade process is complete. 

Test your code

• Install Designer 7.0 in a separate directory and use a new workspace.

• Get the latest version of your Designer license from our Customer Portal to activate it. 

• Import sandboxes from the 7.0 Server environment into the new workspace:

  • Go to File > New > CloverDX Server Project.

  • Add each sandbox one by one.

• Thoroughly test all graphs and custom code after the upgrade—especially if your existing environment is running on JDK 11 or includes custom code that depends on libraries which may not yet support Jakarta EE.
• Some components (e.g. SystemExecute or RunGraph) were removed in 7.0. You'll need to update your jobs to use alternative components instead (use ExecuteScript instead of SystemExecute or ExecuteGraph or ExecuteJobflow instead of RunGraph).

Getting support

If you encounter issues during the upgrade or experience problems running CloverDX Server 7.0, our Support team is here to help. To speed up the troubleshooting process, please provide the appropriate diagnostic information when reaching out:

• If your environment is up and running:
  Generate and send a Support Package via the CloverDX Server Console. This includes detailed logs and configuration information that help us diagnose the issue quickly.

• If your environment is not running:

  • First, check the /temp/cloverlogs directory in the Tomcat install directory. If any log files are available there, include them in your support request.
  • If that folder is empty or missing, please send the contents of the standard /logs/ directory instead.

Providing this information upfront will help our team assist you more efficiently and reduce back-and-forth during the investigation.

You can contact our support team either by emailing support@cloverdx.com or by logging a ticket through our Customer Portal.