Skip to main content
Waters Employee Login
 
Waters

How to upgrade the version of Apache Tomcat as used with NuGenesis SDMS - WKB111885

  1. Last updated
  2. Save as PDF
Article number: 111885

OBJECTIVE or GOAL

Upgrade the version of Apache Tomcat in a NuGenesis SDMS web server.

ENVIRONMENT

  • NuGenesis 9 SDMS
    • Default Apache Tomcat v9.0.8
  • NuGenesis 8 SDMS
    • Default Apache Tomcat v6.0.29
  • Acceptable new version of Apache Tomcat for NuGenesis 9 (with minimum Java 8 Update 172 x86):
    • v9.0.x x86 32-bit Windows distributions
  • Acceptable new versions of Apache Tomcat for NuGenesis 8 (all with Java 7 Update 2 x86):
    • v6.0.x x86
    • v7.0.x x86
    • v8.0.x x86
    • v8.5.x x86

PROCEDURE

  1. Download the newest "32-bit Windows zip" distribution of Apache Tomcat from https://tomcat.apache.org.
  2. Unzip the files into their own folder; for example, for Tomcat 6.0.53, unzip it to Drive:\Program Files (x86)\apache-tomcat-6.0.53; for Tomcat 9.0.44, unzip it to Drive:\Program Filex (x86)\Waters\apache-tomcat-9.0.44. The directory structure below the new version of Tomcat should mirror the structure of the Tomcat folder as deployed with NuGenesis SDMS
  3. Edit the server.xml file in Notepad:
    • NuGenesis 8: Drive:\Program Files (x86)\apache-tomcat-X.Y.ZZ\conf\server.xml
    • NuGenesis 9: Drive:\Program Files (x86)\Waters\apache-tomcat-X.Y.ZZ\conf\server.xml
  4. Add the following lines to the end of server.xml, above the "</Host>" line:
    • <Context path="/ngaudit/servlet" docBase="NGAudit" reloadable="true" cookies="true" useHttpOnly="false"/>
    • <Context path="/servlet" docBase="WebVision" reloadable="true" />
  5. Save and close server.xml
  6. Copy the NuGenesis web apps to the new Tomcat folder:
    • NuGenesis 8:
      1. Copy the folder Drive:\Program Files (x86)\apache-tomcat-6.0.29\webapps\NGAudit to Drive:\Program Files (x86)\apache-tomcat-X.Y.ZZ\webapps
      2. Copy the folder Drive:\Program Files (x86)\apache-tomcat-6.0.29\webapps\WebVision to Drive:\Program Files (x86)\apache-tomcat-X.Y.ZZ\webapps
    • NuGenesis 9:
      1. Copy the folder Drive:\Program Files (x86)\Waters\apache-tomcat-9.0.8\webapps\NGAudit to Drive:\Program Files (x86)\Waters\apache-tomcat-X.Y.ZZ\webapps
      2. Copy the folder Drive:\Program Files (x86)\Waters\apache-tomcat-9.0.8\webapps\WebVision to Drive:\Program Files (x86)\Waters\apache-tomcat-X.Y.ZZ\webapps
  7. Create the new service. Run the following in cmd.exe with admin rights. Replace "XYZZ" with the version number of Tomcat:
    • Drive:\Program Files (x86)\apache-tomcat-X.Y.ZZ\bin\service.bat install tomcatXYZZ
    • NOTE: service.bat is available only in the Windows distributions of Apache Tomcat.  If service.bat is not present in the Bin folder, then the wrong distribution was installed, or is incomplete/corrupted.  Only the "32-bit Windows" distribution is supported for use with NuGenesis and with this procedure
  8. Open services.msc and configure the Tomcat services:
    1. Stop the default Apache Tomcat service, "Apache Tomcat 9", and any other old versions of Tomcat which may be present
    2. Set the startup type for the old Tomcat services to Disabled
    3. Start the latest Tomcat service and set it's startup type to Automatic
  9. Optionally uninstall the old Tomcat services; see the Additional Info section for instructions

ADDITIONAL INFORMATION

Compatibility

NuGenesis 8 is not compatible with Apache Tomcat 9.x or 10.x because those versions of Tomcat require a minimum of Java 8.

NuGenesis 9 is not compatible with Apache Tomcat 10.x because the base classes are now "jakarta.*" instead of "java.*", meaning that Tomcat cannot start the NuGenesis servlets.

See also: How to upgrade the Java runtime environment for NuGenesis 9 SDMS

Uninstallation of old Tomcat services

  1. Open services.msc, double-click the obsolete Tomcat service, and record the service name; it will likely be "Tomcat9" or "tomcatXYZZ" per the above installation procedure
  2. Open a Command Prompt with admin rights
  3. Change directory to the \bin folder for the obsolete Tomcat installation.  Example: Drive:\Program Files (x86)\Waters\apcahe-tomcat-9.0.8\bin
  4. Run the following command, substituting in the service name as recorded in step 1:
    • service.bat uninstall serviceName
  5. Upon successful completion of this command, the message "The service 'serviceName' has been removed" will appear in the command prompt, and the service will disappear from services.msc

Configuration

The Tomcat configuration tool, tomcat9w.exe, will not by default configure a new Tomcat service as installed by the above procedure.  Double-clicking the tool will display a message: "The specified service does not exist as an installed service.  Unable to open the service 'tomcat9'".  To use the configuration tool with a new Tomcat service:

  1. Open a command prompt with Admin rights
  2. Change to the tomcat install directory (default: Drive:\Program Files (x86)\Waters\apache-tomcat-9.0.X\bin)
  3. Enter the command, where "tomcatXYZZ" is the same service name as used in Step 7 of the upgrade procedure:
    • tomcat9w.exe //ES//tomcatXYZZ
  4. Tomcat9w will run and display the configuration for the new Tomcat service

After Upgrade

When updating the version of Tomcat you may encounter 4 failed files when running Application Server IQ.

1 - Do not delete the files and their structure from the folder for the old version of Tomcat.
2 - If you delete them, you will find these 4 files missing, although they will not affect the use of the application.

Files:

Drive\Program Files (x86)\Waters\apache-tomcat-oldversion\webapps\WebVision\ngv_common.js

Drive\Program Files (x86)\Waters\apache-tomcat-oldversion\webapps\WebVision\WEB-INF\lib\NGWebVision.jar

Drive\Program Files (x86)\Waters\apache-tomcat-oldversion\webapps\NGAudit\web-inf\lib\NGAudit.jar

Drive\Program Files (x86)\Waters\apache-tomcat-oldversion\webapps\WebVision\web-inf\lib\ojdbc14.jar

 

id111885, SDMS, SDMS8, SDMS8NU, SUPISDMS, SUPNG

Not able to find a solution? Click here to request help.