Upgrade Apache Tomcat for Spotfire® Server 7.5 and later

Introduction

The Spotfire Server bundles an Apache Tomcat server. The bundled Apache Tomcat version is usually the most recent and most secure version at the time of the initial release. If you always want to use the most recent Apache Tomcat version, you need to manually upgrade to the newer Apache Tomcat version whenever it is released by The Apache Software Foundation.

Upgrade process

It is possible to perform this upgrade with minimal impact on the Spotfire system. It is however necessary to restart each Spotfire Server at least once. Except for the downloading of the new Apache Tomcat server in step 1, the process outlined below must be followed for each Spotfire Server in your environment.

Download the new Apache Tomcat server.
Back up the Spotfire Server.
Apply Spotfire Server hotfixes.
Prepare the new Apache Tomcat server.
Switch to the new Apache Tomcat server.
Optional: Remove the old Apache Tomcat server.

1. Download the new Apache Tomcat server

Download the new Apache Tomcat server that you want to use. It is only supported to upgrade to a newer Apache Tomcat server of the same major version as the one bundled with the Spotfire Server. (Apache Tomcat 7.0, 8.0, 8.5 and 9.0 are considered major versions.) It is not supported to downgrade to an older Tomcat version (major or minor) than the one bundled with the Spotfire Server, unless you are cleared to do so by Spotfire Support.

If you don't know which version of Apache Tomcat your Spotfire Server installation is using, you can run the following command in a command prompt (Windows) or in a shell (Linux):

<TSS installation directory>\tomcat\bin\version.bat (Windows)
<TSS installation directory>/tomcat/bin/version.sh (Linux)

Make sure to download the correct Apache Tomcat version for your operating system.

If you are running the Spotfire Server on Windows, select the 64-bit Windows ZIP file version.
If you are running the Spotfire Server on Linux, select the generic ZIP file version.

For security reasons, do not forget to check the integrity of the downloaded file by verifying the file's checksum.

2. Back up the Spotfire Server

Before upgrading the Apache Tomcat server, make sure to perform a full backup of the Spotfire Server. Please see the "Backup of Spotfire Server" section in the "Backup and restore" chapter in the Spotfire Server manual.

3. Apply Spotfire Server hotfixes

Before you start the upgrade of the Apache Tomcat server, make sure that you have applied the latest hotfix for your version of the Spotfire Server.

4. Prepare the new Apache Tomcat server

The following section describes how to copy configuration information from the old Apache Tomcat server to the new Apache Tomcat server. Some of the copied information is machine specific, so it is not possible to prepare a single new Apache Tomcat server to be deployed on multiple Spotfire Servers. These steps must be followed once for each Spotfire Server in your environment. Also, make sure to copy - not move - the specified files from the old Apache Tomcat server to the new Apache Tomcat server.

a. Extract the downloaded Apache Tomcat ZIP archive

Apache Tomcat is shipped as a compressed archive. Extract the archive in a temporary directory. Move the extracted Apache Tomcat directory, which is named apache-tomcat-X.Y.Z and where X.Y.Z denotes the version, into the <TSS installation directory>/ directory and rename it to tomcat-X.Y.Z. Make sure not to replace or merge with the old existing <TSS installation directory>/tomcat/ directory.

You will now have the following two Apache Tomcat directories:

<TSS installation directory>/tomcat/
<TSS installation directory>/tomcat-X.Y.Z/

b. Delete Apache Tomcat's default web applications

Apache Tomcat comes with a set of default web applications that must be deleted. They can be found as subdirectories within the <TSS installation directory>/tomcat-X.Y.Z/webapps/ directory. Delete all of them so that the <TSS installation directory>/tomcat-X.Y.Z/webapps/ directory is empty.

c. Copy files from the old Apache Tomcat directory to the new Apache Tomcat directory

Depending on your version of TSS, different files and directories must be copied to the new Apache Tomcat server.

i. Spotfire Server 7.5

If you are running Spotfire Server 7.5, copy the files and directories below from the old <TSS installation directory>/tomcat/ directory to the new <TSS installation directory>/tomcat-X.Y.Z/ directory.

Copy the following directories to the tomcat-X.Y.Z/ directory:

tomcat/application-data/
tomcat/certs/

Copy the following directories to the tomcat-X.Y.Z/webapps/ directory:

tomcat/webapps/spotfire/
tomcat/webapps/ROOT/

Copy the following files to the tomcat-X.Y.Z/bin/ directory:

tomcat/bin/config.bat
tomcat/bin/config.sh
tomcat/bin/service.bat
tomcat/bin/SetComputerPassword.vbs
tomcat/bin/setenv.bat
tomcat/bin/setenv.sh
tomcat/bin/SetupWizard.vbs
tomcat/bin/simple-config-ldap.txt
tomcat/bin/simple-config.txt
tomcat/bin/sqljdbc_auth.dll
tomcat/bin/startuptomcat.bat
tomcat/bin/uiconfig.bat
tomcat/bin/uiconfig.sh

Copy the following files to the tomcat-X.Y.Z/conf/ directory:

tomcat/conf/context.xml
tomcat/conf/logging.properties
tomcat/conf/server.xml
tomcat/conf/web.xml

Copy the following files to tomcat-X.Y.Z/lib/ directory:

tomcat/lib/DDJDBC64Auth05.dll
tomcat/lib/DDJDBCAuth05.dll
tomcat/lib/DDJDBCx64Auth05.dll
tomcat/lib/postgresql-8.4-703.jdbc4.jar
tomcat/lib/sqljdbc4.jar
tomcat/lib/TIdb2.jar
tomcat/lib/TImysql.jar
tomcat/lib/TIoracle.jar
tomcat/lib/TIsqlserver.jar
tomcat/lib/TIsybase.jar
tomcat/lib/tss-ocsp-tomcat-0.1-SNAPSHOT.jar

If you have installed additional JDBC drivers into the tomcat/lib/ directory, then you need to copy those as well.

ii. Spotfire Server 7.6

If you are running Spotfire Server 7.6, copy the files and directories below from the old <TSS installation directory>/tomcat/ directory to the new <TSS installation directory>/tomcat-X.Y.Z/ directory.

Copy the following directories to the tomcat-X.Y.Z/ directory:

tomcat/application-data/
tomcat/certs/

Copy the following directories to the tomcat-X.Y.Z/webapps/ directory:

tomcat/webapps/spotfire/
tomcat/webapps/ROOT/

Copy the following files to the tomcat-X.Y.Z/bin/ directory:

tomcat/bin/config.bat
tomcat/bin/config.sh
tomcat/bin/service.bat
tomcat/bin/SetComputerPassword.vbs
tomcat/bin/setenv.bat
tomcat/bin/setenv.sh
tomcat/bin/SetupWizard.vbs
tomcat/bin/SfWinCon.dll
tomcat/bin/simple-config-ldap.txt
tomcat/bin/simple-config.txt
tomcat/bin/sqljdbc_auth.dll
tomcat/bin/startuptomcat.bat
tomcat/bin/uiconfig.bat
tomcat/bin/uiconfig.sh

Copy the following files to the tomcat-X.Y.Z/conf/ directory:

tomcat/conf/context.xml
tomcat/conf/logging.properties
tomcat/conf/server.xml
tomcat/conf/web.xml

Copy the following files to tomcat-X.Y.Z/lib/ directory:

tomcat/lib/DDJDBC64Auth05.dll
tomcat/lib/DDJDBCAuth05.dll
tomcat/lib/DDJDBCx64Auth05.dll
tomcat/lib/postgresql-8.4-703.jdbc4.jar
tomcat/lib/spotfire-native.jar
tomcat/lib/sqljdbc4.jar
tomcat/lib/TIdb2.jar
tomcat/lib/TImysql.jar
tomcat/lib/TIoracle.jar
tomcat/lib/TIsqlserver.jar
tomcat/lib/TIsybase.jar
tomcat/lib/tss-ocsp-tomcat-0.1-SNAPSHOT.jar

If you have installed additional JDBC drivers into the tomcat/lib/ directory, then you need to copy those as well.

iii. Spotfire Server 7.7 and 7.8

If you are running Spotfire Server 7.7 or 7.8, copy the files and directories below from the old <TSS installation directory>/tomcat/ directory to the new <TSS installation directory>/tomcat-X.Y.Z/ directory.

Copy the following directories to the tomcat-X.Y.Z/ directory:

tomcat/application-data/
tomcat/certs/

Copy the following directories to the tomcat-X.Y.Z/webapps/ directory:

tomcat/webapps/spotfire/
tomcat/webapps/ROOT/

Copy the following files to the tomcat-X.Y.Z/bin/ directory:

tomcat/bin/config.bat
tomcat/bin/config.sh
tomcat/bin/service.bat
tomcat/bin/SetComputerPassword.vbs
tomcat/bin/setenv.bat
tomcat/bin/setenv.sh
tomcat/bin/SetupWizard.vbs
tomcat/bin/SfWinCon.dll
tomcat/bin/simple-config-ldap.txt
tomcat/bin/simple-config.txt
tomcat/bin/sqljdbc_auth.dll
tomcat/bin/uiconfig.bat
tomcat/bin/uiconfig.sh

Copy the following files to the tomcat-X.Y.Z/conf/ directory:

tomcat/conf/context.xml
tomcat/conf/logging.properties
tomcat/conf/server.xml
tomcat/conf/web.xml

Copy the following files to tomcat-X.Y.Z/lib/ directory:

tomcat/lib/DDJDBC64Auth05.dll
tomcat/lib/DDJDBCAuth05.dll
tomcat/lib/DDJDBCx64Auth05.dll
tomcat/lib/postgresql-8.4-703.jdbc4.jar
tomcat/lib/spotfire-native.jar
tomcat/lib/sqljdbc4.jar
tomcat/lib/TIdb2.jar
tomcat/lib/TImysql.jar
tomcat/lib/TIoracle.jar
tomcat/lib/TIsqlserver.jar
tomcat/lib/TIsybase.jar
tomcat/lib/tss-ocsp-tomcat.jar

If you have installed additional JDBC drivers into the tomcat/lib/ directory, then you need to copy those as well.

iv. Spotfire Server 7.9 and later

If you are running Spotfire Server 7.9 or later, copy the files and directories below from the old <TSS installation directory>/tomcat/ directory to the new <TSS installation directory>/tomcat-X.Y.Z/ directory.

Copy the following directories to the tomcat-X.Y.Z/ directory:

tomcat/application-data/
tomcat/certs/
tomcat/spotfire-config/

Copy the following directories to the tomcat-X.Y.Z/webapps/ directory:

tomcat/webapps/spotfire/
tomcat/webapps/ROOT/

Copy the following files to the tomcat-X.Y.Z/bin/ directory:

tomcat/bin/config.bat
tomcat/bin/config.sh
tomcat/bin/service.bat
tomcat/bin/SetComputerPassword.vbs
tomcat/bin/setenv.bat
tomcat/bin/setenv.sh
tomcat/bin/SetupWizard.vbs
tomcat/bin/SfWinCon.dll
tomcat/bin/simple-config-ldap.txt
tomcat/bin/simple-config.txt
tomcat/bin/sqljdbc_auth.dll
tomcat/bin/uiconfig.bat
tomcat/bin/uiconfig.sh

Copy the following files to the tomcat-X.Y.Z/conf/ directory:

tomcat/conf/context.xml
tomcat/conf/logging.properties
tomcat/conf/server.xml
tomcat/conf/web.xml

Copy the following files to tomcat-X.Y.Z/lib/ directory:

tomcat/lib/bcprov-jdk15on.jar
tomcat/lib/DDJDBC64Auth05.dll
tomcat/lib/DDJDBCAuth05.dll
tomcat/lib/DDJDBCx64Auth05.dll
tomcat/lib/postgresql-8.4-703.jdbc4.jar
tomcat/lib/spotfire-native.jar
tomcat/lib/sqljdbc4.jar
tomcat/lib/TIdb2.jar
tomcat/lib/TImysql.jar
tomcat/lib/TIoracle.jar
tomcat/lib/TIsqlserver.jar
tomcat/lib/TIsybase.jar
tomcat/lib/tss-ocsp-tomcat.jar

If you have installed additional JDBC drivers into the tomcat/lib/ directory, then you need to copy those as well.

v. Spotfire Server 10.10.4 / 11.4.0 and later

Copy the following directories to the tomcat-X.Y.Z/ directory:

tomcat/application-data/
tomcat/certs/
tomcat/spotfire-bin/
tomcat/spotfire-boot-lib
tomcat/spotfire-config/
tomcat/spotfire-lib/
tomcat/custom-ext

Copy the following directories to the tomcat-X.Y.Z/webapps/ directory:

tomcat/webapps/spotfire/
tomcat/webapps/ROOT/

Copy the following files to the tomcat-X.Y.Z/bin/ directory:

tomcat/bin/service.bat
tomcat/bin/setenv.bat
tomcat/bin/setenv.sh

Copy the following files to the tomcat-X.Y.Z/conf/ directory:

tomcat/conf/context.xml
tomcat/conf/logging.properties
tomcat/conf/server.xml
tomcat/conf/web.xml
tomcat/conf/Spotfire/localhost/spotfire.xml
tomcat/conf/catalina.properties

If you have installed additional JDBC drivers into the tomcat/lib/ directory, then you need to copy those as well.

5. Switch to the new Apache Tomcat server

When the preparation of the new Apache Tomcat server is done, it is time to switch from the old to the new Apache Tomcat.

Shut down the Spotfire Server.
Rename the directory <TSS installation directory>/tomcat to <TSS installation directory>/tomcat.original.
Rename the directory <TSS installation directory>/tomcat-X.Y.Z to <TSS installation directory>/tomcat.
Start the Spotfire Server.

The Spotfire Server has now been upgraded with a newer Apache Tomcat server.

6. Optional: Remove the old Apache Tomcat server

Once you decide that the old Apache Tomcat server is not needed anymore, it can easily be removed by deleting the <TSS installation directory>/tomcat.original directory. However, it will not cause any problems keeping it. If you remove the old Apache Tomcat server, you cannot revert the Apache Tomcat changes without restoring from a backup. Thus, it is suggested that you perform an extra backup of the Spotfire Server as described in step 2 above before deleting the <TSS installation directory>/tomcat.original directory.

How to revert to the old Apache Tomcat server

If you for some reason need to switch back to the old Apache Tomcat server it is easy to do so, assuming the old Apache Tomcat server has not already been removed.

Shut down the Spotfire Server.
Rename the directory <TSS installation directory>/tomcat to <TSS installation directory>/tomcat.reverted.
Rename the directory <TSS installation directory>/tomcat.original to <TSS installation directory>/tomcat.
Start the Spotfire Server.

The Spotfire Server will now use the original Apache Tomcat version again.

Sign In

Upgrade Apache Tomcat for Spotfire® Server 7.5 and later