Upgrading Apache Tomcat for WebFOCUS on Windows

Upgrading Apache Tomcat for WebFOCUS on Windows

book

Article ID: KB0138574

calendar_today

Updated On:

Products Versions
ibi WebFOCUS 9.3.7

Description

This article describes how to upgrade Apache Tomcat 9.x for WebFOCUS on Windows and verify that the upgrade completed successfully.

This procedure is supported only for upgrades within the same Apache Tomcat major release (for example, Tomcat 9.0.104 to Tomcat 9.0.115). It is not intended for major version upgrades, such as Tomcat 8.x to Tomcat 9.x. Major Tomcat releases may introduce changes to configuration files (such as server.xml) that are not backward compatible. Therefore, this procedure should not be used for major version migrations.

Environment

Windows

Resolution

Step 1: From official Apache Tomcat Downloads: https://tomcat.apache.org/download-90.cgi .Download the appropriate Windows 64-bit ZIP package for the desired Tomcat 9.x version.

Step 2: Stop the following Windows services. Verify that the services have completely stopped before proceeding.

  • Apache Tomcat
  • ReportCaster Distribution Server

Step 3: Navigate to the existing Tomcat installation directory (for example, C:\ibi\Tomcat). Create a compressed backup (ZIP or 7-Zip) of the entire Tomcat directory

Step 4: Rename the existing Tomcat directory to Tomcat_OLD. Example: C:\ibi\Tomcat Rename to: C:\ibi\Tomcat_OLD

Step 5: Create a new folder named Tomcat (C:\ibi\Tomcat). Extract the downloaded new version Tomcat ZIP file and copy all extracted files and folders into the new Tomcat directory.

Step 6: If the previous Tomcat installation contains a bundled JDK or JRE directory (for example, jdk), copy that directory from:

           C:\ibi\Tomcat_OLD to C:\ibi\Tomcat

           If Java is installed separately and referenced by the Tomcat service, this step is not required. You may have to run the utility & point the jvm.dll file accordingly

Step 7: From Directory C:\ibi\Tomcat_OLD\conf Copy and Paste the following items into the new conf directory C:\ibi\Tomcat\conf

  • Catalina folder
  • server.xml
  • context.xml
  • tomcat-users.xml (if customized)

Step 8: Navigate to New directory C:\ibi\Tomcat\webapps. Remove the following default directories:

  • docs
  • examples
  • host-manager
  • manager

Step 9: Copy ibi_html file from: C:\ibi\Tomcat_OLD\webapps to C:\ibi\Tomcat\webapps. If your environment contains additional customized WebFOCUS web applications, copy those as well.

Step 10:  Open Windows Services, Locate the Apache Tomcat service. Right-click the service and select Properties. Note the Service Name (Tomcat9WF)

Step 11: Navigate to C:\ibi\Tomcat\bin. Copy tomcat9w.exe within the same folder. Then Rename the copied executable to match the Windows service name(Tomcat9WF.exe) and ensure the renamed executable matches this name.

Step 12: Launch the renamed executable (Tomcat9WF.exe). Verify the following with the old tomcat:

  • Java Virtual Machine path
  • Java Options
  • Startup parameters
    Java Options
    Startup parameters

Also, update the Display Name and Description to reflect the new Tomcat version.

Example: Apache Tomcat 9.0.104 to 9.0.115

Step 13: Start the following services:

  • Apache Tomcat
  • ReportCaster Distribution Server

 

Vaildation & Verification:

Verify Tomcat: Launch http://<machinename>:8080

Confirm that the Apache Tomcat home page loads successfully and displays the expected Tomcat version.

Verify Webfocus: Launch http://<machinename>:8080/ibi_apps

Navigate to: Management Center → Administration Console → Diagnostics → HTTP Request Info

Verify the Application Server Version

 

Rollback Procedure:

If any issues are encountered after the upgrade:

  1. Stop the Apache Tomcat and ReportCaster services.
  2. Delete or rename the new Tomcat directory.
  3. Rename Tomcat_OLD back to Tomcat.
  4. Restart the services.
  5. Verify that WebFOCUS is functioning as expected.

Issue/Introduction

This article provides step-by-step instructions for upgrading Apache Tomcat 9.x in a WebFOCUS Windows environment while preserving the existing configuration and validating the installation after the upgrade.