Upgrading Tableau Server
Last Modified Date: 25 Aug 2014
Tableau Server upgrades and migrations are designed to be as easy as possible. However, there are some things you should know before beginning your upgrade.
The Pre-Upgrade Checklist article contains important procedures you should perform before you follow the steps in this article. You can also optionally deploy your new version of Tableau Server in a test environment using the data you currently have in production. See Creating a Test Environment for Tableau Server article for steps.
About Tableau Server upgrades
Here are some things to keep in mind when you upgrade Tableau Server:
Active server installations can’t be upgraded: New versions of Tableau Server will not install on the same machine where an active Tableau Server already resides. To upgrade to a new version, you need to either uninstall your earlier version of Tableau Server or install the new version on a different machine.
Uninstall removes the server software, not your data: When you use Add/Remove Programs to uninstall your existing version of Tableau Server (as part of the upgrade process), your data is not removed. The new Tableau Server Setup program will automatically import all of your existing data, including your content, users, and configuration settings.
Bit version: If you are upgrading a distributed installation, the entire cluster must run the same bit version—either all 32-bit or all 64-bit Tableau server software. Tableau started providing 64-bit versions of Tableau Server starting with version 8.1. For details, see the "Bit Version" section of the Pre-Upgrade Checklist article.
Worker upgrades: For major release upgrades (e.g., version 7.0 to 8.0) and minor release upgrades (e.g., version 8.1 to 8.2), you upgrade workers by uninstalling the existing Tableau Server Worker software, then installing the newer version. For maintenance release upgrades (e.g., version 8.0.0 to 8.0.6), the primary Tableau Server can push out updates out to its workers. There's no need to uninstall and reinstall the worker software.
Choosing the type of upgrade
The exact steps you take to upgrade Tableau Server depend on what you want to do with your existing content and whether you’re moving to new hardware as part of the upgrade. There are three different approaches you can take—each is covered in this article:
Follow these steps if you have an existing Tableau Server installed and you want to replace it with the new version and automatically import all of your existing content.
Important: Your existing content will automatically import only if you continue to use the same drive and directory that your server installation used prior to the update. For example, if the installation directory of the earlier server installation was
D:\Tableau, you must use that same directory for your newer installation.
When upgrading from 32-bit to 64-bit, consider the following:
If the 32-bit Tableau Server was installed to the default location, C:\Program Files (x86)\Tableau\Tableau Server, the existing content will automatically import if you install the 64-bit Tableau Server to the default location. The default location is C:\Program Files\Tableau\Tableau Server.
If the 32-bit Tableau Server was installed to the non-default location, then the 64-bit Tableau Server must be installed to the same non-default location for the existing content to automatically import.
Follow the procedures described in the Pre-Upgrade Checklist article. It is critical that you perform tasks like checking your maintenance expiration date, and creating a backup file before performing the remaining steps in this procedure.
Step 2: Distributed installations only
If you removed workers from Tableau Server's configuration in order to create a "clean" backup, add them back by doing the following:
On the primary server, open the configuration utility by selecting Tableau Server <version> > Configure Tableau Server on the Start menu.
In the Configuration utility, select the Servers tab and click Add.
In the next dialog box, type the IP Address for one of the worker machines and specify the same number of processes you originally had.
Click OK, then repeat the above steps for each worker. When you're finished adding workers, click OK again to save changes.
Start the server on the primary machine so that your changes can take effect.
Uninstall the existing server software using Add/Remove Programs in the Control Panel.
In a distributed environment, uninstall the primary machine.
Your data and configuration settings on the machine will be preserved.
Step 4: Distributed installations only
This step only applies if you are running a distributed installation of Tableau Server.
Upgrades to version 8.2: If you are upgrading a distributed installation of version 6.1, 7.0, 8.0, 8.1 to version 8.2, do the following:
Use Add/Remove Programs to uninstall the worker software.
Run version 8.2 of the Tableau Server Worker Software installer on all machines that you want to add to the Tableau Server cluster.
Due to an update to PostgreSQL drivers, you will need to manually upgrade the worker software for the following:
- Upgrades to 8.2.x from 8.2
- Upgrades to 8.1.8 or a later version in Tableau Desktop 8.1.x
- Upgrades to 8.0.12 or a later version in Tableau Desktop 8.0.x
If you are upgrading from 8.2.1 to 8.2.x, there is no need to uninstall your worker software. Installing the new version on your primary Tableau Server (step 5, below) will push updates to the workers.
Download and run the new server installer. If you have a distributed installation, this step is on your primary Tableau Server.
Be sure to select the same path as the previous installation. This allows the installer to detect your previous server content and automatically import your configuration settings and data.
Test and confirm that the upgrade was successful.
If you have just completed an upgrade to a major version of Tableau Server (e.g.,8.1.x to 8.2, etc.), you can remove the tabsvc.bak-* folders from the C:\ProgramData\Tableau\Tableau Server\data directory to allow for additional disk space on the machine.
In a distributed environment, remove the tabsvc.bak folders on each machine running Tableau Server.
Never remove tabsvc folder (without “.bak”). This folder is essential to Tableau Server and contains all Tableau Server data.
The tabsvc.bak-* folders are used to undo changes in case of an unsuccessful upgrade. After a successful upgrade, these backup folders are not needed and it is safe to remove.
Follow these steps if you have an existing Tableau Server installed and you want to replace it with the new version, but you do not want to automatically import your existing content. In other words, you want to perform a "clean" installation on the same machine.
Follow the procedures described in the Pre-Upgrade Checklist article. It is critical that you perform steps like checking your maintenance expiration date, removing any workers from your configuration, and creating a backup file before performing the remaining steps in this procedure.
Uninstall the existing server using the Add/Remove Programs in the Control Panel. If you have a distributed environment, use Add/Remove Programs on your primary machine.
Note: Uninstalling removes the application software, but leaves your data and configuration settings on the machine.
Manually delete the versioned Tableau Server directory. The exact location of the directory depends on your operating system.
C:\Program Files\Tableau\Tableau Server or C:\Program Files (x86)\Tableau\Tableau Server
Important: Deleting this directory removes your existing content so that the new installer does not try to import it into the new server.
Download and run the new Tableau Server installer. This performs a fresh installation. If you have a distributed environment, download and run the new Tableau Server on the primary machine.
Step 5: Distributed installations only
Uninstall the existing Worker using Add/Remove Programs in the Control Panel for each Worker machine.You must also manually delete the Tableau Server directories mentioned in step 3 above.
Run the latest version of the Tableau Server Worker Software installer on all Worker machines that you want to add to the Tableau Server cluster.
Add the workers to your Tableau Server configuration by following the steps in the Installing Worker Servers topic in the Server Online Help.
Follow this procedure if you have never installed Tableau Server on the computer, but you want to migrate your content from your earlier version of Tableau Server.
Follow the procedures described in the Pre-Upgrade Checklist article. It is critical that you perform tasks like checking your maintenance expiration date, removing any workers from your configuration, and creating a back up file before performing the remaining steps in this procedure.
Download and run the new Tableau Server installer on the new computer. This performs a fresh installation.
Now you will use the .tsbak file you created as part of the Pre-Upgrade Checklist to populate your new Tableau database.
Copy the .tsbak file to a folder on the computer running your new installation of Tableau Server. For example,
On your version 8.2 Tableau Server (if it's a distributed installation, this is the primary), open a command prompt as an administrator and type the following:
Do one of the following:
Restore the data and configuration information from your earlier Tableau Server installation to your new one by typing
tabadmin restore <filename>, where
<filename>is the location and name of the .tsbak file. For example:
tabadmin restore C:\mybackups\tabserv.tsbak
Or, to restore only the data from your earlier installation and no configuration information, type the following:
tabadmin restore --no-config C:\mybackups\tabserv.tsbak
Start the server by typing the following:
Step 4: Distributed installations only
Run the latest version of the Tableau Server Worker Software installer on all machines that you want to add to the Tableau Server cluster.
Add the workers to your Tableau Server configuration by following the steps in the Installing Worker Servers topic in the Server Online help.
When the migration process has completed, you have tested the new installation, and it has been approved for use in the production environment, you must deactivate the earlier version of Tableau Server before closing it down and uninstalling it from the machine.
To deactivate Tableau Server:
Select Start > All Programs > Tableau Server > Manage Product Keys.
For each product key, select the product key and click Deactivate.
Note: If you do not have an internet connection, you will be prompted to create an offline return file to complete the deactivation process. See to the process outlined in the Offline Activation article for more information. After you have created the offline return file, save and then send the file to Customer Service. Once the offline return file is processed, another file will be sent back to you to run on your machine to remove the product key and complete the deactivation process.
Rolling Back to a Previous Installation
If for any reason you need to roll back to the prior installation, refer the Rolling Back to an Earlier Installation of Tableau Server article.Alternate Search Terms:downloads, upgrades, migrate, migration, worker, maintenance, backup, release