Upgrading Spotfire

Follow these steps to upgrade your Spotfire environment to the new version of Spotfire. Note that, in most situations, you will do an upgrade to the latest version (for Innovation releases) or to the latest service pack version (the third version number, for LTS versions) instead of applying any separate hotfixes to the system.

About this task

The Spotfire Server upgrade tool copies all relevant settings, including configurations and node manager trust, to your new Spotfire environment.

Before you begin

Before upgrading, create a working backup of your Spotfire database, and, if you are using external storage of the library content, backup your external system. Note that from version 12.0 and forward, library content is compressed by default. Items that are currently stored in the Spotfire library in an uncompressed format will be compressed in the background over time, unless you change the default settings for library compression.
Download the required software from the Spotfire Download site. For details, see Downloading installation software.
Review the System Requirements for both the Spotfire Server and the services you intend to use, and make sure your system fulfils the requirements for the new versions.
For an overview of important changes since the earliest in-support LTS version, see Upgrading between Spotfire LTS versions.

Note: Some versions of Spotfire introduce changes that might require preparation before you upgrade. Before you upgrade from a version earlier than the ones listed below, see the following help topics:

Upgrading to 14.0.8 or 14.5.0 and later: New license management
When upgrading to 14.5.0 or later, as well as if you upgrade from 14.5.0 to 14.6.x or later, you must also follow the steps in Configuring Spotfire Web Clients for OAuth2 with Spotfire Community to register, or re-register, the Web Player service as an OAuth2 client, if you want to enable the full functionality in the clients related to the Spotfire Community.
Upgrading to 14.0 and later: Migrating from TIBCO-branded JDBC drivers
Upgrading to 12.5 and later: Granting the privilege to use triggers for Spotfire databases on Oracle
Upgrading to 12.3 and later: Fixing Microsoft SQL Server JDBC driver-related issues

Procedure

Stop your Spotfire Servers and node managers. For information on how to stop them, see Start or stop Spotfire Server and Starting or stopping a node manager.
Disable automatic restart of your Spotfire servers and node managers to prevent the old installed services from starting automatically and causing a port conflict with the new installation.
This step is needed because each installed version has its unique service name (which includes the service type and version number).

For instructions on Windows, see Preventing Spotfire Servers and node managers from starting automatically.
Install the new version of Spotfire Server. For instructions and details related to the upgrade, see Installation of Spotfire Server during upgrade.
Upgrade the server by running the server upgrade tool on each server. For more information, see Run the Spotfire Server upgrade tool.

Note: If your servers are clustered, run the upgrade tool on all servers in the cluster.

Note: If you run the Spotfire Server as a Windows Service and you have switched to a different Java Development Kit, you must repeat the process described in Switching to another Java Development Kit for the Spotfire Server each time you upgrade.
Start the new Spotfire Servers. For information on how to start the Spotfire Server, see Start or stop Spotfire Server.
Upgrade the nodes by deploying new node manager packages (Spotfire.Dxp.NodeManagerWindows.sdn or Spotfire.Dxp.NodeManagerLinux.sdn) to the server. For more information, see Upgrading nodes.
Restart the node managers. For information on how to start the node managers, see Starting or stopping a node manager (as a Windows service).
Update all client packages and services on all nodes in your environment. For information on how to update the services, see Updating services.
After the upgrade, make sure that the Administrator group has all licenses, including new ones, assigned to it. For a description of the licenses, see the License feature reference.
Optional: Verify or edit changes to service configuration files. Your existing configurations will work in the new version of Spotfire, but some settings have been added or changed and must be updated manually if you do not want to use the default values. For more information, see Upgrading service configurations.
Verify that your Spotfire environment is configured with the correct product license model as determined by your commercial agreement; either the new product licenses (Industry Pro, Analytics, Analysis Consumer, Analysis Viewer) or the legacy product licenses (Analyst, Business Author, Consumer).
See Changing the product license model and Spotfire licenses and license features.