NEXUSe2e from 4.x to 4.x

Upgrading NEXUSe2e from 4.x to 4.x

In order to benefit from bug fixes and improvements, we recommend that you upgrade your NEXUSe2e instances to the latest version regularly. Please follow the instructions on this page to upgrade an existing NEXUSe2e 4.x installation. For older versions, please contact the NEXUSe2e support.

This documentation targets the Apache Tomcat Servlet container. If you use another Servlet container to run NEXUSe2e, some details may differ from what is described here.

Preparing for upgrade

Go to the Download section to get the latest version in WAR (Web ARchive) file format.

Find your current NEXUSe2e web application root directory. If you are using Apache Tomcat, this will be<TOMCAT_HOME>/webapps/NEXUSe2e/. If you used the NEXUSe2e installer for Windows,<TOMCAT_HOME> is the tomcat folder located in your NEXUSe2e installation folder, otherwise it is the folder where you installed Tomcat.

Create a backup of your NEXUSe2e database in order to be able to roll-back to the older version if any problems occur. If you use the internal derby database for NEXUSe2e, copy all files located in <NEXUSe2e Web app root>/WEB-INF/config/database/derby to a backup location. Otherwise, use the provided database tools or ask your DBA to create a database backup.

If you are using the ant deployment script for NEXUSe2e upgrades, please refer to the deployment documentation provided when NEXUSe2e was first installed. In this case, you can skip the following steps and go directly to section Installing the new version.

Copy the NEXUSe2e web application configuration located in <NEXUSe2e Web app root>/WEB-INF/config to a backup location. This configuration includes database and logging setup, the machine name and optional clustering properties. We recommend that you copy all files from the config directory.

If your NEXUSe2e installation uses custom libraries, make sure that you have a copy of them somewhere. If you know the custom library name(s), go to the <NEXUSe2e Web app root>/WEB-INF/lib directory and copy them to a backup directory. In case you are not sure if your NEXUSe2e installation uses custom libraries, please contact NEXUSe2e support.

As last step, create a backup of your existing NEXUSe2e WAR file. Go to the Servlet container's web applications directory (<TOMCAT_HOME>/webapps) and copy the NEXUSe2e.war file to a backup location. This allows you to get back to your old NEXUSe2e version if the upgrade causes problems for some reason.

You are now prepared to start with the NEXUSe2e upgrade

Installing the new version

In the Servlet container's web applications directory (<TOMCAT_HOME>/webapps), replace the NEXUSe2e.war file with the .war file you downloaded. In order to do this, you need to strip the version number from the downloaded WAR file (e.g., rename NEXUSe2e_4.5.1.war as NEXUSe2e.war).

Tomcat will automatically deploy the new WAR file. After a while, the new NEXUSe2e version should have started. You can verify this by checking the version and build number on the NEXUSe2e web UI.

When the new version is up and running, stop the NEXUSe2e service (on Windows, go to System Management > Services and find the NEXUSe2e service).

Now, the NEXUSe2e version will be configured with the same parameters as the old version. To do this, go to the configuration directory (<NEXUSe2e Web app root>/WEB-INF/config/) and replace the following files from your configuration backup location:

  • machine_name.txt
  • clustering.xml (if present in your backup)

If you use the internal NEXUSe2e derby database, you also need to copy the database backup to the database sub-directory.

Complete and verify upgrade

After following the above steps, your new version is ready to go online. You can now start the NEXUSe2e service. To make sure everything is OK, we recommend that you check the Tomcat log files after startup.


Some version upgrades require additional steps (e.g., database adjustments). Please check NEXUSe2e version release notes for additional information or contact the NEXUSe2e support team.