What's Changed - Things to Know Before You Upgrade
This article lists important changes in Tableau Server, beginning with version
For information about all the new features in Tableau Server 2019.4, see What's New in Tableau Server.
New tabcmd installer for Windows
The 2019.4 release of Tableau Server features a newly rewritten Setup program for installing tabcmd on Windows.
This update changes some of the command line options. If you have automated the installation of tabcmd, be sure to review the current command line options for the tabcmd Setup program. For more information, see tabcmd and Install Switches and Properties for tabcmd
Updates to Tableau Server Job management
The Job management page has several updates and new options including the following:
The Jobs page now includes Average Run and Average Queue time information for each job.
Improved job cancellation experience. Server and Site admins can now enter customized notes as well as pick recipients of the e-mail when cancelling a job.
- More information is provided in the job detail dialog box, such as: the last time the job was run successfully, and the name of the job creator.
- Canceling flow run jobs is now supported. Previously, in Tableau Server version 2019.3, only extract refreshes and subscriptions were supported.
New Task Type has been added: Encryption jobs.
Failed jobs now includes jobs that have been suspended. Suspended jobs are a sub-status of the failed jobs and have their own icon to distinguish them from other failed jobs.
For more information, see Managing Jobs in Tableau Server.
Updates to tsm maintenance cleanup command
tsm maintenance cleanup command now includes an option to clear the image cache.
In addition, the
--verbose option has been removed from the command. Running the command with the
--verbose option will result in an error. If your organization has automated task using the
tsm maintenance cleanup command with the
--verbose option, update your automation scripts.
Version 2019.3 includes the following changes you should know about before upgrading.
For information about all the new features in Tableau Server 2019.3, see What's New in Tableau Server.
Default cipher suite no longer includes default support for old ciphers
The 2019.3 version of Tableau Server no longer includes default support for Triple-DES, IDEA, and CAMELIA ciphers for SSL connections. These ciphers are no longer considered adequately secure. In the previous versions of the Security Hardening Checklist, we included a recommendation to disable the Triple-DES cipher, which was enabled by default.
Depending on your environment, you may need to make additional configurations before our after upgrading:
If you disabled the Triple-DES cipher as documented in the Checklist, then we recommend running the following commands before you upgrade to 2019.3:
tsm configuration set -k ssl.ciphersuite -d
tsm pending-changes apply
This command reverts Tableau Server to the 2019.2 (and older) default cipher suite configuration. After you have upgraded to 2019.3, Triple-DES, IDEA, and CAMELIA will be removed from the default supported ciphers.
Do not run the command if you made other changes to the
If you did not change the
ssl_ciphersuitekey, then Setup will update the key value to the new default as part of the upgrade process. The new default value for the
If your users still require support for Triple-DES, then we recommend upgrading to more recent browsers that support more secure ciphers. If that is not an option, then you can run the following commands after you have upgraded. The first command sets the
ssl_ciphersuitekey to the pre-2019.3 configuration, which supports Triple-DES:
tsm configuration set -k ssl.ciphersuite -v "HIGH:MEDIUM:!aNULL:!MD5:!RC4"
tsm pending-changes apply
Tableau Server Service Manager has been removed
The Tableau Server Service Manager (tabsvc) has been removed. Instead, systemd manages the Tableau business processes that were previously managed by tabsvc:
- Repository & Cluster Controller
- File Store
- Application Service
- SAML Service
- Data Server
- VizQL Server
- Data Engine
- Cache Server
- Search & Browse
You can use the following scripts to start and stop the business services that tabsvc managed in previous versions:
The scripts are located at
Beginning with Tableau Server 2019.3, server usage data is sent to Tableau by default. This is the case for new installs and upgrades. You have the ability to opt out during installation, upgrade, or at any time after Tableau Server has been installed. For more information about usage data, see Server Usage Data.
To disable the sending of server usage data:
If you are installing Tableau Server for the first time, you can disable this feature during the configuration of initial node settings. For details, see Configure Initial Node Settings.
If you are upgrading Tableau Server, the upgrade-tsm script will let you know about the option and how to disable it.
If you want to have installed or upgraded Tableau Server and want to disable the sending of server usage data, you can do this from the TSM Maintenance page, or from the command line. For details, see Server Usage Data.
Beginning with Tableau Server 2019.3, when you upgrade from version 2019.2 or later, the
upgrade-tsm script no longer requires you to specify a user and password. Version 2019.3 and later take advantage of the Direct access with TSM CLI feature and uses the account you have logged in as to authenticate the upgrade. You can override this behavior with the
--user option, to specify an administrative user. When you do this, you can also provide a password using the
--password option, or enter a password when prompted. Upgrades from versions earlier than 2019.2.0 will still prompt you for a password.
Some tsm command options are no longer configurable
Beginning with Tableau Server 2019.3, the following options are enabled on install and are no longer configurable:
- backgrounder.enable_sort_ jobs_by_job_rank
- backgrounder.enable_task_ run_time_and_job_rank
Version 2019.2 includes the following changes you should know about before upgrading.
For information about all the new features in Tableau Server 2019.2, see What's New in Tableau Server.
Minimum hardware requirements have changed
Beginning with version 2019.2, Tableau Server requires a minimum of 4 cores and 16 GB of RAM in order to install. The installation program will check that the computer you are installing on satisfies these minimums before you can install. If the computer does not meet these hardware minimums, Tableau cannot be installed. For details, see Minimum Hardware Requirements and Recommendations for Tableau Server. For more information about this change, see this Tableau blog post: Updated machine requirements for Tableau Server trials.
Upgrade requires at least 15% free disk space on each node
Upgrading to version 2019.2 includes a version update to the PostGRES database that Tableau uses internally. This update means that a backup of the database is done before upgrading, and that requires a minimum of 15% free space on each node.
"Referrer-Policy" HTTP header added
Beginning in 2019.2, Tableau Server includes the ability to configure Referrer-Policy HTTP header behavior. This policy is enabled with a default behavior that will include the origin URL for all "secure as" connections (policy no-referrer-when-downgrade). In previous versions, the Referrer-Policy header was not included in responses sent by Tableau Server. This change is not likely to impact user scenarios for most browsers. However, we recommend testing browser-based user scenarios after you upgrade to 2019.2. In the event a user scenario is effected, you can disable or change this header behavior. See HTTP Response Headers.
Map-related internet addresses have changed
Beginning in 2019.2, Tableau Server needs access using port 443 to two new map locations:
These replace the address used by previous versions: maps.tableau.com. For details on configuring Tableau Server for proper internet access, see Configuring Proxies for Tableau Server.
Version 2019.1 includes the following changes you should know about before upgrading.
For information about all the new features in Tableau Server 2019.1, see What's New in Tableau Server.
Install to non-default locations (RHEL-like distributions only)
Beginning with version 2019.1, on RHEL-like distributions, you can install Tableau Server to a location other than the default /opt. This is not supported on Ubutu due to limitations of the deb package. For details, see install instructions in Install and Initialize TSM or upgrade instructions in Upgrade Tableau Server on Linux.
In version 2019.1 and later, workbooks and views use higher resolution thumbnails. When you upgrade to Tableau Server version 2019.1 or later, the Backgrounder runs the Enqueue Thumbnails Upgrade job and the Upgrade Thumbnails job, which refreshes thumbnails for any views that have not been edited or published since Tableau version 2018.2 and converts them from low resolution thumbnail images (192 x192 pixels) to high resolution thumbnail images (300 x 300 pixels), as shown in the figure below.
When the Upgrade Thumbnails job refreshes the thumbnail images, the modified date of the view is changed to match the thumbnail update date. The Upgrade Thumbnails job does not change the modified date of workbooks when it updates the contained view's thumbnails.
Thumbnails may appear blurry until the Upgrade Thumbnails job is complete. Depending on the number of workbooks you have, this could a few minutes to a few hours. You may also notice that thumbnail images may appear in low resolution for up to a week after upgrading to Tableau Server 2019.1. For more information, see Upgrade Thumbnails Job.
Project card images
In version 2019.1 and later, project card images will not appear on the project card unless they are added as the last item in the project description and encapsulated with ! (exclamation marks). For more information, see Add a Project Image.
Version 2018.3 includes some changes you should know about before upgrading.
For information about all the new features in Tableau Server 2018.3, see What's New in Tableau Server.
Floating worksheet captions become transparent
To make a floating caption visible again, content authors will need to change the caption background to a color.
Changes to some Data Engine tsm configuration set options
Two new configuration tsm set configuration options have been added:
The new options replace the
hyper.num_task_worker_threads options available in Tableau Server versions 2018.3 and earlier. The
hyper.num_task_worker_threads have been deprecated and will no longer work in 2019.1 and later.
SSL Off-loading and SAML
Beginning with version 2018.3, Tableau Server validates SAML response message returned from the IdP. If your organization terminates SSL connections from the IdP at a proxy server before sending the authentication request to Tableau Server, then users may be unable to login with SAML after you upgrade from 2018.2.
In this scenario, SSL is "off-loaded" at the proxy server, which means the https request is terminated at the proxy server and then forwarded to Tableau Server over http. Since SSL is off-loaded at the proxy, Tableau Server will validate with the protocol that it receives (http), but the IdP response is formatted with https, so validation will fail unless your proxy server includes the X-Forwarded-Proto header set to
https. See Configuring Proxies for Tableau Server.
Version 2018.2 includes some significant changes you should know about before upgrading.
For information about what's new in Tableau Server 2018.2, see What's New in Tableau Server.
The following sections summarize the significant changes to Tableau Server 2018.2 and provide links for additional information.
Apache log files stored in
/logs/httpd now contain records with several formatting improvements, including the following:
- Server names are shown according to the UseCanonicalName setting, which makes it easier to distinguish between nodes in a multi-node server deployment.
- Date and time are now tracked in a single date-and-time string that can be readily recognized as a single value by a variety of data analysis tools, including Tableau Desktop.
- Time zones are now easier to parse
- On Linux, the numerical offset from UTC is provided.
- On Windows, the name of the timezone is enclosed in quotes
Date, time and time zone formatting changes are illustrated by an example log entry from Tableau Server version 2018.1 and earlier releases:
::1 - - 2018-05-09 08:51:48.872 GMT Daylight Time 80 "POST /vizql/w/Regional/v/Obesity/sessions/A971A92AF77A4F4A9813065BDCEB24D6-0:0/commands/tabsrv/render-tooltip-server HTTP/1.1" "-" 200 445 "593" 135021 WvKolPH4UcM5KrzUbLi8EwAAA@E
For purposes of comparison, here is a log entry from Tableau Server version 2018.2:
10.210.24.3 127.0.0.1 - 2018-05-09T16:07:58.120 "GMT Daylight Time" 80 "POST /vizql/w/Superstore/v/Overview/bootstrapSession/sessions/185CCDC854A44765BB0298E93B403879-0:3 HTTP/1.1" "-" 200 136026 "784" 2370951 WvMOzgKIhfzh9kFWO@ow2gAAA1Y
The Read Only site role that was introduced in Tableau Server version 2018.1 is now deprecated. Any users assigned to the Read Only site role in version 2018.1 are reassigned to the Viewer site role after an upgrade to version 2018.2. To learn more about site roles, see Set Users’ Site Roles.
In previous versions, the tabcmd
initialuser command required a
--password parameter to set the initial administrator password. In the tabcmd included with this version of Tableau Server, you can leave the
--password parameter out of the command to be prompted in the shell instead. See initialuser.
We've added new service ports in 2018.2.
Automatic port assignment
For installations where automatic port assignment is enabled (this is recommended and the default) there should be no impact to upgrading. The new ports will be automatically selected on upgrade.
Manual port assignment
If you have disabled automatic port assignment, you will need to manually specify the new ports in your configuration before upgrading. For more information about manually assigning ports, see Manual port assignment.
Ports added in 2018.2
|You must define each of these for every node if you disable dynamic port mapping.|
|hyper.port||Data engine primary port.|
|hyper.connection.port||Data engine connection port.|
|licenseservice.vendor_daemon.port||License service vendor daemon port.|
|samlservice.port||SAML service port.|
|tabadminagent.columbo.port||Administration Agent service discovery port|
|tabadminagent.filetransfer.port||TSM Agent file transfer port.|
|vizportal_0.microservice.extensions.port||Application server extensions port.|
|vizportal_0.monolith_grpc.port||Application server GRPC port.|
Version 2018.1 includes some changes you should know about before upgrading.
For information about what's new in Tableau Server 2018.1, see What's New in Tableau Server.
The following sections summarize the significant changes to Tableau Server 2018.1 and provide links for additional information.
The previously deprecated
--administrator options are no longer available when using the
tabcmd createusers and
tabcmd syncgroup commands. These are breaking changes
for any scripts that still use the
--administrator options. To update your scripts, use the
--role option with these commands to specify the license levels or site roles. For details, see
As of version 2018.1 we have added or expanded the following tsm commands:
tsm maintenace cleanup—The tsm maintenance cleanup command was added in version 10.5.1. For version 2018.1 it has been enhanced with additional options to give you more flexibility. For details, see tsm maintenance cleanup.
tsm reset—Added in version 2018.1, this command allows you to reset the initial administrative user. For details, see tsm reset.
As of version 2018.1 the upgrade-tsm script you run when you upgrade from a previous version now requires you to include the name of a TSM administrator when you run it. For example:
/opt/tableau/tableau_server/packages/scripts.<version_code>/upgrade-tsm -u <tsm_system_admin> -p <tsm_system_admin_password> --accepteula
tsm_system_admin is a user with administrative permissions on the initial node computer.
Version 10.5 includes some changes you should know about before upgrading.
For information about what's new in Tableau Server 10.5, see What's New in Tableau Server.
The following sections summarize the significant changes to Tableau Server 10.5 and provide links for additional information.
Hyper powers the new Data Engine in Tableau Server 10.5 and introduces the changes described below. For more information, see Tableau Server Data Engine.
Beginning with version 10.5, Tableau Installer automatically installs Data Engine when you install file store, Vizportal, VizQLServer, data server, or backgrounder and cannot be installed separately. Every node that has an instance of one of these processes will also have a single instance of the data engine process. You can no longer configure more than one instance of data engine on a node. To learn more about Tableau Server Processes see Tableau Server Processes.
Previously, in versions 10.4 and earlier, for distributed installations, the backgrounder process launched temporary instances of data engine (tdeserver64.exe) process during extract creation or refreshes. In Tableau Server 10.5, a single instance of data engine is installed automatically when you install backgrounder. The backgrounder process uses this single instance of data engine that is installed on the same node. For more information on configuration recommendations, see Distributed Installation Recommendations.
Upgrade may affect your current configuration for a multi-node cluster, especially if you have certain processes isolated on a separate node. For more information, see Tableau Server Data Engine.
Beginning with version 10.5, new extracts use the new .hyper format. The improved data engine can read both the .tde and .hyper file formats, so the latest version of Tableau Server can continue to view and read workbooks that are using .tde extracts.
Existing extracts will not automatically be upgraded to the new .hyper format during the Tableau Server or Tableau Desktop upgrade process. Only when certain extract tasks are performed on the .tde extract, the extract is upgraded to the .hyper format. For example, an automatic or scheduled refresh will upgrade a .tde extract to a .hyper extract.
- For more information on extract upgrades, see Extract Upgrade to .hyper Format.
- For recommendation on how to handle automated or schedule refresh tasks before you upgrade, see Prepare for the Upgrade.
NOTE: Use the Extract API 2.0 to create (.hyper) extracts, which requires Tableau 10.5 and later. If you are using Tableau 10.4 and earlier, continue to use the Tableau SDK to create .tde extracts. The Tableau SDK is no longer being maintained. For more information, see Extract API 2.0.
Upgraded extracts are not backward compatible. After extracts are upgraded from .tde to .hyper format, they cannot be opened or refreshed in Tableau Desktop 10.4 and earlier. Tableau recommends that Tableau Server and all Tableau Desktops in your organization be on the same version and be upgraded to 10.5 on the same schedule. For more information on specific extract compatibility scenarios, see Impact of extract upgrade
The site roles Viewer (can publish) and Unlicensed (can publish) have been deprecated and are no longer available. Users who have either of these site roles on Tableau Server 10.4 or earlier will be reassigned in Tableau Server 10.5.
|Deprecated site role||In 10.5 is reassigned to|
|Viewer (can publish)||Viewer|
|Unlicensed (can publish)||Unlicensed|
You can now create project hierarchies when you want to segment content into sub-sections within a larger area. For example, you might create a project for each department. In each of those top-level projects, you can separate content based on how the audience uses it, such as connecting to certified data versus in-progress collaboration. For more information, see the following articles:
Using tabcmd, you can specify only a top-level project in a project hierarchy. To automate tasks you want to perform on a sub-project or content in a sub-project, you must use the equivalent Tableau REST API call.
Not all actions are available through the REST API. If you use Server on Windows and want to run an unscheduled extract refresh or append a file to an extract, a possible alternative is to use the Tableau Data Extract Command Line Utility.
Filtered search options are now located on the right side of pages, and are hidden by default. The toggle is a dark icon () when the Filters pane is open and a light icon () when the Filters pane is closed. For details on searching, see Search Content.
To use filtered search, click .