# tableau Tableau Desktop and Tableau Prep Deployment (desktopdeploy) - Full Documentation [Skip to main content](#main-content) # Basic Product Data By default Tableau products send usage data to Tableau so that we can understand how customers use our software, and gain insights into where they are successful and where they might run into problems that we can address. For example, this data can help us learn where upgrades are commonly failing and allow us to make product changes to address those issues, or identify what portion of our user base needs informed about a security issue that applies to a specific version of Tableau Server. You can disable the sending of this data at installation time, or later. For details on how to do this, see the instructions for [Tableau Desktop](https://help.tableau.com/current/desktopdeploy/en-us/desktop_deploy_setting_changes.htm#usage) or [Tableau Server](https://help.tableau.com/current/server/en-us/usage_data_server.htm). Even when you disable the sending of product usage data, certain basic product data is sent to Tableau. This Basic Product Data includes information about products and their processes, including which product or process is running, when they start up, what operating system they are running on, licensing information, which machine or cluster of machines has sent the data (using unique pseudonymized identifiers), and whether the product is configured to send product usage data. You can disable the sending of Basic Product Data at the machine level, or at the enterprise level, by blocking traffic sent to **prod.telemetry.tableausoftware.com**. ## Disabling sharing of Basic Product Data on individual computers **Important:** This procedure involves modifying your local `hosts` file. If you do not know what this is, you should not change it. You should only make this change if you understand the implications of making changes to the file, know how to change the file, and have made a backup of the file for safety. Modifying `hosts` files changes network behavior for computers. Detailed instructions for modifying `hosts` files are provided by operating system providers such as Microsoft, Apple or Linux Distributions. 1. Make a copy of your existing hosts file and save it to a computer that is not your Tableau computer. This is your backup, in case you need to reverse your changes. Do not start modifying the file until you have made a backup copy of it. 2. Modify your computer’s `hosts` file to include these lines: \# Stops sending Product Usage to Tableau (prod.telemetry.tableausoftware.com). # Learn more here: http:\\\\tableau.com\\derived-data 127.0.0.1 prod.telemetry.tableausoftware.com The first and second lines are comments, explaining the third line. The third line prevents all traffic to `prod.telemetry.tableausoftware.com` (`http://prod.telemetry.tableausoftware.com/`) from leaving your local machine by sending it to the Internal host loopback address. The data does not get sent outside the computer. ## Disabling the sharing of Basic Product Data at the enterprise level To disable sending of Basic Product Data on an enterprise level, modify your Network Firewall to prevent outbound traffic to `prod.telemetry.tableausoftware.com`. This domain is used by Tableau to receive the Basic Product Data about process launch and shutdown. It is also used for the more general Product Usage Data. Blocking traffic to this domain it you will prevent both kinds of data from being sent. Traffic to this domain will occur on Ports 80 (for initial registration of our Product Data clients) and on Port 443 (for all subsequent traffic). To completely prevent product data from being sent, block all traffic to this domain. For details on how to configure your network firewall, refer to your vendor or your internal IT department. Tableau cannot provide these instructions. [Skip to main content](#main-content) # Before You Install This article provides an overview of the information you need to know before you install Tableau Desktop, Tableau Prep Builder, Tableau Reader, or Tableau Public for yourself or for others in your organization. > [!IMPORTANT] > > Do not install Tableau Prep Builder and Tableau Server on the same computer. However, we do recommend that you install Tableau Prep Builder on the same machine as Tableau Desktop. ## System requirements You can install Tableau Desktop, Tableau Prep Builder, Tableau Reader, or Tableau Public on a Windows computer or a Mac computer. All computers where you're deploying Tableau products must meet the minimum system requirements, such supported operating systems, memory requirements, and supported virtual environments. See the technical specifications for: - [Tableau Desktop](https://www.tableau.com/products/techspecs#desktop) - [Tableau Prep](https://www.tableau.com/products/techspecs#prep) - [Tableau Public](https://www.tableau.com/products/techspecs#public) - [Tableau Reader](https://www.tableau.com/products/techspecs#reader) ### Apple Silicon support As of the 2024.2 release, Tableau Desktop and Tableau Prep Builder include native support for Apple Silicon. Before deploying the installation packages for Tableau Desktop or Tableau Prep Builder for Apple Silicon, review the following Knowledge Base articles: - [Native Apple Silicon support for Tableau Desktop, Prep, Reader, and Public](https://help.salesforce.com/s/articleView?id=002234045&type=1) - [Some Database Connectors are Missing in Apple Silicon version of Tableau Desktop and Prep Builder](https://help.salesforce.com/s/articleView?id=002234044&type=1) - [Apple Silicon (ARM) and Intel Mac Versions of Tableau Prep Builder are Unable to Run Simultaneously](https://help.salesforce.com/s/articleView?id=002234043&type=1) **Note:** Apple Silicon installers for Tableau Desktop and Tableau Prep Builder do not currently support offline activation. This functionality is planned for a future release. If you need to activate offline, use the Intel-based installers. ## Product keys and license management To deploy Tableau Desktop or Tableau Prep Builder you will need to purchase a Creator license or have an existing Creator role on Tableau Server and Tableau Cloud. To purchase a creator license, see [Buy Tableau](https://buy.tableau.com/en-us/). When you purchase a creator license, it activates both Tableau Desktop, Tableau Prep Builder, and includes one Creator license for Tableau Server or Tableau Cloud. After your purchase, you will receive a welcome email that provides the information that you need to download and install the software. If you're in an environment with Tableau Cloud or Tableau Server where login-based license management is being used, see [Find Your Product Key](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_product_key.htm).[](https://help.tableau.com/current/server/en-us/license_lblm.htm) Tableau provides various tools to help you track and manage licensing and usage in your organization. Depending on whether you are using product keys or login-based license management, you'll want to choose the appropriate tool provided by Tableau to help you track and manage licensing. For more information about managing licenses see [Manage Tableau Desktop License Usage](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_reporting_admin.htm). If you are a student or teacher you can request a free one year license. For more information, go to the [Academic programs](https://www.tableau.com/academic) page. Tableau Reader, Tableau Desktop Free Edition, and Tableau Desktop Public Edition are free and don't require a license. ## Ports and internet access Tableau Desktop, Tableau Reader, Tableau Desktop Public Edition, and Tableau Prep Builder were designed to operate with access to the internet and uses common ports (80 and 443). For example, Tableau Desktop requires internet access to load map views, to load web pages in dashboards, and to process license requests. If Tableau doesn't have direct access to the internet, make sure that the required domains are accessible and that the firewall settings on that computer as well as on your organization's network are configured to allow this internet access. Your network administrator might need to configure firewall and proxy settings. If the licensing domain is blocked, the licensing activation process prompts for offline activation, which require access to the internet using a different computer. If Tableau Desktop was activated offline, the upgrade process requires an updated product key. For more information, see the "Activate Tableau Desktop Offline (if needed)" section in [Install From the User Interface](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_download_and_install.htm). For details, see [Required Addresses, Proxies, and Ports](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_proxy.htm). ## Proxy environments Tableau Prep Builder does not support a proxy with pass-through or manual proxy authentication. See [Proxy environment support](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_proxy.htm#proxy). ## Number of installed versions Multiple versions of Tableau Desktop and Tableau Prep Builder can be installed side-by side. The installed items that are shared by each version, such as file types actions, registry entries, and so on, aren't versioned, so they are assigned to last version of the product that was installed. You can only install one version of Tableau Public at one time. ### Troubleshooting Tableau Desktop Free Edition installation If you attempt to install Tableau Desktop Free Edition on a computer that previously had a licensed version installed and using login-based license management (LBLM), you may not see the option to install Free Edition. In this case you need to disable LBLM on your computer before installing Tableau Desktop Free Edition. ## SSL configuration Tableau Desktop and Prep Builder require a chain file in order to connect to an SSL-enabled Tableau Server. To connect to a server that uses SSL, you will need to make sure that the required root certificate is installed on the computer where Tableau Desktop and Prep Builder are installed. For more information, see [Configure SSL](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_ssl.htm). ## Database drivers > [!IMPORTANT] > > Tableau Prep Builder is only available in 64-bit. If you already have 32-bit drivers installed, you'll need to install the 64-bit version of those drivers to connect to your data with Tableau Prep Builder. Tableau uses connectors to connect to different databases, and some connectors require drivers to talk to these databases. When it comes to drivers, the easiest approach is to install Tableau and then try connecting to the data. Tableau lets you know the first time you try to connect by displaying a dialog like the following: ![Alert stating that user needs to download a driver to use the connector.](/tableau/next/en-us/desktopdeploy/en-us/Img/NeedDriver.PNG) If this error appears, click the Download Driver button to go to the [Driver Download](http://www.tableau.com/support/drivers) page on the Tableau website. Follow the instructions for your connector to get the driver you need. Tableau Prep Builder requires a specific driver to connect to an Oracle database. To download the correct driver, on the [Driver Download](https://www.tableau.com/support/drivers#oracle) page, scroll to the bottom of the page and locate the driver for **Tableau Prep Builder: <_version_\>** to install it. For more information about the different connectors that Tableau Desktop supports, see [Connector Examples](https://help.tableau.com/current/pro/desktop/en-us/help.htm#exampleconnections_overview.htm) in the help. ## Compatibility You can run into file compatibility issues when you try to share files between different versions of Tableau Desktop and between Tableau Desktop and Tableau Server and Tableau Cloud. Make sure that the version of Tableau Desktop you're installing and subsequent updates are compatible with the version of Tableau Server being used. For example, you can't publish to Tableau Server from Tableau Desktop if you're using a Tableau Desktop version that is newer than your Tableau Server version. For more information, see [Tableau Version Compatibility](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_version_compat_top.htm). ## Update management (Tableau Desktop only) By default, Tableau Desktop installs dot (maintenance) releases when they become available. If you want to have more control over which version of Tableau Desktop is installed for users, you can turn off the product update feature for your users. You can also control which version of Tableau Desktop your users can update to. You can turn product updates off for each Tableau Desktop during the installation process from the customization page on the installer (Windows) or by including a command-line option. This also turns off the Check for Product Updates feature, which allows users to check for and install the most recent Tableau Desktop maintenance updates to their computer at any time. If Tableau Desktop is already installed, you can deploy a registry (or .plist for Mac) update to existing Tableau Desktop clients to manage updates. For more information about how to control product updates for your users, see [Control Product Updates for Tableau Desktop](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_product_updates_admin.htm). ## File recovery management In the event of a crash, Tableau Desktop and Tableau Prep Builder automatically create and save a recovered version of your work in progress. Tableau Desktop automatically saves your user's workbooks every few minutes. and saves the recovered version of the workbook in the same location as the original file or in the user's My Tableau Repository/Workbooks folder as a Tableau Workbook Recovery (.twbr) file. New workbooks are saved with the name "Book1" plus a numeric ID. Tableau Prep Builder (version 2020.3.3 and later) automatically saves your flow file every time it's modified. In the event of a crash or unexpected shutdown, the recovered version of the file is stored in the user's My Tableau Prep Repository/Recovered Flows folder with the same name, as a Tableau Flow Recovery (.tflr) file. New flows are saved with the name "Flow1". The file recovery feature is enabled by default. Tableau Desktop users can turn this option on and off from the Help menu under Settings and Performance > Enable Autosave. If you want to disable this feature during installation, you can change the setting for the `AUTOSAVE` property. In that case, the Enable Autosave menu option will not be available to the user. Tableau Prep Builder users cannot turn this feature off and on. Instead, administrators can disable the feature during install by changing the setting for the `AUTOSAVE` property. This feature can also be turned off for Tableau Desktop and Tableau Prep Builder by an administrator post-install.  For more information, see [Turn off file recovery](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_setting_changes.htm#autosave_off). ## Other articles in this section [Skip to main content](#main-content) # Change Installation Settings after Installation When you install Tableau Desktop and Tableau Prep Builder, there are several features that are turned on by default. For example, with Tableau Desktop, automatic product updates or the ability to automatically save user workbooks is included as part of the install. But you might have some features that you don't want users to have access to, such as the ability to upload crash dump files and logs. As an administrator you can turn some of these features off. For Windows, you can also configure custom content to show in the Discover pane, replace default accelerator workbooks with custom sample workbooks, and turn some features off during installation. For a list of these features, see [Install From the Command Line](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_automate.htm#installer_properties) in Install Tableau Desktop and Tableau Prep Builder from the Command Line. For Mac, you can configure custom discover pane content, replace default accelerator workbooks with custom workbooks, or turn some features off only after installation. To configure custom content for the Discover pane, replace sample workbook with custom samples, or to change settings after installation (both Windows and Mac), you can change the registry or `.plist` file then restart the application to see your changes. To deploy changes to remote computers, you can export the settings from the registry (Windows) or .plist (Mac) file, modify the settings you want to turn off and then use the modified file to create an automated script to push the updates to each computer where Tableau Desktop is installed. > [!IMPORTANT] > > Always make a backup of the registry file before making any changes to it. Editing the Windows registry incorrectly can have harmful effects on your computer. ## Set your display language (optional) When you first runTableau Desktop or Tableau Prep Builder, it recognizes your computer locale using the User Locale setting and uses the appropriate language if it is supported. If you are using an unsupported language, the application defaults to English. For Tableau Prep Builder, the display format for numbers and dates is based on the locale of the operating system on the machine where the application is installed. For Tableau Desktop you can configure date and number formatting for your workbooks. For more information see [Language and Locale](https://help.tableau.com/current/pro/desktop/en-us/workbook_language.htm) in the Tableau User help. To configure Tableau Desktop or Tableau Prep Builder to display the user interface (menus, messages, etc.) in a different language, do the following, then restart the application to apply the change. 1. Select Help in the top menu. 2. Select Choose Language. 3. Select the language from the list. ## Change your My Tableau Repository location (optional) During install, Tableau Desktop and Tableau Prep Builder automatically creates a My Tableau Repository folder structure in your documents folder on your computer. If you need to move this repository to another location, for example because you are required to have your data on a network server instead of on your local machine, you can specify a new location and point Tableau Desktop or Tableau Prep Builder to the new folder. When setting a new location for your repository, the following rules apply: - The new folder must be a directory. - You must have permissions to write to the new folder. - The new folder can't be located in the existing My Tableau Repository folder structure. **Note**: Changing the repository location does not move the files contained in the original repository. Instead, Tableau creates a new repository where you can store your files. 1. Open Tableau Desktop or Tableau Prep Builder. 2. From the top menu, select File \>Repository Location. 3. In the Select Repository Folder dialog, select a new folder that will act as the new repository location. 4. Restart the application to use the new repository. ## Configure the Discover pane to show custom content (Tableau Desktop only) By default, Tableau provides information such as links to training, blog posts, and public vizzes in the Discover pane in Tableau Desktop to help your users get started using Tableau. The Discover pane shows on launch and persists on the Start page so that these links and information are always at your users fingertips. ![Tableau Discover Pane.](/tableau/next/en-us/desktopdeploy/en-us/Img/custom_discover_pane1.png) However, you may want to use the Discover pane to show content that is specific to your organization instead. To do that you can create your own web page for your content that is hosted on a webserver that you provide using an https enabled URL, then use the DiscoverPane key and a DiscoverPaneURL value to replace the default content provided by Tableau with content from your custom web page. **Note**: For best results don't use web pages that include javascript or redirects. ![Tableau Discover Pane.](/tableau/next/en-us/desktopdeploy/en-us/Img/custom_discover_pane2.png) To help you get started quickly, Tableau Desktop provides a [template](https://github.com/tableau/discover-pane-template) that models the same layout as the Tableau provided Discover pane. Simply download the template and replace the links with your custom content. The template includes a section for metrics, layout structure and links to content. ### Windows You can configure the Discover pane to point to your custom web page during install when installing using the command line by adding the property `DISCOVERPANEURL=""` to the command line. If you want to configure the Discover pane to use your custom content after install is complete, then follow the steps below. Restart the application to see your changes. 1. As an administrator on the computer where Tableau is installed, make a backup of the registry file before you make any changes to it. 2. Open the registry editor (`regedit.exe`). 3. Navigate to the following registry path: `Computer\HKEY_LOCAL_MACHINE\SOFTWARE\Tableau\Tableau `. For example `Computer\HKEY_LOCAL_MACHINE\SOFTWARE\Tableau\Tableau 2020.1` 4. Right-click on your Tableau version and select New > Key and name it DiscoverPane. 5. In the right pane for the new DiscoverPane key, right-click and select New > String Value and name it DiscoverPaneURL. 6. Right-click on the new DiscoverPaneURL string value and select Modify. Then in the Edit String dialog, in the Value data field, enter the URL for your custom web page. You content must be hosted using an https enabled URL. Using an http enabled URL isn't supported.  For example `https://help.tableau.com/current/desktopdeploy/en-us/desktop_deploy_user.htm`. ![Registry Editor displaying directories and settings for various software including Tableau.](/tableau/next/en-us/desktopdeploy/en-us/Img/custom_discover_pane_Regedit.png) 7. To reset the Discover pane back to the Tableau Desktop default content, modify the DiscoverPaneURL value and clear the custom web page URL that you entered, leaving the Value data field blank.  When you restart Tableau Desktop the Discover pane will show the default Tableau content. ### Mac Modify the /Users//Library/Preferences/com.tableau.Tableau-.plist by adding a DiscoverPane key and a DiscoverPaneURL value. Restart the application to see your changes. 1. Set the value to your custom URL by running the following command from the Terminal command prompt. Use the same capitalization as shown below. `defaults write com.tableau.Tableau- DiscoverPane.DiscoverPaneURL ` For example, in Tableau Desktop 2020.1, use this command: `defaults write com.tableau.Tableau- DiscoverPane.DiscoverPaneURL https://help.tableau.com/current/desktopdeploy/en-us/desktop_deploy_user.htm` 2. To reset the Discover pane back to the Tableau Desktop default content, run this command: `defaults write com.tableau.Tableau- DiscoverPane.DiscoverPaneURL " "` When you restart Tableau Desktop the Discover pane will show the default Tableau content. ## Replace accelerator workbooks with custom workbooks (Tableau Desktop only) By default, Tableau provides three packaged accelerators to help users explore Tableau. (Prior to version 2022.2, these accelerators were called sample workbooks.) Starting in version 2021.3, you can create up to 5 packaged workbooks targeted to your specific users and replace the accelerators Tableau provides on the Start page Accelerators section with your custom workbooks. **Note**: When installing Tableau Server, you can choose to include sample workbooks in the Default site. If you checked the Include samples option during installation, you can publish custom sample workbooks from Tableau Desktop to the Tableau Samples project on your server. ![Tableau accelerators offered on the connect page.](/tableau/next/en-us/desktopdeploy/en-us/Img/desktop_custom_samples.png) Custom sample workbooks must meet the following requirements: - You can include a maximum of 5 sample workbooks at one time. - Only packaged workbook (.twbx) files are supported. - Workbooks must be stored in directory on a local machine that Tableau and the user has Read access to. Network directories are not supported. - Workbook file names cannot contain the characters ', ", <, >, or &. **Note**: Custom samples aren't persisted when upgrading to a new release version (for example 2021.4). You'll need to specify the file path for your custom samples when installing your upgrade via the command line or modify the registry (Windows) or .plist (MacOS) post upgrade. ### Before you start **Windows and Mac** Create a directory on your local machine where the samples are stored and add up to 5 sample packaged workbook (.twbx) files. You can replace workbook files as needed, but 5 is the maximum number of workbooks that can be shown on the Start page. For information about replacing custom workbooks, see [Manage custom workbooks](#manage_custom_samples). ### Windows **From the command line** When installing from the command line, add the property `CUSTOMSAMPLESDIR="path to directory"`. For example: `tableauDesktop-64bit-2021-3-0.exe /quiet /norestart ACCEPTEULA=1 CUSTOMSAMPLESDIR="C:\Users\mkim\Documents\My Tableau Repository\CustomSamples"` When you launch Tableau Desktop, you should see your custom samples on the Start page. **Post install from the registry** To configure the custom samples directory after install is complete, follow the steps below. Restart the application to see your changes. 1. As an administrator on the computer where Tableau is installed, make a backup of the registry file before you make any changes to it. 2. Open the registry editor (`regedit.exe`). 3. Navigate to the following registry path: `Computer\HKEY_LOCAL_MACHINE\SOFTWARE\Tableau\Tableau `. For example `Computer\HKEY_LOCAL_MACHINE\SOFTWARE\Tableau\Tableau 2021.3` 4. Create a new folder named Samples. Right-click on the Tableau version folder, select New > Key then rename the new folder. ![A Tableau version menu displaying options to create a new key.](/tableau/next/en-us/desktopdeploy/en-us/Img/desktop_deploy_custom_samples1.png) 5. Right-click on the Samples folder that you just created and select New > String Value and name it CustomSamplesDir. ![A dropdown menu with options such as "New," "Find...," and "Delete."](/tableau/next/en-us/desktopdeploy/en-us/Img/desktop_deploy_custom_samples2.png) 6. Right-click on the new CustomSamplesDir string value and select Modify. Then in the Edit String dialog, in the Value data field, enter the full Windows file path to the directory that you set up previously. ![A registry editor window displaying a hierarchy of folders and files.](/tableau/next/en-us/desktopdeploy/en-us/Img/desktop_deploy_custom_samples3.png) 7. Restart Tableau Desktop to see your changes. The section is now titled Your Custom Workbooks. ![Tableau connection page with custom workbooks.](/tableau/next/en-us/desktopdeploy/en-us/Img/desktop_deploy_custom_samples4.png) 8. To reset back to the Tableau Desktop default content, modify the CustomSamplesDir value and clear the directory path that you entered, leaving the Value data field blank.  When you restart Tableau Desktop the Accelerators section on the Start page will show the default Tableau content. ### Mac Modify the /Users//Library/Preferences/com.tableau.Tableau-.plist by adding a Samples.CustomSamplesDir key and the sample directory path value. Restart the application to see your changes. 1. Set the value to your custom samples directory by running the following command from the Terminal command prompt. Use the same capitalization as shown below. `defaults write com.tableau.Tableau- Samples.CustomSamplesDir ` For example, in Tableau Desktop 2021.3, use this command: `defaults write com.tableau.Tableau-2021.3.0 Samples.CustomSamplesDir "/Users/mkim/Documents/My Tableau Repository/CustomSamples"` 2. To reset back to the Tableau Desktop default content, run this command: `defaults write com.tableau.Tableau- Samples.CustomSamplesDir " "` When you restart Tableau Desktop the Accelerators section on the Start page will show the default Tableau content. ### Manage custom workbooks When you add custom sample workbooks to Tableau Desktop, a custom.manifest file and worksheet thumbnail images are automatically generated in the custom samples folder that you created when you first open the application. When replacing custom sample workbooks with new workbooks, you'll need to delete the custom.manifest file so a new file can be generated. Deleting the worksheet thumbnail images is optional. ![A window that shows a list of files, including a document and several line graphs.](/tableau/next/en-us/desktopdeploy/en-us/Img/desktop_deploy_custom_samples5.png) 1. Navigate to the custom samples folder in your local directory. 2. Delete the custom.mainfest file. 3. Delete or move the workbooks and any worksheet thumbnail images (optional) for those workbooks from the custom samples folder. 4. Add your new packaged (.twbx) workbooks to your custom samples folder. 5. Restart the application. ## Turn off product updates The Product Updates feature lets users receive product updates automatically or check for and install maintenance updates as they become available. To turn off Product Updates after Tableau Desktop is installed, you must update the `AutoUpdateAllowed` key in the registry (Windows) or in the `.plist` file (Mac) for each computer where Tableau is installed. ### Windows 1. As an administrator on the computer where Tableau is installed, make a backup of the registry file before you make any changes to it. 2. Open the registry editor (`regedit.exe`). 3. Set the `AutoUpdateAllowed` registry key to `0`. The following table lists the location of the key for different products.
Product Location (64-bit Tableau and Windows)

Tableau Desktop

HKEY_LOCAL_MACHINE\SOFTWARE\Tableau\Tableau <version>\AutoUpdate

Tableau Desktop Public Edition

HKEY_LOCAL_MACHINE\SOFTWARE\Tableau\Tableau Public <version>\AutoUpdate

Tableau Reader

HKEY_LOCAL_MACHINE\SOFTWARE\Tableau\Tableau Reader <version>\AutoUpdate
To enable product updates again, follow the same procedure but set the registry key to `1` instead of `0`. ### Mac Run one of the following commands from the Terminal command prompt.
Product Command
Tableau Desktop defaults write com.tableau.Tableau-<version> AutoUpdate.AutoUpdateAllowed "0"

For example, in Tableau Desktop 2019.1, use this command:

defaults write com.tableau.Tableau-2019.1 AutoUpdate.AutoUpdateAllowed "0"

Tableau Desktop Public Edition defaults write com.tableau.Tableau-Public-<version> AutoUpdate.AutoUpdateAllowed "0"
Tableau Reader defaults write com.tableau.Tableau-Reader-<version> AutoUpdate.AutoUpdateAllowed "0"
To enable product updates again, run the same command but specify `1` instead of `0`. ## Turn off file recovery The file recovery feature enables Tableau Desktop and Tableau Prep Builder (version 2020.3.3 and later) to save your user's workbooks or flow files so that they don't lose work in the event that the application stops unexpectedly. When the user reopens Tableau, a dialog box is shown with a list of the recovered files to select from. The user can open their recovered files and continue where they left off, or they can delete any files they don't want. If they delete the files, then any changes they made since the last time they saved are discarded. If they delete all of the recovered files in the list for Tableau Desktop or from the Recovered Flows folder for Tableau Prep Builder, the recovery dialog box no longer shows until new recovered files are generated. The file recovery feature is enabled by default. If you want to disable it, you can change the setting for the `AUTOSAVE` property (Tableau Desktop) or the maestro.appSettings.autosave setting (Tableau prep Builder). Click the tab for your product to view the steps to turn off file recovery. When you turn off the file recovery feature, the Enable Autosave menu option will not be available to the user. If you want to re-enable the feature after install, you can deploy a registry (or .plist for Mac) update to change the `AUTOSAVE` property setting for each computer where Tableau is installed. For more information about how to control this setting during install from the command line, see [Install From the Command Line](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_automate.htm#installer_properties). To turn off file recovery after Tableau Desktop is installed, you must update the `AutosaveAllowed` key in the registry (Windows) or in the `.plist` file (Mac) for each computer where Tableau is installed. ### Windows 1. As an administrator on the computer where Tableau Desktop is installed, make a backup of the registry file before you make any changes to it. 2. Open the Registry Editor (`regedit.exe`). 3. Set the `AutosaveAllowed` registry key to `0`. Registry key location: `HKEY_LOCAL_MACHINE\SOFTWARE\Tableau\Tableau __\Autosave` To enable file recovery again, follow the same procedure but set the `AutosaveAllowed` registry key to `1` instead of `0`. ### Mac Run the following command from the Terminal command prompt. `defaults write com.tableau.Tableau-__ Autosave.AutosaveAllowed "0"` For example, in Tableau Desktop 2020.3, use this command: `defaults write com.tableau.Tableau-2020.3 Autosave.AutosaveAllowed "0"` To enable file recovery again, run the same command but specify `Autosave.AutosaveAllowed "1"` instead of `"0"`. During install, you can turn off the file recovery feature from the command line (Windows) or by clearing the Enable crash recovery check box on the Installation Type step in the custom install section (MacOS). For information about how to turn off the file recovery feature during install, see [Before you begin](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_download_and_install.htm#Install). To enable or turn off the file recovery feature after Tableau Prep Builder is installed, you must change the property for the `maestro.appSettings.autosave` setting for each computer where Tableau Prep Builder is installed. ### Windows 1. As an administrator on the computer where Tableau Prep Builder is installed, navigate to the app folder. For example: `C:\Program Files\Tableau\Tableau Prep Builder 2020.3\resources\app` 2. In the app folder open the `application.properties` file. 3. Set `maestro.appSettings.autosave=false` To enable file recovery again, follow the same procedure but set `maestro.appSettings.autosave=true`. ### Mac 1. Navigate to `/Library/Application Support/Tableau Prep Builder/` 2. Open the `application.properties` file in a text editor. 3. Change `maestro.appSettings.autosave=true` to `maestro.appSettings.autosave=false` 4. Save your changes and close the file. To enable file recovery again, follow the same procedure, except change `maestro.appSettings.autosave=false` to `maestro.appSettings.autosave=true`. ## Turn off usage reporting Tableau collects data that helps us learn how our products are being used so we can improve existing features and develop new ones. All usage data is collected and handled according to the [Privacy Policy](https://www.salesforce.com/company/privacy/). If you don't want to participate in this option, you can opt out during or after install. For information about the types of data we collect, see [Tableau Product Usage Data](https://www.tableau.com/product-usage-data). If you don't want to participate in this option, you can opt out by selecting the opt out check box during installation or from the command line (Windows) by adding a command line that includes the property `SENDTELEMETRY="0"`. For information about disabling this option in the user interface see [Install From the User Interface](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_download_and_install.htm). For information about disabling this option from the command line, see [Install From the Command Line](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_automate.htm#Installer_options). Even when you disable the sending of product usage data, certain basic product data is sent to Tableau. If you don't want to send basic product data to Tableau, you can also disable this option. For more information, see [Basic Product Data](https://help.tableau.com/v0.0/desktopdeploy/en-us/usage_data_basic_product_data.htm). To opt out of this option after installation do one of the following: ### From the product 1. Open Tableau Desktop. 2. From the top menu, select Help >Settings and Performance. 3. Click on Don't send product usage data. ![The Settings and Performance submenu showing the option to opt out of sharing product usage data.](/tableau/next/en-us/desktopdeploy/en-us/Img/prep_usage_data_optout.png) ### From the registry To turn off usage reporting at the system level, follow the instructions for your operating system. **Windows** Open a command prompt and run the following command: `REG ADD "HKLM\Software\Tableau\\Telemetry" /v TelemetryEnabled /t REG_DWORD /d 0` Alternatively, follow these steps: 1. As an administrator on the computer where Tableau Desktop is installed, make a backup of the registry file before you make any changes to it. 2. Open the Registry Editor (`regedit.exe`). 3. Set the `TelemetryEnabled` registry key to `0`. Registry key location: `HKEY_LOCAL_MACHINE\SOFTWARE\Tableau\Tableau __\Telemetry` To enable usage reporting again, follow the same procedure but set the registry key to `1` instead of `0`. Mac Run the following command from the Terminal command prompt. `defaults write com.tableau.Tableau-__ Telemetry.TelemetryEnabled "0"` For example, in Tableau Desktop 2019.4, use this command: `defaults write com.tableau.Tableau-2019.4 Telemetry.TelemetryEnabled "0"` To enable usage reporting again, run the same command but specify `1` instead of `0`. To opt out of this option after installation do one of the following: ### From the product 1. Open Tableau Prep Builder as an administrator. - **Windows**: Right-click the application and select Run as Administrator. - **MacOS**: From the Terminal command prompt, run `sudo /Applications/Tableau\ Prep\ Builder\ .app/Contents/MacOS/Tableau\ Prep\ Builder`. 2. From the top menu, select Help >Settings and Performance. 3. Click on Don't send product usage data. **Note**: In version 2019.3.2 and earlier, click on Share Usage Data To Improve Tableau Prep Builder to clear the check mark ![The Settings and Performance submenu showing the option to opt out of sharing product usage data.](/tableau/next/en-us/desktopdeploy/en-us/Img/prep_usage_data_optout.png) #### From the properties file **Windows** 1. Navigate to the app folder in the directory where Tableau Prep Builder is installed. For example `C:\Program Files\Tableau\Tableau Prep Builder \resources\app` 2. Open the telemetryConfig.properties file in a text editor. 3. Change `maestro.telemetry.enabled=true` to `maestro.telemetry.enabled=false` 4. Save your changes and close the file. **Mac** For Mac, this setting is user-specific. This setting doesn't apply to any other users on the system unless they reinstall the application. 1. Navigate to `~/Library/Application Support/Tableau Prep Builder/` 2. Open the telemetryConfig.properties file in a text editor. 3. Change `maestro.telemetry.enabled=true` to `maestro.telemetry.enabled=false` 4. Save your changes and close the file. ## Turn off error reporting If Tableau Desktop or Tableau Prep Builder has a problem and shuts down unexpectedly, crash dump files and logs are generated and placed in the Logs folder in your My Tableau or My Tableau Prep Builder repository. This option is enabled by default. The data in these files can include machine-specific information, a snapshot of the contents of the memory at the time of the crash (this can include application activity details, data connection information, actions taken by the user or data being worked on in Tableau), and customer-identifiable information. If your organization is subject to data privacy regulations, you can disable this option. You will need to complete different steps to disable this option for Tableau Desktop versus Tableau Prep Builder. Click on the tabs below to view the instructions for your application. For Tableau Desktop, the next time the user opens the application, a dialog prompt opens that enables the user to take one of the following actions: - Upload the crash files. - Decline to upload the crash files. - Permanently opt out from uploading the crash files. If the user uploads the files, they are zipped together into an encrypted package using a 2048-bit RSA key and sent to Tableau so that an engineer can analyze and identify the issues that caused the crash. The encrypted package includes: - Crash dump files (.dmp) - Error log files related to the crash (.log) - Manifest files related to the crash (.maifest) If your organization is subject to data privacy regulations, you can disable this prompt from showing by editing the registry (Windows) or running a script (Mac) on each desktop to prevent users from uploading the crash dump files and logs. ### Windows 1. As an administrator on the computer where Tableau is installed, make a backup of the registry file before you make any changes to it. 2. Open the Registry Editor (`regedit.exe`) 3. Set the `CrashReportUpload` registry key to `2`. Registry key location: `HKEY_CURRENT_USER\Software\Tableau\__\Prompts` ### Mac Run the following command from the Terminal command prompt: `defaults write com.tableau-.plist Prompts.CrashReportUpload -string 2` For example in Tableau Desktop 2019.1, use this command: `defaults write com.tableau.Tableau-2019.1.plist Prompts.CrashReportUpload -string 2` For Tableau Prep Builder on Windows, you can turn off the error reporting option during install by either clearing the Enable error reporting check box on the Customize dialog or from the command line by including the property `CRASHDUMP="0"`. To turn this option off after install add the line `maestro.enable_fault_reporting=false` to the application properties section of the application.properties file. This file is located in `C:\Program Files\Tableau\\resources\app` . ## Turn off Web Page objects for dashboards (Tableau Desktop only) Web Page objects display targeted URLs in a section of a dashboard. During installation, see [Install From the Command Line](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_automate.htm#installer_properties) to disable the display of URLs in these objects. After installation, complete the steps below. ### Windows 1. As an administrator on the computer where Tableau is installed, make a backup of the registry file before you make any changes to it. 2. Open the Registry Editor (`regedit.exe`) 3. Set the `WebViewToggleWebZonesEnabled` registry key to `0`. Registry key location: `HKEY_LOCAL_MACHINE\SOFTWARE\Tableau\__\Settings` ### Mac Run the following command from the Terminal command prompt. `defaults write /Library/Preferences/com.tableau.Tableau-.plist Settings.WebViewToggleWebZonesEnabled -integer 0` For example, in Tableau Desktop 2020.4 use this command: `defaults write /Library/Preferences/com.tableau.Tableau-2020.4.plist Settings.WebViewToggleWebZonesEnabled -integer 0` To enable Web Page objects again, run the same command but specify `-integer 1` instead of `-integer 0`. ## Disable Dashboard and Viz extensions (Tableau Desktop only) Dashboard and viz extensions expand the dashboard and native visual capabilities of Tableau with the help of web applications created by Tableau and third-party developers. Tableau supports two standards of extensions: Tableau Trusted extensions, which run on Tableau web servers and undergo Tableau-led reviews before they are deployed, or network-enabled extensions, which run on third-party web servers. Network-enabled extensions support scenarios including instances where the extensions are hosted directly inside your local network or hosted by non-Tableau third-party service outside your local network, such as as a production service provided by a Partner developer... For more information about dashboard and viz extensions, see [Use Dashboard Extensions](https://help.tableau.com/current/pro/desktop/en-us/help.htm#dashboard_extensions.htm) and [Add Viz Extensions to Your Worksheet](https://help.tableau.com/current/pro/desktop/en-us/viz_extensions.htm). For more information about deployment options, see [Extension Security - Best Practices for Deployment](https://help.tableau.com/current/server/en-us/security_extensions.htm). Extensions are enabled by default, allowing the use of Tableau Trusted extensions and network-enabled extensions on Tableau Desktop. Tableau Trusted extensions run automatically, while network-enabled extensions require user permission before running. If you want to disable extensions during install, set the following properties. For more information, see [Install From the Command Line](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_automate.htm#installer_properties). - `DISABLEEXTENSIONS="1"`: Disables all extension types. - `DISABLENETWORKEXTENSIONS`\="1": Disables only network-enabled extensions. - `DISABLESANDBOXEXTENSIONS`\="1": Disables only sandboxed extensions hosted by Tableau - `DISABLETABTRUSTEDEXTENSIONS` ="1": Disables only Tableau-built extensions hosted by Tableau - `DISABLE3PTRUSTEDEXTENSIONS` ="1": Disables only Tableau Trusted Partner-built extensions hosted by Tableau These configurations will disable use of extensions or specific types of extensions from use for the Tableau Desktop install. Users will still see options to load dashboard and viz extensions, and have access to Tableau Exchange, but Tableau Desktop will block the use of extensions from running based on the configurations applied. ### Disable all extensions after install To disable all extensions after install, edit the registry (Windows) or run a script (MacOS) on each desktop using the following instructions. #### Windows 1. As an administrator on the computer where Tableau is installed, make a backup of the registry file before you make any changes to it. 2. Open the Registry Editor (`regedit.exe`) 3. Set the `DisableExtensions` registry key to 1. Registry key location: `HKEY_LOCAL_MACHINE\SOFTWARE\Tableau\Tableau \Settings\Extensions\DisableExtensions` #### Mac Run the following command from the Terminal command prompt: `defaults write com.tableau.tableau-.plist Settings.Extensions.DisableExtensions "1"` For example in Tableau Desktop 2019.4, use this command: `defaults write com.tableau.tableau-2019.4.plist Settings.Extensions.DisableExtensions "1"` ### Disable specific types of extensions after install Starting in Tableau Desktop 2025.3, desktop administrators may enable and disable specific types of extensions after install. Edit the registry (Windows) or run a script (MacOS) on each desktop using the following instructions. #### Windows As an administrator on the computer where Tableau is installed, make a backup of the registry file before you make any changes to it. Open the Registry Editor (regedit.exe) Update any of the following registry keys to 1 to disable use for each type of extension: - `DISABLENETWORKEXTENSIONS`\="1": Disables only Network-enabled extensions. - `DISABLESANDBOXEXTENSIONS`\="1": Disables only sandboxed extensions hosted by Tableau - `DISABLETABTRUSTEDEXTENSIONS` \="1": Disables only Tableau-Built extensions hosted by Tableau - `DISABLE3PTRUSTEDEXTENSIONS` \="1": Disables only Tableau Trusted Partner-built extensions hosted by Tableau Registry key location: `HKEY_LOCAL_MACHINE\SOFTWARE\Tableau\Tableau \Settings\Extensions\` #### Mac Run any of the following command from the Terminal command prompt: - To disable only Network-enabled extensions: `defaults write com.tableau.tableau-.plist Settings.Extensions.DisableNetworkExtensions` "1" - To disable only Sandboxed extensions hosted by Tableau: `defaults write com.tableau.tableau-.plist Settings.Extensions.DisableSandboxExtensions` "1" - To disable only Tableau-Built extensions hosted by Tableau: `defaults write com.tableau.tableau-.plist Settings.Extensions.DisableTabTrustedExtensions` "1" - To disable only Tableau Trusted Partner-built extensions hosted by Tableau : `defaults write com.tableau.tableau-.plist Settings.Extensions.Disable3PTrustedExtensions` "1" For example, to disable use of only network-enabled extensions in a Mac Tableau Desktop 2025.3, use this command: `defaults write com.tableau.tableau-2025.3.plist Settings.Extensions.DisableNetworkExtensions` "1" ## Change the log folder location To change the default log folder location on Tableau Desktop see the Knowledge Article, [Changing the log folder location on Tableau Desktop](https://help.salesforce.com/s/articleView?id=005166930&type=1). [Skip to main content](#main-content) # Command Line Options and Properties The Tableau installer command line accepts two types of values: options and properties. Options are a list of flags that control the behavior of the command line. Properties provide the action or list of actions that you want implemented. ## Installer options You can specify one or more options as part of the command line. Note the following about options: - Each option is prefixed with a slash (`/`). - Options must come before properties.
OptionDescription
quietRun the installer without messages (status or installation progress) and without requiring user interaction. The product doesn't launch after installation is complete.
passiveRun the installer and display dialog boxes and installation status. But does not prompt the user for input. The product launches after installation is complete.
norestartSuppress any attempts to restart. By default, the installer will prompt you before restart unless you run the installer in quiet mode.
log "logfile.txt"Log installation information to the specified path and file. Specify the path and file name, such as /log "c:\logs\logfile.txt". The default log file is the system %TEMP% directory.
repairRun the installer to repair an existing installation of Tableau.
uninstallUninstall an existing installation of Tableau.
hHelp—lists options and properties for the installer.
## Installer properties You can include one or more properties in the command line for the installer. Note the following about these properties: - These properties can't be used to update any settings after initial installation. - Property names and values are case sensitive. - There are no spaces on either side of the equal sign. - Each property set is delimited with a space. - Some properties are version specific.
Property Description Product Version Value
ACCEPTEULA Accept the End User License Agreement (EULA). If you don't set this option to 1, Tableau cannot be installed using quiet or passive mode. Tableau Desktop: All versions

Prep: All versions

Reader: All versions

Public: All versions

1=Accept
0=Don't accept (default)
ACTIVATE_KEY Activate Tableau Desktop or Tableau Prep Builder from the command line. You will need your product key unless you're activating in an environment that uses login-based license management. Add a single command line that includes the installer option ACTIVATE_KEY="<key>". The installer runs -activate to apply the product key.

For more information, see Activate Tableau Desktop and Tableau Prep Builder.

Tableau Desktop: All versions

Prep: 2018.1.2 and later

Reader: Not available

Public: Not available

Product key entered using quotes.
ACTIVATIONSERVER Sets the default URL for the Tableau Server you want users to use for activation when using login-based license management.

For more information, see Login-based License Management.

Tableau Desktop: All versions

Prep: All versions

Reader: Not available

Public: Not available

The URL of the Tableau Server that will authorize users.
ATRENABLED Enable virtual desktop support. You need to enable this at install or by editing the registry if you want to use automatic license deactivation for virtual desktop support.

For more information, see Configure Virtual Desktop Support.

Tableau Desktop: All versions

Prep:All versions

Reader: Not available

Public: Not available

1=Enabled (default)
0=Not enabled
ATRREQUESTEDDURATIONSECONDS Set the length of time Tableau Desktop or Tableau Prep Builder can run without contacting the ATR service before its license is automatically deactivated. The default is 1209600 seconds (14 days). This only applies if ATREnabled is set.

You do not need to set this option if you want to use the default of 14 days. To change the interval, specify the new interval in seconds using this option. For example, the following command installs Tableau Desktop, configures it for automatic license deactivation, and sets the duration to 14400 seconds (4 hours):

tableau-setup-std-x64.exe /quiet ACCEPTEULA=1 ATRENABLED=1 ATRREQUESTEDDURATIONSECONDS=14400

Tableau Desktop: All versions

Prep: All versions

Reader: Not available

Public: Not available

An integer value, in seconds. Minimum is 14400 seconds (4 hours) and maximum is 15552000 seconds (six months).

 

AUTOSAVE Configure Tableau to automatically save your work. In the event that Tableau closes unexpectedly, users can open a recovered version of the workbook (.twbr) file or flow (.tflr) file.

Tableau Desktop: If you select AUTOSAVE=0, the option to change the Autosave setting on the Help menu is disabled for users.

This option is not available for Tableau Reader or Tableau Public.

For more information see Turn off file recovery.

Tableau Desktop: All versions

Prep: All versions

Reader: Not available

Public: Not available

1=Yes (default)
0=No
AUTOUPDATE Configure Tableau to check for product updates. You can also control which version of Tableau Desktop your users will update to.

If you select AUTOUPDATE=0, the option to change the Auto Update and the Check for Product Update settings on the Help menu in Tableau Desktop is disabled for users. For more information, see Control Product Updates for Tableau Desktop.
Tableau Desktop: All versions

Prep: Not Available

Reader: Not Available

Public: All versions

1=Yes (default)
0=No
AUTOUPDATESERVER Specify which server to check for Tableau product updates. You can control updates for your users by customizing and hosting the TableauAutoUpdate.xml file along with the appropriate Tableau installer. For more information, see Control Product Updates for Tableau Desktop. Tableau Desktop: All versions

Prep: Not Available

Reader: Not Available

Public: Not Available

A host name, such as assets.internal.lan. The default is
downloads.tableau.com
CRASHDUMP If Tableau has a problem and shuts down unexpectedly, crash dump files and logs are generated. Use this option to enable or disable this option from the command line.

For more information, see Turn off error reporting.

This option is not available on the Mac.

Tableau Desktop: All versions

Prep: All versions

Reader: All versions

Public: All versions

1=Yes (default)
0=No
CUSTOMSAMPLESDIR Specify a local directory path to custom sample workbooks. You can replace the default Tableau accelerator workbooks with up to 5 custom sample workbooks for your organization.

For more information, see Replace accelerator workbooks with custom workbooks (Tableau Desktop only).

Applies to Tableau Desktop only.

Tableau Desktop: All versions

Prep: Not available

Reader: Not available

Public: Not available

The full local file path to the custom samples directory that you created.

For example "C:\Users\mkim\Documents\My Tableau Repository\CustomSamples"

Network directories aren't supported.

DESKTOPSHORTCUT Create a desktop shortcut. Tableau Desktop: All versions

Prep: All versions

Reader: All versions

Public: All versions

1=Yes (default)
0=No
DISABLEEXTENSIONS Enable viz and dashboard extensions to expand functionality with the help of web applications created by Tableau and third-party developers.

By default, extensions are allowed. If you don't want to make this option available to your users set DISABLEEXTENSIONS=1 to disable this functionality.

For more information about this feature, see Use Dashboard Extensions or Add Viz Extensions to Your Worksheet in the Tableau Desktop online help. For more information about data security when using extensions, see Extension Security - Best Practices for Deployment. For information about how to disable this feature after install, see Disable Dashboard and Viz extensions (Tableau Desktop only).

Tableau Desktop: All versions

Prep:Not available

Reader: All Versions

Public: Not available

1=Yes
0=No (default)
DISABLENETWORKEXTENSIONS Network-enabled extensions are extensions that run on non-Tableau web servers that can be located inside or outside of your local network. Network-enabled extensions could potentially communicate with other web resources, depending on their design. If you don't want to make this option available to your users set DISABLENETWORKEXTENSIONS=1.

For more information about extensions, see Data security, Network-enabled and Sandbox-extensions in the Tableau Desktop help. For information about data security when using extensions, see Extension Security - Best Practices for Deployment. For information about how to disable this feature after install, see Disable Dashboard and Viz extensions (Tableau Desktop only).

Tableau Desktop: All versions

Prep: Not available

Reader: All Versions

Public: Not available

1=Yes
0=No (default)
DISABLESANDBOXEXTENSIONS

Tableau Sandboxed extensions are Tableau trusted extensions that run on Tableau web servers. These extensions employ W3C standards, such as Content Security Policy (CSP), to ensure the extension can’t make network calls outside of the Tableau Sandboxed extension host. If you don't want to make this option available to your users set DISABLESANDBOXEXTENSIONS=1.

For more information about this feature, see Use Dashboard Extensions or Add Viz Extensions to Your Worksheet in the Tableau Desktop online help. For more information about data security when using extensions, see Extension Security - Best Practices for Deployment. For information about how to disable this feature after install, see Disable Dashboard and Viz extensions (Tableau Desktop only).

Tableau Desktop: 2025.3 and later

Prep: Not available

Reader: All Versions

Public: Not available

1=Yes

0=No (default)

DISABLETABTRUSTEDEXTENSIONS

Tableau-built extensions are Tableau Trusted extensions that run on Tableau web servers. These extensions are built by and maintained by Tableau Development, following Salesforce Software Development Lifecyle (SDLC) standards. If you don't want to make this option available to your users set DISABLETABTRUSTEDEXTENSIONS=1.

For more information about this feature, see Use Dashboard Extensions or Add Viz Extensions to Your Worksheet in the Tableau Desktop online help. For more information about data security when using extensions, see Extension Security - Best Practices for Deployment. For information about how to disable this feature after install, see Disable Dashboard and Viz extensions (Tableau Desktop only).

Tableau Desktop: 2025.3 and later

Prep: Not available

Reader: All Versions

Public: Not available

1=Yes

0=No (default)

DISABLE3PTRUSTEDEXTENSIONS

Tableau Trusted Partner-built extensions are Tableau Trusted extensions that run on Tableau web servers. These extensions are developed and maintained by third-party accredited Salesforce or Tableau partners on Tableau Exchange, but reviewed and deployed by Tableau. If you don't want to make this option available to your users set DISABLE3PTRUSTEDEXTENSIONS=1.

For more information about this feature, see Use Dashboard Extensions or Add Viz Extensions to Your Worksheet in the Tableau Desktop online help. For more information about data security when using extensions, see Extension Security - Best Practices for Deployment. For information about how to disable this feature after install, see Disable Dashboard and Viz extensions (Tableau Desktop only).

Tableau Desktop: 2025.3 and later

Prep: Not available

Reader: All Versions

Public: Not available

1=Yes

0=No (default)

DISCOVERPANEURL Create custom content hosted using an https enabled URL and show it in the Discover pane on the Start page for Tableau Desktop instead of the default content provided by Tableau.

Use this template to follow the same layout for your content.

For Windows, include the property DISCOVERPANEURL="<https://YourWebPage.com>" in the command line during install.

For example Tableau_<product_installer_name>.exe DISCOVERPANEURL="https://YourWebPage.com"

For information about how to configure custom content for the Discover pane after install, see Configure the Discover pane to show custom content (Tableau Desktop only).

Tableau Desktop: All versions

Prep: Not available

Reader: Not available

Public: Not available

The URL of your custom web page. For example "https://help.tableau.com"
DRIVERDIR The default location for drivers is Program Files/Tableau/Drivers. This location is shared by Tableau Desktop, Tableau Prep Builder and Tableau Bridge.

For Windows, you can specify an installation directory (other than the default) for drivers. This option creates the directory and creates an entry in the HKEY_LOCAL_MACHINE\ registry.

Whichever application changes the directory last is the new directory that all three applications will point to.

If you change the driver directory, any drivers that were installed in the previous directory must be manually moved to the new directory. Otherwise the application may not find the driver.

For more information about driver requirements for connectors see Connector Examples in the online help. For information about downloading drivers see the Drivers Download page.

Tableau Desktop: All versions

Prep: All versions

Reader: Not available

Public: Not available

A path such as D:\Drivers
INSTALLDIR Specify an installation directory other than the default.

If you specify a custom directory for the install location and plan to install future releases to this same location, you need to specify a version specific sub-folder to install to. Otherwise you will need to uninstall the previous version first.

Side-by-side installs of multiple versions in the same sub-directory is not supported.

Tableau Desktop: All versions

Prep: All versions

Reader: All versions

Public: All versions

A path such as D:\Software\Tableau.
LBLM Set to enabled (the default), the licensing screens will present the two options for activation (product key, or credentials).

Set to disabled, login-based license management will not appear on the licensing screens.

Set to required, login-based license management is the only way to activate the Tableau Desktop (when the licensing screen appears, it will offer only the credentials option for activation).

Tableau Desktop: All versions

Prep: All versions

Reader: Not available

Public: Not available

enabled

disabled

required

RECLAIMLICENSE Add a single command line that includes RECLAIMLICENSE=1 to deactivate any perpetual (or subscription in version 2018.3 and later) product key when uninstalling Tableau Desktop.

This option is not available for Mac or Tableau Prep.

Tableau Desktop: All versions

Prep Not available

Reader: Not available

Public: Not available

1=Yes
0=No (default)

REGISTER Automatically register Tableau Desktop or Tableau Prep Builder during install. Add a single command line that includes the installer option REGISTER=1. The installer runs -register to complete the registration.

This option uses the registration information in the registry location HKEY_CURRENT_USER\Software\Tableau\Registration\Data. For information about how to add this information to the registry, see Register Tableau Desktop and Tableau Prep Builder.

This option is not available on the Mac.

Tableau Desktop: All versions

Prep: All versions

Reader: Not available

Public: Not available

1=Yes
0=No (default)

REMOVEINSTALLEDAPP Automatically remove all versions of versions 9.3 and later when installing from the command line. To remove versions 9.2 and earlier, you must manually uninstall them.

This option is not available on the Mac.

Tableau Desktop: All versions

Prep Not Available

Reader: All versions

Public: All versions

1=Yes
0=No (default)
REPORTINGSERVER For desktop license reporting. Specify the instance or instances of Tableau Server where license reporting information is sent. Requires Tableau Server in your organization to be enabled for Tableau Desktop license reporting. For details, see Enable and configure Tableau Desktop reporting.

Separate multiple server URLs with a comma. For example, the following command installs Tableau Desktop and configures it to report to two Tableau Server instances:

tableau-setup-std-x64.exe /quiet ACCEPTEULA=1 REPORTINGSERVER="http://mytableau,https://mytableau02:8060"
Desktop: All Versions

Prep: Not Available

Reader: Not available

Public: Not available

A server URL, such as http://mytableau.
SCHEDULEREPORTINTERVAL For desktop license reporting. Specify the interval that Tableau Desktop will use to report licensing information to Tableau Server. Tableau Server must be enabled for Tableau Desktop license reporting. For details, see Enable and configure Tableau Desktop reporting.

You do not need to set this option if you want to use the default of eight hours. To change the interval, specify the new interval in seconds using this option. For example, the following command installs Tableau Desktop, configures it to report to two Tableau Server instances, and sets the reporting interval to four hours (14,400 seconds):

tableau-setup-std-x64.exe /quiet ACCEPTEULA=1 SCHEDULEREPORTINTERVAL=14400 REPORTINGSERVER="http://mytableau,https://mytableau02:8060"
Tableau Desktop: All Versions

Prep:  Not Available

Reader: Not available

Public: Not available

An integer value, in seconds.

The default is 28800 (8 hours).

SENDTELEMETRY

Tableau collects data that helps us learn how our products are being used so we can improve existing features and develop new ones. All usage data is collected and handled according to the Privacy Policy. If you don't want to participate in this option, you can opt out during or after install.

For Windows, to turn off this option from the command line during install, add a command line that includes the property SENDTELEMETRY=0.

To enable or disable this option after install for Windows and on the Mac see Turn off usage reporting.

Tableau Desktop: All versions

Prep: All versions

Reader: All versions

Public: All versions

1=Yes (default)
0=No
SILENTLYREGISTERUSER Silently send registration information to Tableau so that users do not have to complete the registration dialog when working in a multiple virtual machine environment. Tableau Desktop: 2019.4 and later

Prep: All versions

Reader: All versions

Public: All versions

true=Enabled
SKIPAPPLICATIONLAUNCH You can set SKIPAPPLICATIONLAUNCH=1 to prevent the new application from opening automatically when the install process is complete. This option applies to manual installs and automatic updates. This option doesn't apply to quiet installs, as the application doesn't open automatically when using that option.

This option is not available on the Mac.

Tableau Desktop: All versions

Prep: Not Available

Reader: Not Available

Public: All versions

1=Yes
0=No (default)
STARTMENUSHORTCUT Create a Tableau entry on the Windows Start menu. Tableau Desktop: All versions

Prep: All versions

Reader: All versions

Public: All versions

1=Yes (default)
0=No
SYNCHRONOUSLICENSECHECK Verify the Tableau Desktop license when Tableau Desktop starts, so that the license state is up-to-date when working in a multiple virtual machine environment. Tableau Desktop: All versions

Prep: All versions

Reader: Not Available

Public: Not Available

true=Enabled
WEBVIEWTOGGLEWEBZONESENABLED Allow Web Page objects in dashboards to display a targeted URL. For more information, see Add dashboard objects. Tableau Desktop: All versions

Prep: Not available

Reader: Not Available

Public: All versions

1=Yes (default)
0=No
[Skip to main content](#main-content) # Configure SSL Optionally, you can configure Secure Socket Layer (SSL) encryption to connect Tableau Desktop and Prep Builder to a server that uses SSL. You will need to make sure that the required root certificate is installed on the computer where Tableau Desktop and Prep are installed. **Important:** Tableau is upgrading from OpenSSL 3.1.0 to OpenSSL 3.4.0. This change will take place in June 2025 for Tableau Cloud, and version 2025.2.0 for Tableau Desktop and Prep. Tableau Server will begin using OpenSSL 3.4.0 in version 2025.3. This change is important because OpenSSL 3.4.0 defaults to Level-2 security which requires keys of 2048 bits or longer. Tableau has been recommending keys of this length for years, but if you chose to use Level-1 security you will need to generate and deploy new key pairs. If you have been generating and using 2048-bit keys or longer as recommended, no action is necessary. For more information on generating keys, see [Generate an SSL Key](https://help.tableau.com/current/server/en-us/ssl_cert_create.htm#generate-a-key) in the Tableau Server Help. Work with your IT Department or System Administrator to complete these steps. For information about how to configure Tableau Server to use SSL encryption, see [Configure External SSL](https://help.tableau.com/current/server/en-us/ssl_config.htm). ## Configure SSL for Tableau Desktop and Tableau Prep Builder **Windows** 1. Copy the certificate file (.crt) to the computer running Tableau Desktop or Tableau Prep Builder. 2. Double-click the certificate file, click Install Certificate, and then click **Next**. 3. Select Place all certificates in the following store. Browse to select Trusted Root Certification Authorities and then click OK > Next > Finish. 4. Verify that the SSL Certificate Chain File is configured in Tableau Server. 5. Wait for the certificate to finish importing, then click OK. 6. Verify that there are no duplicate certificates for Tableau Server CA in the Windows certificate store. 1. From the Start menu, type `certmgr`, then open Manage computer certificates. 2. Navigate to Trusted Root Certification Authorities\> Certificates. 3. If there are duplicate certificates for Tableau Server, open each one and check the Serial number on the Details tab. 4. Delete all the Tableau Server certificates with serial numbers that don't match the correct Tableau Server certificate. 5. Follow steps 3 and 4 for any duplicate Tableau Server certificates in Intermediate Certification Authorities > Certificates. **Mac** 1. Verify that the SSL Certificate Chain File is configured in Tableau Server. 2. Add the root certificate to your computer's keychain to ensure that the certificate authority is trusted by your computer. For more information, see [Add certificates to a keychain using Keychain Access on Mac](https://support.apple.com/guide/keychain-access/add-certificates-to-a-keychain-kyca2431/mac) in the Apple Support site. **Disclaimer**: Although we make every effort to ensure links to external websites are accurate, up to date, and relevant, Tableau cannot take responsibility for the accuracy or freshness of pages maintained by external providers. Contact the external site for answers to questions regarding its content. [Skip to main content](#main-content) # Configure Virtual Desktop Support Virtual desktop support is an opt-in feature of Tableau Desktop 10.5 and later and Tableau Prep Builder 2018.2.1 and later that gives you the ability to optimize your installations of Tableau for non-persistent virtual desktops, or for computers that are regularly reimaged. The authorization-to-run (ATR) service enables the Tableau license server to manage the activation limits and deactivations of the virtual machines (VMs). Starting with version 2020.1, virtual desktop can be configured for login-based license management (no product keys needed). This is the preferred, and often the required, method to implement a virtual deployment of Tableau Desktop when end users are not issued product keys. For more information, see [Activate Tableau using Login-based License Management](https://help.tableau.com/current/online/en-us/license_lblm.htm). With virtual desktop support enabled, Tableau login-based license management license capacity or key leases are automatically returned when not in use after a predetermined amount of time. This means that you do not need to manually refresh or deactivate the login-based license management lease or any product key. Tableau must communicate with Tableau Server or Tableau Cloud for login-based license management. If you are still using product keys, Tableau Desktop clients must periodically connect to the Internet to communicate with the hosted license service. Without virtual desktop support, an activated Tableau license or login-based license management license lease remains in use until the license term expires or the license is deactivated, causing a maximum activation error. Using virtual desktop support with frequently recycled VMs or regularly reimaged computers means that the VM is returned and the activation is added back to login-based license management for a future activation request. Virtual Desktop manages the login-based license management activation or product key activation, which prevents the maximum activation error from occurring when configured with the correct activation duration. ## How virtual desktop support works When virtual desktop support is enabled, Tableau Desktop or Tableau Prep Builder periodically contacts a Tableau-hosted authorization-to-run (ATR) service to verify that Tableau is authorized to run, based on its license. When virtual desktop is configured to also use login-based license management, Tableau Cloud and Tableau Server work as a proxy to the ATR service to verify that Tableau is authorized to run with a valid Tableau Cloud or Tableau Server Creator user. The ATR service verifies the license or whether the user is a valid Creator user, and the length of the authorization window. As long as this communication is successful, Tableau runs without any impact to the user. The diagrams below show the communication process between the client and licensing components. #### Virtual desktop support and the ATR service without login-based license management ![A diagram showing the communication process between the license and licensing components for virtual desktop support and the ATR service without login-based license management.](/tableau/next/en-us/desktopdeploy/en-us/Img/virtual_desktop_without_lblm.png) 1. Tableau Desktop or Tableau Prep Builder contacts the ATR service to verify that Tableau Desktop or Tableau Prep Builder is authorized to run. 2. The ATR service contacts the Tableau Licensing Service to verify that the license is valid. 3. The ATR service determines the length of the authorization to run window. 4. If valid, the ATR service allows you to use Tableau Desktop or Tableau Prep Builder. #### Login-based license management with Tableau Cloud ![A diagram showing the communication process between the licent and licensing components for login-based license management with Tableau Cloud.](/tableau/next/en-us/desktopdeploy/en-us/Img/virtual_desktop_online_lblm.png) #### Login-based license management with Tableau Server ![A diagram showing the communication process between the licent and licensing components for login-based license management with Tableau Server.](/tableau/next/en-us/desktopdeploy/en-us/Img/virtual_desktop_server_lblm.png) 1. You install Tableau Desktop or Tableau Prep Builder and select **Activate with your credentials**. You sign into your Tableau Cloud or Tableau Server site. 2. Tableau Cloud or Tableau Server verifies that you are a Creator. If not, you get an error. If yes, Tableau Cloud or Tableau Server communicates with the ATR service. 3. The ATR service returns an ATR lease to Tableau Cloud or Tableau Server. 4. Tableau Cloud or Tableau Server provides an ATR lease to Tableau Desktop or Tableau Prep Builder to finalize activation. ### Requested duration By default, an instance of Tableau Desktop or Tableau Prep Builder is given a 14 day authorization window during which it is authorized to run. This means that after the initial authorization, you could use Tableau without any network connection for 14 days before the activation expired. The authorization checks are attempted regularly, and each time a check is successful, the authorization window is reset to its full length. This happens without any impact to you, unless there have been no successful checks and the window is nearing its expiration, in which case a warning message lets you know that you need to connect Tableau to the network so the authorization can be confirmed. The 14 day default is typically not a good value for deploying virtual desktop where you receive a new VM with every use. For more information, see [Requested duration settings](#Requested_duration_settings). The length of the authorization window is determined by the value of the requested duration. By default, the requested duration is 14 days (1,209,600 seconds), but you can configure this to fit your environment depending on how often a user will be receiving a new VM or if the Tableau Desktop is of a persistent nature. **Note**: If you use both Tableau Desktop and Tableau Prep Builder, setting the requested duration for Tableau Desktop also sets this same duration for Tableau Prep Builder and vice-versa. #### Requested duration settings You set the requested duration in seconds. The minimum requested duration you can set is 4 hours (14,400 seconds) and the maximum is six months (15,552,000 seconds). Use the following guidelines to determine how to set the requested duration setting for your users: - For most non-shared computers, especially those that are sometimes offline for several weeks at a time, set the requested duration to three to six months (7,776,000 – 15,552,000 seconds). A longer duration will allow the user to continue to use Tableau for an extended time without an internet connection. - For computers that are reimaged approximately once per month, set the requested duration to 30 days (2,592,000 seconds). - For virtual desktops that are recycled nightly, set the requested duration to the minimum of 4 hours (14,400 seconds). This will allow you to reuse your product activations (either login-based license management or a product key) each morning and eliminates the need to remember to deactivate them each evening before the virtual desktops are recycled. ### Virtual machines and product keys The benefit of using virtual desktop support is that for environments that regularly recycle their VMs, you can set a duration short enough to expire the license activation before the desktop is reused. This means that you do not use up all your activations. You will still need to enter the product key to run Tableau after the desktop is recycled. Login-based license management can improve the end-user experience in this scenario by requesting a sign in to Tableau Cloud or Tableau Server to activate Tableau Desktop or Tableau Prep Builder instead of entering a product key. **Note:** When using virtual desktop with subscription licenses, you cannot refresh your product keys. To renew a subscription or make licensing changes, you must identify the new product key in the Tableau Customer Portal and activate it. ## How to use virtual desktop support Virtual desktop support is an opt-in feature if you're not using login-based license management, so you need to enable the feature in order to use it (it is disabled by default). If you're using login-based license management, the Tableau-managed license service (ATR) is on by default, but the ATR duration and additional installer flags need to be set for Virtual Desktop support. The ways to enable virtual desktop when not using login-based license management depend on whether you are running Tableau on Windows or on the Mac: On Windows you can enable and configure virtual desktop support: - At installation of Tableau Desktop and Tableau Prep Builder using command line install switches to enable virtual desktop support and specify a requested duration. - After installation, by editing the Windows registry to enable virtual desktop support and specify a requested duration. On a Mac you can enable and configure virtual desktop support: - After installation of Tableau Desktop and Tableau Prep Builder using `sudo defaults write` commands. ### Tableau Desktop and Tableau Prep Builder on Windows There are three methods for setting the virtual desktop flags: #### Enable virtual desktop support at install Run the installer `.exe` file from the computer's command line as an administrator and set the recommended flags as follows to ensure the best end user experience: - `ATRENABLED=1` (if using product keys) - `ATRREQUESTEDDURATIONSECONDS=14400` (lowest allowed activation return value) - `SILENTLYREGISTERUSER="true"` - `SYNCHRONOUSLICENSECHECK='true"` Include the `ATRENABLED` switch if login-based license management is not being used (version 2019.4 and earlier, or manually disabled). The `ATRENABLED` switch is not needed if login-based license management is configured on Tableau Desktop. The default value of `ATRREQUESTEDDURATIONSECONDS` is 14 days. For more information about the `ATRREQUESTEDDURATIONSECONDS` flag, see [Requested duration settings](https://help.tableau.com/current/desktopdeploy/en-us/desktop_deploy_license_deactivate.htm). The `SILENTLYREGISTERUSER` flag will stop the registration prompt on each new VM delivered as similarly, `SYNCHRONOUSLICENSECHECK` will stop the message that the license has changed with each new VM. If you need to extract the .msi files, follow the instructions to [Extract and run the Windows (MSI) installer](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_automate.htm#msi) . You must run the command from the directory where the `.exe` file is located or specify a full path to the location of the `.exe` file on the computer. Do not run the setup program from a shared directory on your network. Instead, download the `.exe` file to a directory on the computer where you're installing. The `ATRREQUESTEDDURATIONSECONDS` has a minimum setting of 4 hours (14,400 seconds). The following example shows the Windows installer command that enables automatic license deactivation and set the duration to 12 hours (43,200 seconds): `tableauDesktop-64bit-2022-1-0.exe /quiet /norestart ACCEPTEULA=1 ATRENABLED=1` `ATRREQUESTEDDURATIONSECONDS=43200 SILENTLYREGISTERUSER="true" SYNCHRONOUSLICENSECHECK="true"` or `tableauPrepBuilder-64bit-2022-1-2.exe /quiet /norestart ACCEPTEULA=1 ATRENABLED=1` `ATRREQUESTEDDURATIONSECONDS=43200 SILENTLYREGISTERUSER="true" SYNCHRONOUSLICENSECHECK="true"` When creating a primary image for a large virtual deployment, the above settings are appropriate and no product key activation should be completed. When using a new VM, each end user will enter the product key or sign in to Tableau Desktop or Tableau Prep Builder if login-based license management is enabled. #### Enable virtual desktop support by editing the registry If Tableau Desktop or Tableau Prep Builder is already installed, you can still enable virtual desktop support by editing the Windows registry to add an entry for `ATREnabled`. To change the default duration a license activation is authorized for, you can add an entry for `ATRREQUESTEDDURATIONSECONDS`. 1. As an administrator on the computer running Tableau Desktop or Tableau Prep Builder, make a backup of the registry file before you make any changes to it. 2. Edit the registry, and in `HKEY_LOCAL_MACHINE\SOFTWARE\Tableau`, create a new hive named `ATR` with these values: - **Name**: Add a string value named `ATREnabled`. - **Data**: Add `1`. - **Name**: Add a string value named `ATRRequestedDurationSeconds`. - **Data**: Add a number of seconds the duration should last. For example, add `43200` to set a duration of 12 hours. The illustration below shows what the `ATR` hive looks like in the registry editor. ![The ATR hive in the registry editor.](/tableau/next/en-us/desktopdeploy/en-us/Img/license_auto_deactivate.png) 4. Restart Tableau so that the changes take effect. #### Enable virtual desktop support by using the atr tool If Tableau Desktop or Tableau Prep Builder is already installed, you can still enable virtual desktop support from the Windows command prompt. The atrdiag.exe program resides in the \\bin directory for Windows and is a tool specific to the virtual desktop and login-based license management settings. The atrdiag.exe program can report on the values selected, change virtual desktop configuration settings, and initially configure virtual desktop. If Tableau Technical Support is needed, providing the output from the atr tool is often helpful. **Note:** Tableau Prep Builder must be installed on the same computer with Tableau Desktop in order to use atrdiag.exe with Tableau Prep Builder. 1. Sign in on the computer running Tableau Desktop as an administrator. 2. At a command prompt, navigate to the directory where Tableau Desktop is installed: `cd C:\Program Files\Tableau\\bin` 3. At a command prompt, enable the ATR service: `atrdiag.exe -enableATRFeature` 4. Set the duration, in seconds, that the license activation is authorized for. (For example, use 43200 to set a duration of 12 hours.) `atrdiag.exe -setDuration 43200` 5. Restart Tableau so that the changes take effect. #### Disable virtual desktop support by using the atr tool If you no longer want to use the virtual desktop support feature, you can disable it. 1. Shut down Tableau Desktop on the computer where you want to disable virtual desktop support. 2. Open the Windows Command Prompt as an administrator, and then navigate to the directory where Tableau Desktop is installed: `cd C:\Program Files\Tableau\\bin` 3. At a command prompt, run the following command to turn off the ATR service: `atrdiag.exe -disableATRFeature` 4. At a command prompt, run the following command: `atrdiag.exe -deleteAllATRs` 5. Start Tableau Desktop. 6. On the License Has Changed dialog, click Exit. 7. Restart Tableau so that the changes take effect. 8. On the Help menu, click Manage Product Keys to see if you can deactivate the product key. ### Tableau Desktop and Tableau Prep Builder on Mac #### Enable by updating the preference file To enable virtual desktop support on the Mac, run the following commands in a terminal window and then install or restart Tableau Desktop or Tableau Prep Builder: `sudo defaults write /Library/Preferences/com.tableau.ATR ATREnabled "1"` `sudo defaults write /Library/Preferences/com.tableau.ATR ATRRequestedDurationSeconds -string "43200"` ## Troubleshoot virtual desktop If you encounter issues when configuring or using virtual desktop, you can collect diagnostic information about the computer that is running Tableau Prep Builder or Tableau Desktop using the virtual desktop diagnostic tool (atrdiag). You can verify that virtual desktop is enabled and view the value set for the requested duration seconds in use for Tableau Desktop activation. The TTL Start and TTL End values reflect the current lease being used on the virtual machine (VM) running Tableau Desktop. The commands provided below will capture the state of your virtual desktop support installation, regardless of whether you have installed Tableau Desktop or Tableau Prep Builder. ### Error: License information has changed When using virtual desktop, you may get an error message that your license information has changed whenever you launch a new VM for Tableau Desktop or Tableau Prep Builder. This error forces a restart, which then asks you to register Tableau Desktop again. This error occurs because the ATR service sends a new token that doesn't match the license cache. To prevent this from occurring, you can use the `SYNCHRONOUSLICENSECHECK` and `SILENTLYREGISTERUSER` options with the installer on Windows. For example: `tableau-setup-std-tableau-2020 SYNCHRONOUSLICENSECHECK="true" SILENTLYREGISTERUSER="true" ATRREQUESTEDDURATIONSECONDS=14400` or `tableauDesktop-64bit-2020-1-0.exe /quiet /norestart ACCEPTEULA=1 ATRREQUESTEDDURATIONSECONDS=14400 ACTIVATIONSERVER=http:// SYNCHRONOUSLICENSECHECK="true" SILENTYLYREGISTERUSER="true"` ### Collect virtual desktop diagnostics on Windows 1. Open a **Command Prompt** as an administrator. 2. Navigate to the Tableau binaries (`\bin`) directory, using the following command: `cd Program Files\Tableau\Tableau \bin` For example: `cd Program Files\Tableau\Tableau 2022.4\bin` 3. Run the following command: `atrdiag.exe` To optionally save the output to a file: `atrdiag.exe > AtrOutput.txt` ### Collect virtual desktop diagnostics on Mac 1. Open the **Terminal** app. 2. Navigate to the directory that contains the **atrdiag** tool, using the following command: `cd "/Applications/Tableau Desktop .app/Contents/MacOS"` For example: `cd "/Applications/Tableau Desktop 2022.4.app/Contents/MacOS"` 3. Run the following command: `./atrdiag` To optionally save the output to a file: `./atrdiag > AtrOutput.txt` To learn more about resolving issues with Tableau Desktop installation, see [Troubleshoot Your Tableau Desktop or Tableau Prep Builder Installation](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_troubleshoot.htm) or [Troubleshoot Tableau Desktop or Tableau Prep Builder Licensing](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_troubleshoot_licensing.htm). [Skip to main content](#main-content) # Configure Your Environment After you have successfully installed your Tableau product, features and settings that were enabled during install may not be applicable to your environment. For example, you may want to disable error reporting or the automatic update feature in Tableau Desktop. Review the articles in this section for instructions about how to turn off features or options after install is complete. You can also find troubleshooting tips if you had any problems when installing the products. ## Other articles in this section [Skip to main content](#main-content) # Control Product Updates for Tableau Desktop Tableau Desktop can check for product updates and install them automatically. Users can also explicitly check for product updates using the Check for Product Updates feature. These features are enabled automatically, however, you can disable them either during the installation process (on Windows) or afterward (on the Windows or on the Mac). To turn off the product update feature in Tableau Desktop for your users, modify the setting for the `AutoUpdateAllowed` property value. This also turns off the Check for Product Updates feature. This feature allows users to check for and install the most recent Tableau Desktop maintenance updates to their computer at any time. Product updates only apply to dot release (maintenance) versions. Versions are shown this way: **2021.3.1** where **2021.3** is the release version, and **1** is the dot (maintenance) version. In this case, a product update would apply when 2021.3.1 is released, but not when 2021.3 is released. In addition to being able to control product updates for your users, you can also control which dot version of Tableau Desktop your users will update to by modifying the [TableauAutoUpdate.xml](http://downloads.tableau.com/TableauAutoUpdate.xml) file. **Note:** When a new release version of Tableau Desktop Public Edition or Tableau Reader becomes available, prior versions are no longer supported. Users automatically receive a notification that tells them to update to the current version. Also, you can only install one version of Tableau Desktop Public Edition at one time. This article describes how to modify the automatic product update settings during installation and how to control the product maintenance version that your users can update to. For information about how to change product update settings after you install, see [Change Installation Settings after Installation](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_setting_changes.htm). ## Turn off product updates during installation (Windows only) - When you run the installer through the command line process for Tableau Desktop, you can turn off automatic product updates for your users by setting the `AUTOUPDATE` property value to "0". For example: > `tableauDesktop-64bit-2021-3-1.exe AUTOUPDATE="0"` - To turn off updates through the UI, go to Help > Settings and Performance, then turn off Enable Automatic Product Updates. - ![Help menu for Settings and Performance, showing enabled selections for Automatic Product Updates, Autosave, and Accelerated Graphics](/tableau/next/en-us/desktopdeploy/en-us/Img/desktop_deploy_prod_update.png) ## Specify the maintenance version you want users to get You can specify the maintenance version of Tableau Desktop that product updates provides to your users by modifying the `TableauAutoUpdate.xml` file. The [TableauAutoUpdate.xml](http://downloads.tableau.com/TableauAutoUpdate.xml) file is an XML schema that contains the data that the update process uses to determine which product to update, which version to update to, and where to find the update (that is, the path to your download server). First, you copy or create a new `TableauAutoUpdate.xml` file and then you configure your users' computers to point to the download server where the files are stored. ### Copy and modify the TableauAutoUpdate.xml file You can copy the `TableauAutoUpdate.xml` file from the [Tableau downloads](http://downloads.tableau.com/TableauAutoUpdate.xml) site, modify it to suit your environment, and then save it to the root directory of the download server. 1. Make sure that the product version listed in `TableauAutoUpdate.xml` is the version that you want your users to update to. 2. Edit the `latestVersionPath` attribute for each `version` element to point to the folder on your download server that contains the product updates. 3. (Optional) Remove any installers you don't need. ### Create your own TableauAutoUpdate.xml file If you are going to create and use your own TableauAutoUpdate.xml file, you will need to complete the following steps: 1. Gather required information. 2. Generate hash files 3. Create the TableauAutoUpdate.xml file 4. Configure users computers to point to the file location. #### Gather required information Gather the following information before you create the `TableauAutoUpdate.xml` file: For the `_version_` entry in the XML file, you need the following: - **latestVersion**: The version number of the update you want to install on your user's computer. This is displayed in the About Tableau dialog box. When users start Tableau Desktop, Tableau checks to find out if a new version is available. - **latestVersionPath**: The name of the folder on the download server that contains the installers. Create this folder on the server if it doesn't already exist. **Note:** The installers are downloaded to the `Downloads/TableauAutoUpdate`. If the `Downloads` folder doesn't exist, the installers are downloaded to the `TEMP/TableauAutoUpdate` folder. - **name**: The Tableau Desktop version number, in the form `release` (X.x). For example, 2020.2. - **releaseNotesVersion**: The Tableau Desktop version number that you want users to install, in the form `release.maintenance` (X.x.x). For example, 2020.1.1. This parameter displays the correct link to the release notes. You must create an `installer` element in the XML file for each product that you want to update. For each product element, gather the following information: - **hash**: Generate a SHA-512 hash for the installer. This string must be correct or Tableau will not use the installer. For more information, see [Generate hash files](#hash). - **name**: The name of the installer file to download. - **size**: The file size in bytes. - **type**: The predefined product type that Tableau uses to find the correct installer to download. You must use a type from the following list: `desktop64`, `desktopMac`, `reader64`, `readerMac`, `public64`, or `publicMac`. #### Generate hash files Use a utility such as SHA512SUM or Certutil to generate a SHA-512 hash for each installer. It is usually faster to generate a hash if you download the Tableau executable files and generate the hash locally. Each utility works differently, so from a command prompt, enter the utility's name followed by `-h` or `-?` to display the help for the utility. For example: `sha512sum -h` #### Create the TableauAutoUpdate.xml file Create your `TableauAutoUpdate.xml` file based on the information you gathered earlier. Create one `version` element for each version, and within the `version` element, create one `installer` element for each product type that you want to update. Save the XML file to the root of your download server. The following sample XML file updates Tableau Desktop 64-bit version to 2020.2.1. An example for updating Tableau Desktop version 9.2.1 is also included. When installing Tableau on a MacOS, use the .pkg files. If you download the .dmg files, you will need to mount the .dmg and then copy the enclosed .pkg files to use to install the product. **Note:** If your version is the currently released version of Tableau Desktop Public Edition or Tableau Reader, such as Tableau 2020.2, set `public_supported="true" reader_supported="true"`. If your version is a prior version of Tableau Desktop Public Edition or Tableau Reader, such as Tableau 9.2, set `public_supported="false"` and `reader_supported="false`. ### Configure user computers and the download server After you've created the `TableauAutoUpdate.xml` file, follow this procedure to point the user's computers to the file location: 1. Set the `server` registry entry on each of your users' computers to point to your download server. - **Windows:** Make an entry for each product and operating system type (64-bit) in your environment. The following entry is for 64-bit Tableau Desktop: HKEY\_LOCAL\_MACHINE\\SOFTWARE\\Tableau\\Tableau __\\AutoUpdate Server = "__" For example: HKEY\_LOCAL\_MACHINE\\SOFTWARE\\Tableau\\Tableau 2020.2\\AutoUpdate Server = "MyCompanyDownloadServer" - **Mac:** Change the settings file for each user to list the download server. Use the `defaults` command. `defaults write com.tableau.Tableau-__ AutoUpdate.Server "__"` For example: defaults write com.tableau.Tableau-2020.2 AutoUpdate.Server "MyCompanyDownloadServer" 2. Make sure that HTTPS is enabled on the download server. Tableau always prefixes the download server name with `https://` when contacting the server. 3. Save `TableauAutoUpdate.xml` to the root of your download server. 4. Upload the Tableau installers to the download server location specified in the `latestVersionPath` parameter. Update `TableauAutoUpdate.xml` each time there's a new release that you want to make available to your users. [Skip to main content](#main-content) # Find Your Product Key If you are a Tableau Cloud customer or LBLM (Login-based license management) enabled Tableau Server customer, you do not need to manage Tableau Desktop or Tableau Prep Builder product keys. Tableau Cloud customers and new Tableau Server customers with LBLM enabled, are not issued Tableau Desktop or Tableau Prep Builder keys. If you are using Tableau Desktop or Tableau Prep Builder without Tableau Cloud or Tableau Server with login-based license management, you need your product key to activate Tableau Desktop and Tableau Prep Builder after the install process is finished. If you have a creator license (the product key begins with "TC"), the same key activates both Tableau Desktop and Tableau Prep Builder. You can always view your product key in the [Customer Portal](http://customer.tableau.com/). For more information about license types, see [User-Based licenses](https://help.tableau.com/current/server/en-us/license_server_overview.htm#userbased-licenses) in the Tableau Server help. If you don't have a product key, try the 14-day [Free Trial](https://www.tableau.com/products/trial). If you are a student or teacher, go to the [Academic programs](https://www.tableau.com/academic) page to request a license and receive instructions about how to download your copy of Tableau Desktop or Tableau Prep Builder. **Note**: If you have trouble signing in to the Customer Portal page, or if you need help retrieving your product key, contact [Customer Service](mailto:customerservice@tableausoftware.com) and provide your name, company, phone number, and email address. ### Tableau Cloud users assigned a Creator site role If you have Tableau Cloud, sign in to Tableau Cloud to activate and use Tableau Desktop or Tableau Prep Builder. For more information, see [Activate Your Tableau Cloud Site](https://www.tableau.com/support/online-admin/license-based-management). ### Tableau Server users with login-based license management If you have Tableau Server with login-based license management, you can activate by signing in to Tableau Server. For more information, see [Login-based License Management](https://help.tableau.com/current/server/en-us/license_lblm.htm). ### Users who purchased a Creator license 1. Sign in to the [Customer Portal](http://customer.tableau.com/) page on the Tableau website using your email address and password. The information you need to sign into the portal for the first time is sent to you in a welcome email from Tableau after you [purchase](https://buy.tableau.com/) the product. 2. At the top of the Welcome to the Customer Portal page, click Licenses. ![Customer Portal Licenses screen, displaying quick actions and options for further exploration](/tableau/next/en-us/desktopdeploy/en-us/Img/desktop_deploy_portal_welcome.png) 3. A table opens, listing any product keys assigned to you. Copy your product key from the Key Name column in the table. Keep this key ready and secure. **Note**: This example does not show any actual keys. The blurred area at the bottom shows where your key would be listed. ![Customer Portal Licenses screen showing license activation details](/tableau/next/en-us/desktopdeploy/en-us/Img/desktop_deploy_licence_show.png) ### Existing users with a Creator license If you purchased a Creator license, and you are not a Tableau Cloud customers and Tableau Server customers with LBLM enabled, you can find your product key from the Help menu. 1. Open your existing version of Tableau Desktop or Tableau Prep Builder. 2. From the top menu, click Help > Manage Product Keys. ![Manage Product keys dialog with the Refresh button highlighted.](/tableau/next/en-us/desktopdeploy/en-us/Img/licensekey_refresh.png) 3. Copy your product key from the Product Key column in the table. Keep this key ready and secure. If you are not able to open the Manage Product Keys dialog to see your key, log into the [Customer Portal](http://customer.tableau.com/) and follow the instructions for first time users above. [Skip to main content](#main-content) # Finding and Resolving Compatibility Issues Ideally, everybody in an organization can run the same version of Tableau Desktop or Tableau Server, but that's not always possible. In a large organization, different individuals or groups might need to use different versions of Tableau products. This article describes compatibility considerations and how Tableau Desktop, Tableau Prep Builder, and Tableau Server can work together. **Note**: This article discusses only Tableau products that are still eligible for technical support. Tableau provides technical support on each version of the product for 24 months after release. For a list of versions and their support schedules, see the [Support Services](http://www.tableau.com/support/services) page on the Tableau website ## Compatibility between Tableau Desktop and Tableau Server Compatibility issues usually arise only between _release upgrade_ versions of Tableau product rather than _maintenance releases_. For example, if you're using Tableau Desktop 2022.1 and others are using Tableau Desktop 2021.4, or if you need to publish to Tableau Server and it is still running version 2021.1, you can encounter compatibility issues. > [!IMPORTANT] > > Tableau products aren't always released at the same time. For example, a new upgrade release of Tableau Desktop might be available, but a compatible version of Tableau Server might not be available for several months. When installing a new version Tableau Desktop, make sure it's compatible with Tableau Server. A workbook created with any version of Tableau Desktop can connect to any supported version of Tableau Server. But after you're connected, compatibility can be an issue depending on the version you're using and the action you're performing. ### Publishing from Tableau Desktop to Tableau Server You can only publish workbooks and data sources to Tableau Server if the version of Tableau Server is the same or newer than the version of Tableau Desktop. For example, you can publish workbooks and data sources from Tableau Desktop 2021.2 to Tableau Server 2021.2, Tableau Server 2021.3, or Tableau Server 2021.4. You can downgrade a workbook created on Tableau Desktop version 2022.1 to publish it to Tableau Server version 2021.3. For more information about how to downgrade your workbook, see [Downgrade your workbook](#Downgrad) in this article. ### Downloading workbooks from Tableau Server A workbook downloaded from Tableau Server has the same version as the version of Tableau where it was last edited. For example, suppose Amanda is running Tableau Desktop 2021.2 and publishes a workbook to Tableau Server 2021.3. If Zachary is also running Tableau Desktop 2021.2, he can connect to Tableau Server, download the workbook, and open it. However, there are some scenarios where compatibility issues can arise: - **If someone else edits and saves the workbook on the server, the workbook is updated to that version of Tableau Server.** - **If someone downloads the workbook from Tableau Server to a newer version of Tableau Desktop and edits, saves, and publishes it, the workbook is updated to the newer version of Tableau Desktop.** For example, suppose Elizabeth publishes a workbook from Tableau Desktop 2021.2 to Tableau Server 2021.3. Ted downloads the workbook from Tableau Server to Tableau Desktop 2021.3. He edits and republishes the workbook back to the server. The workbook is now updated to the newer version. Zachary and Elizabeth, who are both using Tableau Desktop 2021.2 can download the workbook but can't open it because the workbook has been updated to Tableau version 2021.3. ### Connecting to published extracts Extracts that use a .tde file format are automatically upgraded to the .hyper format when they're refreshed (full or incremental) or appended to. For more information about the .hyper extract format, see [Extract Upgrade to .hyper Format](https://help.tableau.com/current/server/en-us/extracting_upgrade.htm). For previous versions of Tableau Server, any published workbook or data source with an extract created in Tableau Desktop retains its original version when it's refreshed or appended to on Tableau Server. **Note**: .tde files are no longer supported after Tableau versions 2024.2. ### Connecting to Tableau Server-based data sources Workbooks in Tableau Desktop can use data sources that have been published to later versions of Tableau Server. However, if you connect to a data source that uses features that aren't in that earlier version of Tableau Desktop, those fields are unavailable. Workbooks created in Tableau Desktop can always use data sources from an earlier version of Tableau Server. For example, a Tableau Desktop 2022.1 workbook can use data sources from Tableau Server 2021.1. ## Compatibility between versions of Tableau Desktop Tableau Desktop users can share workbooks—for example, by emailing them or copying them to a location on the company network. But if two users are using different versions of Tableau Desktop, sharing isn't always possible. The rule is easy: - **A newer version of Tableau Desktop can open a workbook created with an older version.** - **An older version of Tableau Desktop can't open a workbook created with a newer version.** For example, suppose Amanda creates a Tableau workbook with version 2021.3 of Tableau Desktop and sends it to Zachary, who has version 2022.1 of Tableau Desktop. Zachary will be able to open that workbook, but he'll see this warning message: `The workbook will be upgraded when it is saved. The upgraded file can't be read by earlier versions of the application.` If Zachary edits and saves the workbook and sends it back to Amanda, he'll need to downgrade the workbook first so that she can open it. If not, the load will fail when Amanda tries to open it in Tableau Desktop version 2021.4, because the workbook is now a 2022.2 workbook. For more information about downgrading your workbook between Tableau Desktop versions, see [Downgrade your workbook](#Downgrad) in this article. ### Working with Tableau extracts A newer version of Tableau Desktop can open an extract created with an older version but an older version of Tableau Desktop can't open an extract created with a newer version. However if you create a .tde extract in an older version and open the workbook in Tableau Desktop 10.5 and later and refresh (full or incremental) or append to the extract, it will be converted to the .hyper format and the workbook will become incompatible with older versions of Tableau. **Note**: Starting in version 2020.3, Tableau Data Extract (.tde) files are no longer supported and should be converted to a .hyper format. For versions 2024.3 and newer, .tde files are no longer usable. For more information about the .hyper extract format, see [Extract Upgrade to .hyper Format](https://help.tableau.com/current/server/en-us/extracting_upgrade.htm). ### Downgrade your workbook If you need to publish your workbook to an earlier version of Tableau Server or share your workbook with someone using an earlier version of Tableau Desktop, you can downgrade your workbook to a previous version. The downgraded workbook can be opened in the selected version and later. Tableau only supports downloading product versions for 24 months after release. Versions older than 24 months have reached their End of Life and are no longer provided. ### Export workbook to previous version You can export your workbook to a different version of Tableau using File > Export As Version in Tableau Desktop, or select **Download** > **Tableau Workbook** in the toolbar of a workbook in Tableau Cloud or Tableau Server. For more information, see [Export Views and Workbooks](https://help.tableau.com/current/pro/desktop/en-us/save_export_image.htm). ### Downgrade workbook for Tableau Server If you're using a newer version of Tableau Desktop and an older version of Tableau Server, you can downgrade the workbook to the older Tableau Server version during publishing. When you publish the workbook, you'll see a warning message that tells you that the workbook will be downgraded. ![A Tableau Server publish dialog with a warning that the server is running an older version than your copy of Tableau Desktop](/tableau/next/en-us/desktopdeploy/en-us/Img/downgrade_workbook.png) If you continue to publish the workbook, any features or functionality that aren't available in the older version are removed for compatibility. You may need to add back the features that were removed when the workbook was downgraded. **Note:** This option doesn't apply to data sources. ## Tableau Prep Builder Compatibility For details about Tableau Prep Builder compatibility, see [Version Compatibility with Tableau Prep](https://help.tableau.com/current/prep/en-us/prep_conductor_compatibility.htm) in the _Tableau Prep Builder_ help. ### Tableau Prep Conductor Tableau Prep Conductor was introduced as part of Data Management in Tableau Server version 2019.1. - To schedule flows to run on Tableau Server, you must be using Tableau Server version 2019.1 or later and Tableau Prep Conductor must be enabled. - To schedule flows to run on Tableau Cloud, you must be using Tableau Cloud version 2019.3 or later and Tableau Prep Conductor must be enabled. ### Compatibility between different versions of Tableau Prep Builder and Tableau Server Publishing from a newer version of Tableau Prep Builder to an older version of Tableau Server can result in compatibility issues. For example, new features added in Tableau Prep Builder version 2021.3.1 may not be compatible with Tableau Server version 2021.2 but would be compatible with Tableau Server version 2021.4 and any later major versions of Tableau Server, such as version 2022.2. In Tableau Server, Tableau Prep Conductor detects the features that are included in a flow when it has been published. If it finds features that it doesn't support, the flow can still be published to Tableau Server, but the flow can't be run, scheduled, or added to a task. Tableau Cloud is updated automatically on a regular basis, so it is compatible with all versions of Tableau Prep Builder. If you have an older version of Tableau Server, you can still run incompatible flows manually in Tableau Prep Builder or using the command line. For more information about using this process, see, Refresh flow output files from the command line. ### Compatibility between different versions of Tableau Prep Builder You may encounter compatibility issues when you try to open a flow between newer and older versions of Tableau Prep Builder or even when opening flows in the same version of Tableau Prep Builder using different computers. For example: - The flow includes input connectors or features that aren't supported in the version where the flow is opened. - The machine that you use to open the flow doesn't have the required input connectors installed or has a driver version for the connector that isn't compatible. Tableau Prep Builder requires 64-bit drivers to be installed to work with flow input connectors. If compatibility is an issue, when you try to open the flow, the flow may open but contains errors or the flow won't open at all and you receive an error message. ## Tableau Cloud Compatibility Tableau Cloud servers are typically upgraded when a new major version of Tableau is released. When publishing workbooks and data sources to Tableau Cloud, the Tableau Cloud version will be the same or later than Tableau Desktop and Tableau Prep Builder, as a result, compatibility issues are mitigated. However, consider compatibility with installations of Tableau Bridge and existing scripts or processes that use the Tableau command-line utilities, such as tabcmd and the Tableau data extract utility. For information on what constitutes a major upgrade, see [Upgrade Tableau Desktop and Tableau Prep Builder](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_upgrade.htm). ### When to upgrade Tableau Desktop to work with Tableau Cloud After Tableau Cloud is upgraded to a new major version, you can still publish data sources and workbooks from earlier versions of Tableau Desktop. However, you'll need to upgrade to the latest major version of Tableau Desktop to do the following: - Download and open a published workbook that has been edited and saved in the Tableau Cloud web editing environment. - Make a local copy of a data source. If you try to use such a workbook or data source in a Tableau Desktop version that is earlier than that of the Tableau Cloud servers, you will receive the following error: `This file was created by a newer version of Tableau. Please upgrade Tableau Desktop to the version (or greater) that the file was saved in.` ### When to upgrade Tableau Bridge to work with Tableau Cloud Tableau Bridge is a proxy client that runs on a machine in your network and is used to connect your private network data to Tableau Cloud. Tableau recommends upgrading Bridge to the latest version to avoid any compatibility issues, as some new features and bug fixes require updates to both Tableau Cloud and Bridge. If multi-factor authentication (MFA) is enabled with Tableau authentication, Bridge clients must be running Tableau Bridge version 2021.1 and later. For more information about Tableau with MFA, see [About multi-factor authentication and Tableau Cloud](https://help.tableau.com/current/online/en-us/security_auth.htm#mfa_requirement). ### When to upgrade tabcmd for site administration If you use tabcmd to administer your Tableau Cloud site—for example, to automate the tasks of uploading workbooks, managing users, and so on—you'll need the most recent version of tabcmd to run these tasks. Using an outdated version of tabcmd will cause errors and unpredictable results. For more information and the current supported version of tabcmd, see [Install tabcmd](https://help.tableau.com/current/online/en-us/tabcmd.htm#install) in the Tableau Cloud help. ### Use the Tableau data extract utility for refreshing data sources The Tableau data extract command-line utility is installed automatically with Tableau Desktop. If you use this tool to push data to a published data source on Tableau Cloud, consider the following requirements: - You'll need to use the site ID instead of the site name. The site ID is part of the Tableau Cloud URL. For example, in the following, the site ID is WidgetWorks: `https://online.tableau.com/t/WidgetWorks/view/projects` For more information about the `-t` option, see [Automate Extract Refresh Tasks](https://help.tableau.com/current/online/en-us/help.htm#to_refresh_extract_commandline.htm) in the Tableau Cloud help. - After you publish a data source to Tableau Cloud, you must refresh the data in the published data source using the data extract utility that comes with the Tableau Desktop version that matches the Tableau Cloud version. [Skip to main content](#main-content) # Install From the Command Line This article describes how to use the command line to install Tableau Desktop, Tableau Prep Builder, and Tableau Desktop Public Edition and perform other installation actions, such as activation and registration, as well as how to uninstall the product. For more detailed information about finding the installer and your product key, see [Where's the installer?](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_download.htm) and [Find Your Product Key](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_product_key.htm). **Note**: If you are upgrading, see [Upgrade Tableau Desktop and Tableau Prep Builder](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_upgrade.htm) for information about preparing for an upgrade. Tableau enables certain features for you by default such as usage reporting or automated product updates (Tableau Desktop only). For information about how to turn off these features and more, see [Change Installation Settings after Installation](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_setting_changes.htm). ## Before you begin - **Compatibility with Server**: Tableau products are not always released at the same time. When installing a new version of Tableau Desktop, make sure it is compatible with Tableau Server. See [Finding and Resolving Compatibility Issues](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_compatibility.htm). - **Install Desktop and Prep on the same computer**: Tableau Prep Builder is designed to work with Tableau Desktop. We recommend that you install Tableau Prep Builder on the same computer as Tableau Desktop. - **Do not install Tableau Prep Builder on the same computer running Tableau Server**: Tableau Server Resource Manager (SRM) can't distinguish between Tableau Server protocol server process and Tableau Prep Builder protocol server process. If the computer resources are exhausted, SRM may terminate the protocol server process belonging to Tableau Prep Builder, which has no recovery mechanism. - **Windows installer requirement**: If you're using a deployment tool that requires the Windows installer (`.msi` file) to install Tableau Desktop or Tableau Prep Builder, follow the instructions in [Extract and run the Windows (MSI) installer](#msi) to extract the `.msi` file from the Tableau installer `.exe` file. Click on the tab below for the product you are installing to view the installation steps. ### Windows 1. Run the installer `.exe` file from the computer's command line as an administrator. If you need to extract the .msi files, follow the instructions in the [Extract and run the Windows (MSI) installer](#msi) section of this article. The syntax for running the Tableau installer from the command line is: `tableau___.exe /option1 /option2 PROPERTY1 PROPERTY2` - `tableau___.exe`: This is the Tableau installer for the product and version you're installing. - **Options**: The options that you use specify how the installation process should run. For example, whether it should display output while installing or whether it should create log files. See [Installer options](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_cli_ref.htm#Installer_options) for the list of available options. - **Properties**: These settings specify configuration settings that the installer should make during the installation process. See [Installer properties](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_cli_ref.htm#installer_properties) for the list of available properties. 2. Run the command from the directory where the `.exe` file is located or specify a full path to the location of the `.exe` file on the computer. Do not run the setup program from a shared directory on your network. Instead, download the `.exe` file to a directory on the computer where you're installing. **Example** The following example shows an installer command with some options and some property settings. `tableauDesktop-64bit-2021-4-4.exe /quiet /norestart ACCEPTEULA=1 AUTOUPDATESERVER="assets.intranet.lan" REPORTINGSERVER="http://mytableau"` The command in the example does the following: - Installs the 64-bit version of Tableau Desktop 2021.4.4. - Runs the installer in quiet mode, meaning that the setup process doesn't display prompts, UI or the license dialog box. - Sets the installation to finish without restarting. - Accepts the End User License Agreement (EULA). - Configures a non-default product update server. - Configures the product to send license reporting to an internal Tableau Server. ### Mac > [!IMPORTANT] > > Only install Tableau on the root drive so that FlexNet and device drivers install to the correct location. 1. Upload a copy of the Tableau Desktop DMG file to a network share and tell users to download it to their Mac computers from there. You can follow the prompts to complete the installation. You can also create a `.sh` script that mounts the DMG file and copies Tableau to your user's computers. The following examples shows a script that performs this task for different versions of Tableau Desktop. **Example: Tableau Desktop version 10.2 and later versions** #!/usr/bin/env bash # mount the DMG and copy Tableau.app to a folder output=\`yes | hdiutil attach "__.dmg"\` sleep 10 volName=\`echo "$output" | tail -n 1 |sed 's;^.\*\\(/Volumes.\*$\\);\\1;'\` open "/Volumes/Tableau/Tableau Desktop.pkg" # dismount the Tableau DMG volume hdiutil detach " "${volName}" " -force 2. (optional) Run the installer application to perform a silent installation. Type the following at a Terminal prompt: `sudo installer -pkg -target /` This will prompt for an admin password, and then perform a mostly silent install. You will see these three lines: - `installer: Package name is Tableau Desktop` - `installer: Upgrading at base path /` - `installer: The upgrade was successful.` #### Select the drivers to install automatically By default, several data source drivers are automatically installed with Tableau Desktop. For a complete list, see [Before You Install](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_intro.htm). **Note**: Only the PostgreSQL driver is automatically installed on the Mac. To prevent one or all of the drivers from installing automatically, first run the Mac installer application against the Desktop.pkg with `‑showChoiceChangesXML` to generate a plist file containing all possible customizations. The syntax is: `installer -showChoiceChangesXML -pkg –target / > ` **Example**: `installer -showChoiceChangesXML -pkg Install\ Tableau\ Desktop.pkg –target / > InstallTableauDesktopChoices.xml` For the Oracle driver, the section in the resulting plist file looks like the following: attributeSetting 1 choiceAttribute selected choiceIdentifier com.tableau.oracle To prevent a driver from being installed, do the following: 1. In the .plist file, change the value of `` from 1 to 0 for any drivers you don't want to install automatically. 2. Save the file, then pass it to the installer by adding it to the command line using the following command: `-applyChoiceChangesXML ` The full command line might look something like this after you've created a plist file with the changes you want in it: `sudo installer -pkg Install\ Tableau\ Desktop.pkg -applyChoiceChangesXML InstallTableauDesktopChoices.xml -pkg -target /` For documentation on the Mac Installer application, see [Apple Developer](https://developer.apple.com/documentation/) documentation. #### Disable the desktop shortcut To prevent the Tableau installer from creating a desktop shortcut for Tableau Desktop, generate the XML file as per the previous section and change the integer value from 0 to 1 in the following section. attributeSetting 0 choiceAttribute selected choiceIdentifier com.tableau.desktopShortcut For a list of all command line options supported in Tableau Prep, see [Tableau Prep Command Line Reference](https://help.tableau.com/current/prep/en-us/prep_command_line_reference.htm). **Note:** This install option is only available for Windows. 1. Run the installer `.exe` file from the computer's command line as an administrator. The syntax for running the Tableau installer from the command line is: `tableau___.exe /option1 /option2 PROPERTY1 PROPERTY2` - `tableau___.exe`: This is the Tableau installer for the product and version you're installing. - **Options**: The options that you use specify how the installation process should run. For example, whether it should display output while installing or whether it should create log files. See [Installer options](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_cli_ref.htm#Installer_options) for the list of available options. - **Properties**: These settings specify configuration settings that the installer should make during the installation process. See [Installer properties](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_cli_ref.htm#installer_properties) for the list of available properties. 2. Run the command from the directory where the `.exe` file is located or specify a full path to the location of the `.exe` file on the computer. Do not run the setup program from a shared directory on your network. Instead, download the `.exe` file to a directory on the computer where you're installing. **Example** The following example shows an installer command with some options and some property settings. `tableauPrepBuilder-64bit-2021-4-4.exe /quiet /norestart ACCEPTEULA=1 CRASHDUMP="0" SENDTELEMETRY="0"` The command in the example does the following: - Installs Tableau Prep Builder 2021.4.4. - Runs the installer in quiet mode, meaning that the setup process doesn't display prompts, UI or the license dialog box. - Sets the installation to finish without restarting. - Accepts the End User License Agreement (EULA). - Sets error reporting to off. - Sets usage reporting to off ## Extract and run the Windows (MSI) installer If you're using a deployment tool that requires the Windows installer (`.msi` file) to install Tableau Desktop or Tableau Prep Builder, you can extract the `.msi` file from the Tableau installer `.exe` file. When you extract the `.msi` file, you see the installer `.msi` file plus `.msi` files for each database driver that is included in the Tableau Desktop install process. To extract the `.msi` file, you can use a third-party tool like WiX Toolset. **Disclaimer:** This solution includes information about a third-party product. While we make every effort to keep references to third-party content accurate, WiX Toolset options might change without notice. For the most up to date information, please consult WiX documentation. For assistance with the WiX utilities, contact the WiX users mailing list. 1. On the computer where you downloaded the Tableau installer, download and install the latest version of the WiX Toolset from the WiX website ([http://wixtoolset.org/](http://wixtoolset.org/)). 2. Open a command window as an administrator and navigate to the root of the folder where you installed WiX Toolset. 3. Run the following command: `Dark.exe __ -x __` For example, run the following command: `Dark.exe C:\tableau-setup-std-tableau-2021-1.21.0125.1838-x64.exe -x c:\output` The output folder will contain a folder named `AttachedContainer` that includes the `.msi` files. ## Activate Tableau Desktop and Tableau Prep Builder After Tableau Desktop or Tableau Prep Builder has been installed, you can activate using login-based license management by signing into Tableau Cloud or Tableau Server. Otherwise, you need to provide a product key in order to activate the product, by sending an activation request to Tableau. You can enter a product key from the command line during install (Windows) or after install (Windows and Mac). **Note:** Tableau Desktop Free Edition is not activated but must be registered by signing into Tableau.com. If you do not have an account you can create one. To automate this process during install, add a single command line that includes the installer option ACTIVATE\_KEY "" and enter the product key in quotes. The installer applies the product key as part of the installation process. To automate this process after install, run Tableau.exe or Tableau Prep Builder.exe after installation with the -activate option, for example `tableau.exe -activate ` . > [!TIP] > > **Note**: If you want to activate Tableau Server using automated scripts, see [Automate Licensing Tasks](https://help.tableau.com/current/server/en-us/license_automating.htm) in the Tableau Server Help. ### Windows Run `tableau.exe` or `Tableau Prep Builder.exe` with the `-activate` option and a product key. For example: **Tableau Desktop**: `"C:\Program Files\Tableau\Tableau \bin\tableau.exe" -activate ` **Tableau Prep Builder**: `"C:\Program Files\Tableau\Tableau Prep Builder \Tableau Prep Builder.exe" -activate ` ### Mac Run the Tableau or the Tableau Prep Builder executable with the `-activate` option and a product key in the `/Applications` path. For example: **Tableau Desktop**: `"Tableau Desktop .app/Contents/MacOS/Tableau" –activate __` **Tableau Prep Builder**: `"Tableau Prep Builder .app/Contents/MacOS./Tableau Prep Builder" –activate ` For information about exit codes that you can capture and evaluate if licensing fails, see [Troubleshoot activation errors using activation exit codes](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_troubleshoot_licensing.htm#Troubleshoot_activation) in the Troubleshoot Installation article in this guide. ## Register Tableau Desktop and Tableau Prep Builder You can ensure consistent registration across your organization by automating the task of registering individual copies of Tableau. To automate this process for Windows, add a single command line that includes the installer option REGISTER="1". The installer runs -register and registers the product. To register Tableau from the command line, you need to prefill the registry (Windows) or .plist (Mac) values on each computer that will run Tableau Desktop and Tableau Prep Builder. For Windows, you can trigger this process during installation. For Windows and the Mac, you can perform the installation process and then use the register command line option. When Tableau starts, it reads the registration information and registers Tableau for that user. Registration information is stored on the computer where Tableau is installed. - **Windows**: The information is in the registry. - **Mac**: The information is in the property list (`.plist`) file. The registration information includes location fields that may be the same for many users (for example, `city`, `country`, and `zip`), and fields that are typically unique to each user (email, `first_name`, `last_name`, `title`). > [!IMPORTANT] > > For Tableau Desktop, you must include the `"opt_in"` and `"privac_consent"` fields to successfully register the product using the command line option. The registration information is saved under one of the following locations: - **Windows**. Registry: `HKEY_CURRENT_USER\Software\Tableau\Registration\Data` - **Mac**. `.plist` file location: `/Users//Library/Preferences/_<.plist_file_name>_` The easiest way to prefill the registry or property list values on multiple computers is to manually install and register Tableau on one computer, and then use the registry entries or property list file that are populated by that process as a template for updating the registry on other computers. ### Windows **Register Tableau and create a template** 1. As an administrator on the computer, make a backup of the registry file before you make any changes to it. 2. Install and manually register the product on at least one Windows computer. You can use the registration information as a template when installing Tableau on other computers. The registration information is saved in the Windows registry under the following key: `HKEY_CURRENT_USER\Software\Tableau\Registration\Data` 3. Export the data (key) to a registry text file. 4. Create a script that does the following: 1. Makes a copy of the template registry text file and updates the fields that are unique for a user. 2. Copies the updated registry text file to the user's computer. 3. Updates the registry on that computer. The fields you update will depend on the information you want sent with the registration. For information on how to automate updates to the registry, see the Microsoft documentation. The following shows an example of the registry values that you might see in the exported registry file: `[HKEY_CURRENT_USER\Software\Tableau\Registration\Data] "campaign_id"=" "company"=" "country"=" "db_title"=" "department"=" "elqCustomerGUID"=" "elqFormName"=" "email"=" "first_name"=" "form_environment"=" "form_variant"=" "ga_client_id"=" "job_role"=" "last_name"=" "lead_source"=" "lead_source_detail"=" "phone"=" "product_key"=" "product_name"=" "state"=" "title"=" "zip"=" "registration_date"=" "city"=" "industry"=" "opt_in"=" "privac_consent"="` **Use the template to register Tableau on another computer** 1. On another computer, install Tableau Desktop or Tableau Prep Builder. 2. Run `tableau.exe` or `Tableau Prep Builder.exe` with the `-register` option. For example: **Tableau Desktop**: "`Program Files\Tableau\Tableau \bin\tableau.exe -register`" **Tableau Prep Builder**: "`Program Files\Tableau\Tableau Prep Builder\Tableau Prep Builder.exe -register`" If registration is successful, the install log file will have an entry: `Current registration state: complete / not needed` If registration is not successful, Tableau will close with the error code `error 117`. You can also check the log file, which has information about invalid or missing fields. The log file is in this location: Documents >My Tableau Repository or My Tableau Prep Builder Repository > Logs\> log.txt If registration fails, the automated script you created needs to be updated. For troubleshooting tips, see [Troubleshoot Your Tableau Desktop or Tableau Prep Builder Installation](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_troubleshoot.htm). ### Mac **Register Tableau and create a template** To register Tableau Desktop or Tableau Prep Builder on the Mac, you can use Xcode or the `defaults` command to update the following property list file: `com.tableau.Registration.plist`. You can find more information about how to edit OS X property list files at Apple Support. 1. Install and manually register the product on at least one Mac computer. This creates the `.plist` file that you can use as a template to register Tableau Desktop or Tableau Prep Builder on other computers. 2. Go to `/Users/__/Library/Preferences` and make a backup of the `com.tableau.Registration.plist` file that you want to use as the template. 3. Copy the template `com.tableau.Registration.plist` file to the `/Users/__/Library/Preferences` For example: `cd /Users/agarcia/Library/Preferences` 5. For each `.plist` key you want to update, run the following command: `defaults write com.tableau.Registration.plist __` For example: `defaults write com.tableau.Registration.plist Data.first_name Ashley` `defaults write com.tableau.Registration.plist Data.last_name Garcia` **Use the template to register Tableau on another computer** - On another computer, install Tableau Desktop or Tableau Prep Builder. During installation, you are prompted for a product key followed by the activation wizard. If you exit the program before completing activation or registration or are installing silently, start the Terminal application, and then run the following commands: - To activate Tableau Desktop or Tableau Prep Builder run the following command: **Tableau Desktop**: `"Tableau Desktop .app/Contents/MacOS/Tableau" –activate __` **Tableau Prep Builder**: `"Tableau Prep Builder .app/Contents/MacOS./Tableau Prep Builder" –activate ` - To register Tableau Desktop or Tableau Prep Builder run the following command: **Tableau Desktop**: `"Tableau Desktop .app/Contents/MacOS./Tableau" –register` **Tableau Prep Builder**: `"Tableau Prep Builder .app/Contents/MacOS./Tableau Prep Builder" –register` ## Uninstall Tableau Desktop and Tableau Prep Builder While it is not necessary to uninstall previous versions of Tableau Desktop and Tableau Prep Builder when installing a newer version, you can uninstall any version of these applications if you no longer need them on your computer. ### Windows To uninstall Tableau Desktop or Tableau Prep Builder silently from the command line, do the following: 1. Open the Command Prompt as an Administrator. 2. In the location where the .exe was installed, run the following command: `TableauDesktop-.exe /uninstall /quiet` or `TableauPrepBuilder-.exe /uninstall /quiet` For example: `Downloads\TableauPrepBuilder-2021-1-4.exe /uninstall /quiet` To uninstall multiple versions of Tableau Desktop from the command line do the following. **Note**: This option isn't available for Tableau Prep Builder. 1. Install the latest version of Tableau Desktop with the REMOVEINSTALLEDAPP option. For example: `tableauDesktop-64bit-2021-4-4.exe /quiet /norestart ACCEPTEULA=1 REMOVEINSTALLEDAPP=1` 2. Confirm all older versions are uninstalled except the latest version. 3. Uninstall the latest version. For example: `tableauDesktop-64bit-2021-4-4.exe /uninstall /quiet /norestart` 4. Remove all unused folders according to the steps in [Completely Removing Tableau Desktop](https://kb.tableau.com/articles/howto/completely-removing-tableau-desktop). ### Mac To uninstall Tableau Desktop on the Mac, do the following: 1. If a product key deactivation or return is required, run the `-return` option on the Tableau object in the `/Applications` path. For more information, see [Move or Deactivate Product Keys](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_move_or_deactivate.htm) . 2. Drag the application and the Desktop shortcut (if there is one) to your trash folder and then empty your trash. 3. Uninstall any drivers that were installed automatically. ## Other articles in this section [Skip to main content](#main-content) # Install From the User Interface The articles in this section describe how to install Tableau Desktop or Tableau Prep Builder from the user interface. Also included are instructions for installing Tableau Desktop Public Edition, which doesn't require activation. For information about how to activate your product: - From the command line, see [Install From the Command Line](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_automate.htm). - From the user interface, see [Register and Activate from the User Interface](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_activate_license.htm) **Note**: If you are upgrading, see [Upgrade Tableau Desktop and Tableau Prep Builder](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_upgrade.htm) for information about preparing for an upgrade. During installation, Tableau configures default settings for your display language and repository location. If you want to change those settings you can do this after the install is complete. Tableau also enables certain features for you by default such as usage reporting or automated product updates (Tableau Desktop only). For information about how to turn off these features and more, see [Change Installation Settings after Installation](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_setting_changes.htm). ## Before you begin - **Installers**:  For information about where to find and download the installers for Tableau Desktop, Tableau Desktop Public Edition, Tableau Prep Builder, and Tableau Reader, see [Where's the installer?](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_download.htm) - **Compatibility with Server**: Tableau products are not always released at the same time. When installing a new version of Tableau Desktop, make sure it is compatible with Tableau Server. See [Finding and Resolving Compatibility Issues](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_compatibility.htm). - **Install Tableau Desktop and Prep on the same computer**: Tableau Prep Builder is designed to work with Tableau Desktop. We recommende that you install Tableau Prep Builder on the same computer as Tableau Desktop. - **Do not install Tableau Prep Builder on the same computer running Tableau Server**: Tableau Server Resource Manager (SRM) can't distinguish between Tableau Server protocol server process and Tableau Prep Builder protocol server process. If the computer resources are exhausted, SRM may terminate the protocol server process belonging to Tableau Prep Builder, which has no recovery mechanism. - **Windows installer requirement**: If you're using a deployment tool that requires the Windows installer (`.msi` file) to install Tableau Desktop or Tableau Prep Builder, follow the instructions in [Extract and run the Windows (MSI) installer](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_automate.htm#msi) to extract the `.msi` file from the Tableau installer `.exe` file. ## Install Tableau Desktop 1. As an Administrator, log in to the computer where you are installing Tableau Desktop. 2. Depending on your operating system, do one of the following: - **For Windows**: Run the installer and follow the prompts. - **For Mac**: Open the Disk image file (.DMG) and double-click the installer package (.PKG) to start the installation. Drivers for many data sources are not installed automatically when you install Tableau Desktop. See [Database drivers](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_intro.htm#Data_source_drivers) for more information. 3. To enable or disable usage reporting complete the following steps for your operating system. This option allows us to gather usage pattern data to improve the product. For more information about this option and how to turn it off after installation, see [Turn off usage reporting](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_setting_changes.htm#usage). For more information about the type of data we collect, see [Tableau Product Usage Data](https://www.tableau.com/product-usage-data). **Windows** - To opt out of providing usage data, select the Don't send product usage data check box. **Mac** - On the Installation Type step, in the bottom-left of the install wizard, click Customize. To opt out of sending product usage data, select the Don't send product usage data check box. 4. (Optional) On Windows, to customize the install, on the Install welcome screen, click Customize and change any of the following options: **Windows** ![A Tableau 2023.2 setup window is showing custom installation options.](/tableau/next/en-us/desktopdeploy/en-us/Img/desktop_deploy_install_win_23_2.png) - Install location: Specify a different location to install Tableau Desktop. **Important**: If you specify a custom directory for the install location and plan to install future releases to this same location, you need to specify a version specific sub-folder to install to. Otherwise you will need to uninstall the previous version first. Side-by-side installs of multiple versions in the same sub-directory is not supported. - **Create a desktop shortcut**: Clear the check box if you don't want to automatically create a desktop shortcut for Tableau. - **Create a Start menu shortcut**: Clear the check box if you don't want to automatically add a shortcut for Tableau to the Start menu. - Check for Tableau product updates: Clear the check box if you want to disable the product update feature. This feature checks for maintenance updates and installs them automatically. If you disable this option at install it also disables the menu option for users. For more information about the product update feature, see [Control Product Updates for Tableau Desktop](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_product_updates_admin.htm). **Mac** ![Tableau Deskop custom install package options for mac.](/tableau/next/en-us/desktopdeploy/en-us/Img/desktop_deploy_install_mac23_2.png) - Create a desktop shortcut: Select the check box to automatically create a desktop shortcut for Tableau Prep Builder. - Don't send product usage data Select the check box to opt out of sending product usage data. - Enable extensions Clear the check box to opt out of dashboard extensions to expand dashboard functionality with the help of web applications created by Tableau and third-party developers. - Enable network-enabled extensions Clear the check box to opt out of network-enabled dashboard extensions. Network-enabled dashboard extensions are extensions that run on web servers that can be located inside or outside of your local network. **Note**: Only the PostgreSQL driver is installed automatically. If you need other database drivers, you can install them from the [Driver Download](https://www.tableau.com/support/drivers) page. See [Database drivers](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_intro.htm#Data_source_drivers) for more information. 5. Click Install to begin installation. If you run into any difficulties, see [Troubleshoot Your Tableau Desktop or Tableau Prep Builder Installation](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_troubleshoot.htm). 6. For Windows environments, if you selected to add a start menu or desktop shortcut, you can start the product from the Start menu or Desktop. To start the product from the executable, go to the install directory (the default is: `C:\Program Files\Tableau\Tableau <_version_>\bin`) and select `tableau.exe`. ## Install Tableau Prep Builder 1. As an Administrator, log in to the computer where you are installing Tableau Prep Builder. 2. Depending on your operating system, do one of the following: - **For Windows**: Run the installer and follow the prompts. - **For Mac**: Open the Disk image file (.DMG), and then double-click the installer package (.PKG) to start the installation. 3. When prompted, accept the licensing agreement to continue the installation. 4. To enable or disable usage reporting complete the following steps for your operating system. This option allows us to gather usage pattern data to improve the product. For more information about this option and how to turn it off after installation, see [Turn off usage reporting](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_setting_changes.htm#usage). For more information about the type of data we collect, see [Tableau Product Usage Data](https://www.tableau.com/product-usage-data). **Windows** - To opt out of providing usage data, select the Don't send product usage data check box. **Mac** - On the Installation Type step, in the bottom-left of the install wizard, click Customize. To opt out of sending product usage data, select the Don't send product usage data check box. 5. (Optional) To customize the install, on the Install welcome screen for Windows or on the Installation Type step for the Mac, click Customize and change any of the following options: **Windows** ![A Tableau Prep Builder setup window displaying options for customizing the installation.](/tableau/next/en-us/desktopdeploy/en-us/Img/desktop_deploy_install_prep_mac_23_2.png) - Install location: Specify a different location to install Tableau Prep Builder. - Create a desktop shortcut: Clear the check box if you don't want to automatically create a desktop shortcut for Tableau Prep Builder. - Create a Start menu shortcut: Clear the check box if you don't want to automatically add a shortcut for Tableau Prep Builder to the Start menu - Enable error reporting : If Tableau Prep Builder has a problem and shuts down unexpectedly, crash dump files and logs are generated and placed in your My Tableau Prep Builder Repository > Logs and My Tableau Prep Builder Repository > Logs > crashdumps files. To turn off this option during install, clear this check box during install. To turn this option off after installation see [Turn off error reporting](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_setting_changes.htm#error_off). - > [!IMPORTANT] > > Tableau Prep Builder is only available in 64-bit and If you already have 32-bit drivers installed, you'll need to install the 64-bit version of those drivers to connect to your data with Tableau Prep Builder. **Mac** ![Tableau prep builder custom install package options for mac.](/tableau/next/en-us/desktopdeploy/en-us/Img/desktop_deploy_install_prep_23_2.png) - Create a desktop shortcut: Select the check box to automatically create a desktop shortcut for Tableau Prep Builder. - Don't send product usage data: Select the check box to opt out of sending product usage data. - Enable crash recovery: Clear the check box to turn off file recovery. In the event of a crash, flow files won't automatically be saved. For more information about managing this option post-install, see [Turn off file recovery](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_setting_changes.htm#autosave_off). 6. Click Install to begin the product installation. 7. For Windows environments, if you selected to add a start menu or desktop shortcut, you can start the product from the Start menu or Desktop. To start the product from the executable, go to the install directory (the default is: `C:\Program Files\Tableau\Tableau Prep Builder<_version_`\> and select `Tableau Prep Builder.exe`. ## Install Tableau Desktop Public Edition 1. As an Administrator, log in to the computer where you are installing Tableau Desktop Public Edition. 2. Depending on your operating system, do one of the following: - **For Windows**: Run the installer and follow the prompts. - **For Mac**: Open the Disk image file (.DMG), and then double-click the installer package (.PKG) to start the installation. 3. On the Welcome screen, ensure that the product is the Tableau Desktop Public Edition and accept the licensing agreement to continue the installation. ![The setup window for Tableau Desktop Public Edition prompting you to agree to the license terms.](/tableau/next/en-us/desktopdeploy/en-us/Img/desktop_deploy_install_pub.png) 4. To enable or disable usage reporting complete the following steps for your operating system. This option allows us to gather usage pattern data to improve the product. For more information about this option and how to turn it off after installation, see [Turn off usage reporting](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_setting_changes.htm#usage). For more information about the type of data we collect, see [Tableau Product Usage Data](https://www.tableau.com/product-usage-data). **Windows** - To opt out of providing usage data, select the Don't send product usage data check box. **Mac** - On the Installation Type step, in the bottom-left of the install wizard, click Customize. To opt out of sending product usage data, select the Don't send product usage data check box. 5. (Optional) To customize the install, on the Install welcome screen for Windows or on the Installation Type step for the Mac, click Customize and change any of the following options: **Windows** ![The Tableau Public 2023.2 setup window displaying installation options.](/tableau/next/en-us/desktopdeploy/en-us/Img/desktop_deploy_install_pub_cust.png) - Install location: Specify a different location to install Tableau Prep Builder. - Create desktop shortcut: Clear the check box if you don't want to automatically create a desktop shortcut for Tableau Desktop Public Edition. - Create Start menu shortcut: Clear the check box if you don't want to automatically create a Start menu shortcut for Tableau Desktop Public Edition. - Check for Tableau product updates: Clear the check box if you want to disable the product update feature. This feature checks for maintenance updates and installs them automatically. If you disable this option at install it also disables the menu option for users. **Mac** ![A Tableau Public installation screen showing installation options.](/tableau/next/en-us/desktopdeploy/en-us/Img/desktop_deploy_install_pub_mac_23_2.png) - Create a desktop shortcut: Select the check box to automatically create a desktop shortcut for Tableau Prep Builder. - Don't send product usage data Select the check box to opt out of sending product usage data. 6. Click Install to begin the product installation. ## Other articles in this section [Skip to main content](#main-content) # Manage License Usage for Tableau Desktop and Tableau Prep Builder After Tableau Desktop and Tableau Prep Builder is installed you may want to keep track of your product license usage. If you're using Tableau Desktop or Tableau Prep Builder in an environment with login-based license management, you can view Tableau Desktop and Tableau Prep Builder license usage in the Tableau Server Administrative view. For more information, see [Login-based License Usage](https://help.tableau.com/current/server/en-us/adminview_login_based_license_usage.htm). If you are using product keys to activate Tableau Desktop or Tableau Prep Builder, review the articles in this section to configure license reporting or usage for your products. ## Other articles in this section [Skip to main content](#main-content) # Manage Tableau Desktop License Usage Configure Tableau Desktop license usage reporting to gather usage information from individual instances of Tableau Desktop and send the information to an instance of Tableau Server that you designate. You can use the information that's gathered to help you manage the Tableau Desktop licenses in your organization. For information about how to track Server Licenses usage, see [View Server Licenses](https://help.tableau.com/current/server/en-us/view_licenses.htm) in the Tableau Server help. Tableau provides the following tools to help you track and manage licensing and usage in your organization.
Tool Description
Customer portal

The Customer Portal page on the Tableau website lets you purchase, manage, and view registration information for product keys that are assigned to your users. You can manage your Tableau account on behalf of your organization, download Tableau Desktop installation packages and open and manage current and prior case interactions with Tableau's technical support team.

The portal doesn't provide detailed usage data. However, you can determine who has installed Tableau installations in your organization according to the user registration records that are available in the portal.

Tableau Desktop reporting

For Tableau Desktop (version 10.0 and later), you can configure Tableau Desktop reporting to report usage information to an instance of Tableau Server that's running in your organization. This feature is only for customers who are using product keys and not for customers using login-based license management.

Tableau Desktop reporting gathers usage information from individual instances of Tableau Desktop and sends the information to Tableau Server, where you can use administrative views to track and report on usage.

By configuring Tableau Desktop to report usage information, you can also validate that the product key-registration pairs that are shown in the portal match the activated Tableau Desktop-user pairs in your organization. For more information, see Enable and configure Tableau Desktop reporting. For information about how to track Server Licenses usage, see View Server Licenses in the Tableau Server help.

Virtual Desktop Support

You can configure Tableau Desktop (version 10.5 and later) to automatically deactivate a license after a predetermined period of time. This feature is intended to support organizations that use non-persistent virtual desktops that might be recycled on a frequent basis causing a new activation request.

When you configure your Tableau Desktop instances for automatic activation returns, if a VM is recycled or a computer is reimaged, any activated license or login-based license management lease on that VM or computer will be automatically returned after a preset period of time, giving you the option to activate a different computer.

For information about how to configure Virtual Desktop Support, see Configure Virtual Desktop Support

Login-based License Usage Report

You can view login-based license usage for Tableau Cloud or Tableau Server. The report shows activations, creator seats in use, creator seats not in use, and when a creator seat was last used. For more information about how to enable login-based license management, see Login-based License Management.

## Enable and configure Tableau Desktop reporting Tableau Desktop reporting is disabled by default. To use the feature you need to do the following: 1. Enable reporting on Tableau Server. 2. Configure Tableau Desktop installations to report to one or more instances of Tableau Server. ### Step 1: Enable reporting on Tableau Server A Tableau Server TSM administrator can enable reporting using the TSM web interface, or from a command line, using the TSM CLI. You only need to do this using one of the procedures listed below. #### Use the TSM web interface 1. Open TSM in a browser: https://:8850. For more information, see [Sign in to Tableau Services Manager Web UI](https://help.tableau.com/current/server/en-us/sign_in_tsm.htm) in the Server help. 2. Click Notifications on the Configuration tab, and then click Events. 3. Under **Server health monitoring**, select the **Enable Tableau Desktop License reporting** box. This configures Tableau Server for Desktop Reporting. 4. Click Save Pending Changes after you've entered your configuration information. 5. Click Pending Changes at the top of the page: ![Tableau Server Manager toolbar indicating that there are pending changes.](/tableau/next/en-us/desktopdeploy/en-us/Img/tsm-ui-pending-changes-btn.png) 6. Click Apply Changes and Restart. #### Use the TSM CLI To enable reporting on Tableau Server, use the following `tsm` commands on each Tableau Server instance that Tableau Desktop will report to: tsm configuration set -k features.DesktopReporting -v true tsm pending-changes apply tsm restart For more information about how to use `tsm`, see [tsm Command Line Reference](https://help.tableau.com/current/server-linux/en-us/tsm.htm) in the Tableau Server Help. ### Step 2: Configure Desktop for reporting You can configure Tableau Desktop for reporting license information in one of two ways: **During installation or reinstallation (Windows only)** - For Tableau installations on Windows computers, you can use installer command properties to specify an instance of Tableau Server to report to and set a different reporting frequency interval. - The `REPORTINGSERVER` property defines one or more instances of Tableau Server where license reporting information is sent. To specify an instance of Tableau Server, use the URL that you would normally use to connect to the server, including the port, if it is not the default of port 80. If Tableau Server uses SSL you need to preface the URL with `https://`, otherwise use `http://`. - The `SCHEDULEREPORTINTERVAL` property sets the interval in seconds that Tableau will use for reporting to the server or servers. **Example** The following command installs Tableau Desktop and configures it to report to two Tableau Server instances at a reporting interval of two hours. One instance (`http://mytableau`) is using the default port and is not using SSL. The other instance (`https://mytableau02`) uses SSL and default port 443. tableau-setup-std-x64.exe /quiet ACCEPTEULA=1 SCHEDULEREPORTINTERVAL=7200 REPORTINGSERVER="https://mytableau02,http://mytableau" For more information about using command line properties, see [Install From the Command Line](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_automate.htm). **After installation** - Add a Windows registry key (`ReportingServer`) or a Mac `.plist` file value (`com.tableau.ReportingServer.plist`) with the address of one or more Tableau Server instances where you want to send the license information. - You can configure the Tableau Desktop instance to send reporting information to up to six different servers. You can also edit the registry or .plist file to specify a non-default reporting frequency interval. For more information, see [Enable Tableau Desktop reporting after installation](#update) in this topic. If you update the registry or .plist file after Tableau Desktop is installed, you need to restart Tableau Desktop for the changes to take effect. ## Enable Tableau Desktop reporting after installation If your organization has already deployed Tableau Desktop and wants to use Desktop reporting, you must update the registry key or `.plist` file value on each computer where Tableau Desktop is installed. ### Windows 1. As an administrator on the computer running Tableau Desktop, make a backup of the registry file before you make any changes to it. 2. Open the Registry Editor, and expand `HKEY_LOCAL_MACHINE\SOFTWARE\Tableau`. Then edit the registry to create a new key named `ReportingServer` with these values: - **Name**: Add a string value named `Server`. - **Data**: Add the URL or URLs of the Tableau Server instances that the Tableau Desktop instance will send reporting data to. Include the protocol (`http` or `https`) and the port number if needed. Separate multiple addresses with a comma (,). You can include up to six addresses. Any addresses after the sixth one are ignored. For example, the following `Server` value configures Tableau Desktop to report to two Tableau Server instances. The first, `https://mytableau02`, is configured for SSL and listens on the default port 443. The second, `http://mytableau`, doesn't use SSL and listens on the default port, 80. `https://mytableau02,http://mytableau` - **Name**: Add a string value named `ScheduleReportInterval`. - **Data**: Add the interval, in seconds, at which you want Tableau Desktop to report to the server. For example, a `ScheduleReportInterval` value of `14400` configures Tableau Desktop to report every four hours. The illustration below shows what the `Server` and `ScheduleReportInterval` keys looks like in the registry editor. ![The Server and Schedule Report Interval keys in the registry editor.](/tableau/next/en-us/desktopdeploy/en-us/Img/license_reporting_server.png) 4. Restart Tableau so the changes take effect. ### Mac #### Update the .plist file from the /Library/Preferences 1. Make a backup of the `.plist` file before you make any changes to it. 2. Make the `/Library/Preferences` location visible by running the following command: `defaults write com.apple.finder AppleShowAllFiles YES` 3. Create a `com.tableau.ReportingServer.plist` file in `/Library/Preferences` with a `Server` key set to the address of the server you want the Tableau Desktop instance to report to, and a `scheduleReportInterval` key set to the frequency in seconds that Tableau Desktop should report to the servers. **Example**: A `.plist` file that's configured to send information every four hours to two servers, `https://mytableau02` and `http://mytableau`. Server https://mytableau02,http://mytableau scheduleReportInterval 14400 4. Restart Tableau so the changes take effect. #### Update the .plist file from the command line 1. Make a backup of the `.plist` file before you make any changes to it. 2. Open a Terminal prompt as an Administrator and use the following commands to set the address of the server you want the Tableau Desktop instance to report to, and a `scheduleReportInterval` -string to set the frequency in seconds that Tableau Desktop should report to the servers. **Example**: Send information every four hours to two servers, `https://mytableau02` and `http://mytableau`: `sudo defaults write /Library/Preferences/com.tableau.ReportingServer Server -string "https://mytableau02,http://mytableau"` `sudo defaults write /Library/Preferences/com.tableau.ReportingServer scheduleReportInterval -string "14400"` **Important:** Do not copy and paste the above examples into the Terminal. Type them in manually to avoid getting an error. 3. Restart Tableau so the changes take effect. ## View Tableau Desktop usage and expiration information on Tableau Server After you've configured instances of Tableau Desktop for reporting, it sends usage information to Tableau Server. If you've enabled reporting on Tableau Server, you can use the Tableau Desktop License Usage administrative view see license usage data. ![A table with expiration information about perpetual licenses, trial licenses, and term licenses.](/tableau/next/en-us/desktopdeploy/en-us/Img/adminview_desktop_expiration.png) The Tableau Desktop License Usage administrative view can answer questions such as: - What types of licenses are installed in your organization. - Which users have Tableau licenses. - Which licenses are used most often and least often. - Which licenses are expired or might soon expire. - When maintenance renewals are due in your organization. You can also use the administrative view to identify heavy usage, and you can determine whether specific users have not been using Tableau and might need additional training. For more information, see [Desktop License Usage](https://help.tableau.com/current/server/en-us/adminview_desktop_license_usage.htm) and [Desktop License Expiration](https://help.tableau.com/current/server/en-us/adminview_desktop_license_expiration.htm) in the Tableau Server Help. ## View login-based license usage You can view login-based license usage for Tableau Cloud or Tableau Server. The report shows users, hosts, user role, product, version, activations, Creator seats in use, Creator seats not in use, and when a Creator seat was last used. You can view data for the past 30 days up to a maximum of 183 days. To view the Login-based license management License Usage administrative view: 1. In Tableau Cloud or Tableau Server, in the navigation pane, click Site Status. ![Site Status page that displays a list of dashboards that monitor site activity.](/tableau/next/en-us/desktopdeploy/en-us/Img/lblm.png) 2. On the Site Status page, click Login-based License Usage. 3. Optional. On the report screen, you can change the time window to show when seats were last used, filter on actions, filter on user name, and sort by columns. ![Example of a login-based license management usage report.](/tableau/next/en-us/desktopdeploy/en-us/Img/lblm_usage_report.png) [Skip to main content](#main-content) # Move or Deactivate Product Keys If you no longer need Tableau Desktop or Tableau Prep Builder on a computer or you want to move it to another computer, deactivate the product key before you uninstall Tableau or you may not have the license available to activate on another computer. If you are using Tableau Desktop or Tableau Prep Builder in an environment with login-based license management, you do not need to deactivate any product keys if you want to move your installation to another computer. You can activate Tableau Desktop on up to two different computers if they are used by the same person and one computer per user for Tableau Prep Builder. **Note**: If the computer or virtual environment is no longer available to deactivate Tableau Desktop or Tableau Prep Builder (for example the computer was lost or stolen), you can activate by signing into Tableau Cloud or Tableau Server using login-based license management, or use the product key on a new computer. If you get an error and can't activate Tableau Desktop or Tableau Prep Builder using your product key, contact [Tableau Support](https://www.tableau.com/support/case#create_case). If login-based license management is not being used in your enviroment, you may have one or more separate product keys that you can use to activate Tableau Desktop and Tableau Prep Builder. Depending on the type of product key you have, you may have a separate key for Tableau Desktop and Tableau Prep Builder or you may have one key that you can use to activate or deactivate both products. For example a product key that starts with **TD** can be used to activate or deactivate Tableau Desktop only. A product key that starts with **TC** can be used to activate or deactivate both Tableau Desktop and Tableau Prep Builder. If you are using separate keys for Tableau Desktop and Tableau Prep Builder, you will need to deactivate both product keys. If you are using a single **TC** key, then you only need to deactivate the key on one product and it will deactivate the key for both Tableau Desktop and Tableau Prep Builder. For more information about the different license types, see [User-based licenses](https://help.tableau.com/current/server/en-us/license_server_overview.htm#user-based) in the Tableau Server online help. **Note**: For information about how to deactivate a Tableau Desktop or Tableau Prep Builder product key from the command line, see "Deactivate the product key" in [Install From the Command Line](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_automate.htm). There are two ways to deactivate a license depending on whether the computer has internet access. Follow the procedure for your scenario. ## Deactivate a product key on a computer with internet access 1. Start the application on the computer where you originally installed it. 2. Select Help > Manage Product Keys. 3. In the Manage Product Keys dialog box, select the product key and click Deactivate. 4. Close and uninstall the application. If you just want to uninstall the application, you're done. If you're moving the application to another computer, keep going. 5. On the new computer, go to the [Product Downloads and Release Notes](http://www.tableau.com/support/esdalt) page and download the relevant version of Tableau Desktop or Tableau Prep Builder for your computer (Windows 64-bit or Mac). 6. Install the application and activate it using the product key you deactivated earlier. ## Deactivate a product key offline (Tableau Desktop only) Before following this procedure, verify that the computer is not connected to the internet. The procedure will not work as described if there is a connection. 1. Start Tableau Desktop. 2. Select Help > Manage Product Keys. 3. In the Manage Product Keys dialog box, select the product key to deactivate, and then click Deactivate. An error message appears and prompts you to save the `return.tlq` file for processing. 4. Click Save. 5. From a computer that has internet access, go to the [Activation](http://www.tableau.com/support/activation) page on the Tableau website, click **Choose File**, select `return.tlq`, and then click **Upload Activation File**. Tableau sends you a `return.tlr` file. 6. Copy the `return.tlr` file to the computer where you're uninstalling Tableau Desktop. 7. Double-click the `return.tlr` file. Nothing is displayed, but this deactivates the product key. 8. To verify that the product key is deactivated, start Tableau Desktop. If it asks you for a product key, the product key was deactivated successfully. ## Transfer a product key to another user Before you can assign your product key to another user, you must deactivate your product key and remove Tableau Desktop from your computer. 1. Start Tableau Desktop. 2. Select Help > Manage Product Keys. 3. In the **Manage Product Keys** dialog box, select the product key to transfer, and then click **Deactivate**. 4. Close and uninstall Tableau Desktop. 5. After the product key is deactivated, go to the Tableau web site (https://www.tableau.com), and then on the **Support** menu, click **Customer Portal**, and sign in using your credentials. 6. In the **Tableau Customer Portal**, click **My Keys**, and then click the product key you want to reassign. 7. At the top of the License Detail screen, click **Unassign Key**. 8. Click **Assign Key**. In the **Assign License** dialog box, enter the first name, last name, and email address of the new user, then click **Assign Key**. Tableau sends an email to the new user with instructions about how to sign in. [Skip to main content](#main-content) # Refresh or Deactivate Your Product Key When you purchase a new subscription, you must refresh your product keys. If you want to move your Tableau product to another computer, or need to remove it from a computer, you need to deactivate the product key. For a list of all command line options supported in Tableau Prep, see [Tableau Prep Command Line Reference](https://help.tableau.com/current/prep/en-us/prep_command_line_reference.htm). **Note:** If you are using login-based license management or the Authorization to Run (ATR) service to manage Tableau Desktop licenses, you do not need to use these commands to refresh or deactivate Tableau. For more information about login-based license management, see [license\_lblm.htm](https://help.tableau.com/current/server/en-us/license_lblm.htm "Login-based License Management"). For more information about the ATR service, see [Configure Virtual Desktop Support](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_license_deactivate.htm). ## Refresh the product key If you have a legacy product key, when you purchase a new subscription, you must refresh your product keys. Refreshing the product keys updates the product keys with the new date and reflects the new expiration dates. If you refresh a subscription (term) product key before the expiration date occurs, the product key will not change but the expiration date will. The product key will change when the expiration date occurs or shortly thereafter. If a subscription (term) product key is not refreshed and has expired, Tableau will stop working and you will have to activate a new product key in the Tableau Customer Portal. On the other hand, if the product key is perpetual (legacy) and its maintenance has expired, Tableau will continue to operate but you will not have access to upgrades until the maintenance is renewed. After renewing the maintenance, refresh the existing product key to update its maintenance expiration date. The product key will never change. **Note:** You cannot refresh the product key if Tableau Desktop is offline. If you are activating Tableau Desktop in offline mode, you must obtain and activate a new key from the Tableau Customer Portal. To refresh your Tableau product key using the command line, use the `-refresh` option. If you want to refresh a Tableau Server product key using automated scripts, see [Automate Licensing Tasks](https://help.tableau.com/current/server/en-us/license_automating.htm) in the Tableau Server Help. ### Windows Run `tableau.exe` with the `-refresh` option and a product key. For example: `start/wait " "C:\Program Files\Tableau\Tableau \bin\tableau.exe" -refresh` ### Mac Run the `-refresh` option on the Tableau object in the `/Applications` path: `./Applications/Tableau.app/Contents/MacOS/Tableau -refresh` ## Automatically refresh product keys using zero downtime licensing Beginning in Tableau version 2021.1, internet-connected Tableau Desktop and Tableau Prep Builder users may not have to manually refresh product keys. Term licenses are automatically refreshed without requiring any action starting 14 days before subscription expiration if the user is signed onto Tableau Desktop or Tableau Prep Builder. Permanent product keys are not automatically refreshed and must be refreshed manually using the Manage Product Keys menu option. Tableau Desktop and Tableau Prep Builder will attempt to silently refresh an active product key and will warn users 14 days before their license is set to expire if the silent refresh was unsuccessful. Tableau will attempt to refresh a product key three times (at 14 days, 2 days, and 1 day before license expiration) to reflect license end date extensions as a result of your subscription renewal. The product key is not refreshed unless a Tableau Desktop user signs onto Tableau Desktop during those times. For users who do not sign onto Tableau Desktop every day, you must refresh their product keys using the Manage Product Keys menu option. ## Deactivate the product key > [!TIP] > > **Note**: If you want to deactivate a Tableau Server product key using automated scripts, see [Automate Licensing Tasks](https://help.tableau.com/current/server/en-us/license_automating.htm) in the Tableau Server Help. If you want to move Tableau Desktop or Tableau Prep Builder to another computer, or need to remove it from a computer, you should deactivate the product key. To retrieve and deactivate a Tableau Desktop or Tableau Prep Builder product key without having to manually remove it from an individual computer, start Tableau from the command line and use `-return` option. This option takes one parameter, which is the product key. If you are using the Authorization to Run (ATR) service to manage Tableau Desktop licenses, you do not need to use these commands to refresh or deactivate Tableau. To learn more about the ATR service, see [Configure Virtual Desktop Support](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_license_deactivate.htm). You can also deactivate the product key during uninstall (Windows Desktop only). For more information, see [Deactivate product keys during uninstall (Windows Desktop only)](#deactivate_uninstall). ### Windows Run tableau.exe with the `-return` option and a product key, as in the following example: `start/wait " "C:\Program Files\Tableau\Tableau \bin\tableau.exe" -return ` or `start/wait " "C:\Program Files\Tableau\Tableau Prep Builder \Tableau Prep Builder.exe" -return ` ### Mac Run the `-return` option on the Tableau object in the `/Applications` path: `./Applications/Tableau.app/Contents/MacOS/Tableau -return ` or `"./Applications/Tableau Prep Builder .app/Contents/MacOS/Tableau Prep Builder" -return ` ### Deactivate product keys during uninstall (Windows Desktop only) You can deactivate any perpetual (or subscription in version 2018.3 and later) product keys from the command line when uninstalling Tableau Desktop on Windows using the `RECLAIMLICENSE=1` installer options. For example: `tableauDesktop-64bit-2025-3-1.exe /uninstall /quiet /norestart ACCEPTEULA=1 RECLAIMLICENSE=1` When you reclaim a license, it makes Tableau Desktop unlicensed, returning the activation back to the associated product key for future use. Tableau.exe will run a `-return` command at the start of the uninstall to deactivate any active perpetual or term product keys. [Skip to main content](#main-content) # Register and Activate from the User Interface After the installation process is finished, the next step is to register and activate your product. **Note:** Tableau Desktop Free Edition does not need activation but you will be prompted to sign into Tableau.com to register. You can activate your license using one of the following options: - **From the user interface**: Follow the instructions in this topic. You'll need the product key that you saved earlier. If the computer where you're installing the product has internet access, the installation process walks you through activating the product. - **Using Login-based license management**: If you are using Tableau Server with a login-based license management enabled product key, you can activate Tableau Desktop and Tableau Prep Builder with one click. For more information, see [Login-based License Management](https://help.tableau.com/current/server/en-us/license_lblm.htm). - **Install offline**: If you're installing the product on a computer that doesn't have internet access, or if your company firewall or proxy restricts access to the `licensing.tableau.com` site, follow the additional instructions in [Activate your product offline](#offline) to complete the activation process. To activate Tableau Prep Builder offline, you must use Tableau Desktop. - **From the command line**: For instructions, see [Activate Tableau Desktop and Tableau Prep Builder](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_automate.htm#license) and [Register Tableau Desktop and Tableau Prep Builder](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_automate.htm#register). - **Activate Online**: If you have Tableau Cloud, sign in to Tableau Cloud to activate and use Tableau Desktop or Tableau Prep Builder. For more information, see [Activate Your Tableau Cloud Site](https://www.tableau.com/support/online-admin/license-based-management). **Note**: To move or deactivate your product key, see [Move or Deactivate Product Keys](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_move_or_deactivate.htm) If you are a Tableau Cloud customer or LBLM (Login-based license management) enabled Tableau Server customer, or your purchased a Creator license, follow these steps. 1. After the installation process is finished, open Tableau Desktop. This launches the Tableau Registration form where you can register and activate your product. 2. Fill out the fields on the registration form and then click Activate Tableau. ![The Tableau Prep Builder trial sign up form.](/tableau/next/en-us/desktopdeploy/en-us/Img/OfflineActivation_ActivateDialogRegTab.png) 3. Select one of the following options: - Use Tableau for free: Use Tableau Desktop Free Edition whenever you want. Activate a paid license at any time to access full functionality including sharing and publishing. - Activate with a product key: Use this option if you are activating using the user interface and have a product key. - Activate by signing into a server:Use this option if you are using login-based license management to activate your product. ![Tableau Activation screen with options for using a product key or signing in to a server](/tableau/next/en-us/desktopdeploy/en-us/Img/desktop_deploy_offline_act.png) - **Use Tableau for free**: Sign in to or create a Tableau account to install Tableau Desktop Free Edition. - **Activating with a product key**: If you are activating with a product key, delete any existing text in the Enter product key field. Copy your product key (from the location that you saved it to during the [Find Your Product Key](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_product_key.htm) procedure) and paste it into the text box, then click Activate. ![A Tableau activation page asking for a product key.](/tableau/next/en-us/desktopdeploy/en-us/Img/desktop_activation_product_key.png) A second screen appears to complete the activation process. Click Continue to finish the process. ![A green checkmark confirming the successful activation of Tableau.](/tableau/next/en-us/desktopdeploy/en-us/Img/desktop_activation_success.png) If Tableau can't connect to the site that authenticates that product key, it can't complete the activation and you must activate the product offline. Follow the instructions in [Activate your product offline](#offline) to complete the activation process. - **Activate by signing into a server**: If you are activating using login-based license management, enter the URL for your server and click Connect. ![The Tableau server sign-in window with fields to enter your server address, and buttons to connect or cancel.](/tableau/next/en-us/desktopdeploy/en-us/Img/desktop_deploy_activate_reg.png) Sign into your server, then complete the registration page if needed, and click Register. ![A Tableau sign-in page featuring fields for username, password, and a sign-in button.](/tableau/next/en-us/desktopdeploy/en-us/Img/desktop_activate_lblm2.png) - **Activate by signing into a server for Tableau Cloud**: If you are activating using Tableau Cloud, click Tableau Cloud. ![The Tableau server sign-in window with fields to enter your server address, and buttons to connect or cancel.](/tableau/next/en-us/desktopdeploy/en-us/Img/desktop_deploy_activate_reg.png) Sign into your Tableau Cloud account. ![A Tableau Cloud login screen displaying a form for users to input their email address and sign in.](/tableau/next/en-us/desktopdeploy/en-us/Img/desktop_deploy_activate_cloud.png) 1. Launch Tableau Prep Builder. 2. In the Activation page, select one of the following options: - Start a trial: Select this option if you don't have a product key but want to try Tableau Prep Builder. - Activate with a product key: Use this option if you are activating using the user interface and have a product key. - Activate by signing in to a server: Use this option if you are using login-based license management to activate your product. - Purchase a license: Select this option to navigate to the Tableau website to purchase a license. ![The Tableau Prep Builder activation window explains how to activate the software.](/tableau/next/en-us/desktopdeploy/en-us/Img/prep_activate.png) - **Activating with a product key**: If you are activating with a product key, delete any existing text in the Enter product key field, copy your product key (from the location that you saved it to from the [Find Your Product Key](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_product_key.htm) procedure) and paste it into the text box, then click Activate. > ![Tableau Prep Builder product key activation dialog.](/tableau/next/en-us/desktopdeploy/en-us/Img/prep_productkey.png) > Complete the registration form, and then click Register. > > ![The Tableau Prep Builder trial sign up form.](/tableau/next/en-us/desktopdeploy/en-us/Img/OfflineActivation_ActivateDialogRegPrep.png) - **Activate using login-based license management**: If you are activating using login-based license management enter the URL for your Tableau Server or Tableau Cloud and click Connect. > ![Tableau Prep Builder Activation screen with a prompt for the server URL to activate the product.](/tableau/next/en-us/desktopdeploy/en-us/Img/desktop_deploy_prep_activate.png) > Sign into your server. > ![A Tableau sign-in page featuring fields for username, password, and a sign-in button.](/tableau/next/en-us/desktopdeploy/en-us/Img/desktop_activate_lblm2.png) > > Tableau Cloud customers will be redirected to sign into the Cloud server. > > ![A Tableau Cloud login screen displaying a form for users to input their email address and sign in.](/tableau/next/en-us/desktopdeploy/en-us/Img/desktop_deploy_activate_cloud.png) > Complete the registration page if needed, and click Register.When your registration is complete, Tableau Prep Builder opens and you can start preparing your data. > New to Tableau Prep Builder? Try the [Get Started tutorial](https://help.tableau.com/current/prep/en-us/help.htm#prep_get_started.htm) to learn how to build your first flow. ## Activate your product offline **Note:** Apple Silicon installers for Tableau Desktop and Tableau Prep Builder do not currently support offline activation. This functionality is planned for a future release. If you need to activate offline, use the Intel-based installers. If you're installing the product on a computer that doesn't have internet access, or if your company firewall or proxy restricts access to the `licensing.tableau.com` site, then you must complete the steps below to finish activating your product. You will need access to another computer that has internet access to complete all the steps in this procedure. If you're upgrading versions and you've paid your maintenance since the last time offline activation was completed (Tableau Desktop only), contact [Tableau Customer Service](mailto:customerservice@tableau.com) via email to get an updated product key before continuing with offline activation. To activate Tableau Prep Builder offline, you will need your product key and Tableau Desktop version 2018.1 or later installed on the same computer that is offline. 1. In the Activate Tableau dialog, click Activate with a product key. ![Tableau Activation screen with options for using a product key or signing in to a server](/tableau/next/en-us/desktopdeploy/en-us/Img/desktop_deploy_offline_act.png) 2. Enter your product key and click Activate. ![A Tableau activation window. Enter a product key to activate the software. A link to the Tableau Support site is provided.](/tableau/next/en-us/desktopdeploy/en-us/Img/Offline_activate_prod_key.png) 3. Tableau prompts you to save a file that you can use for offline activation. Click Save. ![A Tableau activation error message.](/tableau/next/en-us/desktopdeploy/en-us/Img/OfflineActivation_SaveDialog.png) **Note:** If you're performing the offline activation process because of firewall or proxy restrictions, you might not be prompted to save the activation file. In that case, manually disconnect the computer from the network and then restart this procedure so that you can be prompted to save the activation file. 4. Save the file to a location that you can reach from a computer that does have internet access. Use the default file name (`offline.tlq`). 5. Click **Exit**. 6. From a computer that has internet access, open a web browser and go to the [Activation](http://www.tableau.com/support/activation) page on the Tableau website. 7. Complete the instructions for Offline Activation to submit your `offline.tlq` file and create a `activation.tlf` file. 8. Save the `activation.tlf` file and then copy it to the computer where you installed Tableau Desktop. 9. On the offline computer, double-click the `activation.tlf` file to perform the offline activation. 1. Launch Tableau Desktop. 2. From the top menu, select Help > Manage Product Keys. 3. In the Manage Product Keys dialog, click Activate. ![Manage Product Keys dialog box with the Activate button highlighted.](/tableau/next/en-us/desktopdeploy/en-us/Img/prep_offlineactivate.png) 4. Click Activate with a product key, enter your Tableau Prep Builder product key and then click **Activate**. ![Tableau Activation screen with options for using a product key or signing in to a server](/tableau/next/en-us/desktopdeploy/en-us/Img/desktop_deploy_offline_act.png) 5. Tableau Desktop detects that you are offline and shows the following message. Click Save to create an activation file. ![Offline Tableau Prep activation window indicating that the product couldn't be activated.](/tableau/next/en-us/desktopdeploy/en-us/Img/prep_offline_activation2.png) 6. Save the file to a location that you can access from the offline computer. Use the default file name (`offline.tlq`). 7. From a computer that has internet access, open a web browser and go to the [Activation](http://www.tableau.com/support/activation) page on the Tableau website. 8. Follow the instructions and select the (`offline.tlq`) file that you just created and upload it to create a create a `activation.tlf` file. You will need this file to activate Tableau Prep Builder. ![Offline Tableau Prep activation troubleshooting steps.](/tableau/next/en-us/desktopdeploy/en-us/Img/prep_offline_activation3.png) 9. Click Upload Activation File. You should receive a confirmation dialog that the upload was successful. ![Offline Tableau Prep activation successful confirmation message.](/tableau/next/en-us/desktopdeploy/en-us/Img/prep_offline_activation4.png) 10. In the confirmation dialog click the link to download the activation file to complete the activation process. 11. Copy the activation.tlf file to the computer where you installed Tableau Prep Builder. 12. On the offline computer, double-click the activation.tlf file to perform the offline activation. 13. Close Tableau Desktop. 14. Launch Tableau Prep Builder. You will be prompted to complete the registration process form to register the product. If you have previously registered a Tableau product, the fields may be populated automatically. [Skip to main content](#main-content) # Required Addresses, Proxies, and Ports Tableau uses common ports (80 and 443) to make internet requests. In most cases, the computer where Tableau Desktop or Tableau Prep Builder is installed and the network it is running on are already configured to allow the necessary access. Beginning with Tableau version 2023.1, Tableau products including Tableau Desktop, Tableau Server, and Tableau Prep Builder support deployments in IPv6 environments. ## Internet address requirements If Tableau doesn't have direct access to the internet, make sure that the domains listed in the following table are allowed by the proxy server on the computer where Tableau is installed and in the network firewall (if there is one).
Product/Component Internet access requirement
To publish workbooks and data sources to Tableau Cloud
  • *online.tableau.com
  • sso.online.tableau.com
Tableau Cloud
Browser access
  • *.tableau.com
  • *online.tableau.com
  • mapsconfig.tableau.com
  • api.mapbox.com
  • *.cloudfront.net (CDN for Amazon Web Service)
  • (Optional) *.nr-data.net and *.newrelic.com (App Monitoring for New Relic)

Note: From August 2024 to March 2025, Tableau Cloud sites were migrated to Salesforce's Hyperforce. As a result of the migration, *.akamai CDN is no longer supported.

Login screens at these URLs:

  • login.salesforce.com
  • test.salesforce.com
  • <yourInstance>.salesforce.com
  • A My Domain URL without a customized login page (for example, norns.my.salesforce.com)

These domains are used to deliver content in the right frame of your login screen, such as during SSO to Tableau Cloud from Tableau Desktop. If you don't allow these domains, the right side of a non-customized login page can display page-load errors.

  • *.sfdcstatic.com
  • secure.eloqua.com
  • *.google.com
  • *.doubleclick.net
  • www.facebook.com
  • *.google-analytics.com
Maps Tableau 2019.2 and later:
  • mapsconfig.tableau.com
  • api.mapbox.com

Tableau 2019.1 and earlier:

  • maps.tableausoftware.com

Note: Beginning with Tableau 9.1, Tableau maps use an SSL connection on port 443.

App Monitoring for New Relic's web analytic platforms
  • *.nr-data.net
  • *.newrelic.com
Licensing and certificate validation Used when activating product keys, registering the product, and signing in to Tableau Cloud.
  • atr.licensing.tableau.com:443

  • licensing.tableau.com:443

  • register.tableau.com:443

  • o.ss2.us

  • s.ss2.us

  • crt.rootca1.amazontrust.com

  • crt.sca1b.amazontrust.com

  • crt.sca0a.amazontrust.com

  • crt.sca1a.amazontrust.com

  • crt.sca2a.amazontrust.com

  • crt.sca3a.amazontrust.com

  • crt.sca4a.amazontrust.com

  • *.digicert.com

  • ocsp.*.amazontrust.com

  • crl.*.amazontrust.com

  • crt.rootg2.amazontrust.com

Requests to the above domains may be on port 80 or 443. Port 80 is used for certificate validation (revocation, certificate chain, etc). Port 443 is used for SSL connections.

Requests to the ocsp.*.amazontrust.com and crl.*.amazontrust.com domains are managed by Amazon for certificate revocation information. See ACM certificate characteristics for more information. We recommend that you install the Amazon root certificates in the certificate trust store on the computer running Tableau. To download and install the Amazon root certificates, see Certificate Authorities on the Amazon Trust Services web site.

Crash logs
  • report-issue.tableau.com
  • crash-artifacts-747369.s3.amazonaws.com

  • s3-us-west-2-w.amazonaws.com

  • s3-w-a.us-west-2.amazonaws.com

Activate and run Tableau Prep Builder To activate and run Tableau Prep Builder when a secure web proxy is configured:
  • Windows: In your Local Area Network (LAN) settings, select Bypass proxy server for local addresses.

  • MacOS: In the Proxies tab, add the IP address 127.0.0.1 to the excluded local hosts list. For more information, see Bypassing proxy settings in the MacOS User Guide.

Registration

Required to register Tableau Prep Builder.

  • register.tableau.com:443
  • tableau.com:443
Discover Pane(optional)
  • https://www.tableau.com
  • www.google-analytics.com
  • js-agent.newrelic.com
  • img.en25.com
  • galleryapi.tableau.com

If there is no access to these websites, the Discover pane won't show correctly on the home page. If access is disconnected, the links on the pane will be broken.

Product update https://downloads.tableau.com

If you have selected "Enable Automatic Product Updates" in the HELP menu, then Tableau Desktop connects to downloads.tableau.com while starting up.

Salesforce MFA with Tableau authentication
  • *.salesforce.com
  • id.tableau.com
  • identity.idp.tableau.com

If multi-factor authentication (MFA) with Tableau authentication (Tableau with MFA) is enabled for your site and your environment is using proxies that prevent clients from accessing other necessary services. See Tableau Cloud IP addresses for data provider authorization.

Tableau Desktop Public Edition public.tableau.com: 443
Tableau Exchange

Required to display listings of Accelerators and dashboard extensions from the Tableau Exchange:

  • exchange.tableau.com
  • extensiongallery.tableau.com

Required to use the data mapper for Accelerators:

  • data-mapper.tableau.com
Tableau Bridge See Optional forward proxy filtering.
Tableau Extensions

Required to use Sandboxed dashboard extensions:

extensions.tableauusercontent.com: 443

Required to use Tableau-built extensions:

tableau-extensions.tableauusercontent.com: 443

Required to use Tableau Trusted Partner-built extensions:

partner-extensions.tableauusercontent.com: 443

For more information, see Manage Dashboard and Viz Extensions in Tableau Server.

## Proxy environment support Tableau Prep Builder can't connect to a server that has an authenticating reverse proxy that lies in front of the server; all authentication must be done through Tableau Server or Tableau Cloud. Also, Tableau Prep Builder doesn't support forward proxies that require authentication. Work with your IT team to allow access to Tableau Server or Tableau Cloud through the proxy without authentication. For information about configuring proxies for Tableau Server, see [Configuring Proxies for Tableau Server.](https://help.tableau.com/current/server/en-us/proxy.htm) ## Maps If the maps domain or ports are blocked, you can use offline maps instead. For more information, see [Select Background Maps](https://help.tableau.com/current/pro/desktop/en-us/help.htm#maps_mapsources.htm) in the Tableau Help. ## Crash logs When Tableau Desktop encounters unforeseen circumstances, it might exit unexpectedly. If a crash occurs, log files and dump files are produced to capture detailed information to help Tableau engineers debug the issue. The next time Tableau Desktop is opened, the user is given the option to automatically upload the log and dump files. However, if you work in an organization that is subject to data privacy regulations, you might not want your users to be able to upload the log and dump files. In those situations you can disable the crash upload prompt from showing. For information about how to disable the crash upload prompt for your users, see [Change Installation Settings after Installation](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_setting_changes.htm). ## Test internet access To test whether firewall and proxy settings are configured correctly and whether a computer has the internet access that Tableau needs, try the following links on a computer where Tableau Desktop is installed: - [Tableau Map Server Json](https://mapsconfig.tableau.com/v1/config.json) - [Mapbox Json](https://api.mapbox.com/) If the configuration is working, these links will prompt you to download a json file. However, if you don't get a download prompt or if your test passes only because you manually entered user credentials, you will either need to change the network settings or you users will need to work offline. ## Work offline (Tableau Desktop) In some cases, if you or an IT administrator is not able to change the web proxy or firewall configuration settings to allow Tableau to access the sites it needs, your users can use Tableau offline. Using Tableau offline means that your must perform product activation using an offline process, and that your users use offline maps for the visualizations that require them. - For information about how to activate Tableau offline, see [Activate your product offline](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_activate_license.htm#offline) . - For information about using offline maps, see [Select Background Maps](https://help.tableau.com/current/pro/desktop/en-us/help.htm#maps_mapsources.htm) in the Tableau Help. [Skip to main content](#main-content) # Tableau Desktop and Tableau Prep Deployment Guide This guide provides information about how to plan, install, and upgrade Tableau Desktop, Tableau Prep, Tableau Desktop Public Edition, and Tableau Reader for yourself or for multiple users. To determine how many Creators, Explorers and Viewers you'll need, see [How to decide on the right mix of users for your organization.](https://www.tableau.com/pricing/how-to-decide) > [!TIP] > > **Note:** If you are looking for information about how to install Tableau Server, see the [Install and Configure](https://help.tableau.com/current/server/en-us/install.htm) section in the Tableau Server help. If you are looking for information about how to set up Tableau Cloud, see [Set Up a new Tableau Cloud Site](https://help.tableau.com/current/online/en-us/to_site_startup.htm) in the Tableau Cloud help. ## Who should use this guide? This guide provides information for two audiences: - If you're performing your own installation from the user interface, see [Install From the User Interface](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_download_and_install.htm) . - If you're an IT professional or system administrator who's responsible for installing Tableau for multiple users in your organization, you can find additional technical details and how to automate your install in [Install From the Command Line](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_automate.htm). Other topics in this guide can help you plan your install, deactivate or manage your product keys or manage other settings after installation is complete. ## Tableau Desktop and Tableau Prep New Features If you've used Tableau before, you'll probably be interested in changes we've made in each version. To find and compare Tableau features by product version, use the [Tableau Release Navigator.](https://public.tableau.com/app/profile/tableau.core.product.marketing/viz/ReleaseNavigator-V21/FeaturesInVersionDash) For information about fixes that have been added in each release, see the [Known Issues](https://issues.salesforce.com/) page. ## Support policy Beginning with 2021.4, Tableau is moving from a 30-month support policy to a 24-month support policy for all products. All new versions will have 24-months of support provided by our Support organization including the availability of maintenance releases. [Skip to main content](#main-content) # Tableau Version Compatibility This article describes the different version number formats and how to find your version number. See [Finding and Resolving Compatibility Issues](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_compatibility.htm) for more information. ## Version number format A _release upgrade_ is when Tableau offers new features and updates the look and feel of the product. A _maintenance upgrade_ ensures that the product includes security and bug fixes. As of 2022.3, the version numbers for Tableau Desktop and Tableau Server, and Tableau Prep Builder follow the same sequence. In previous releases, version numbers didn't follow the same sequence. For example: |   | Release Upgrade Example | First Maintenance Release Example | | --- | --- | --- | | Prep Builder | 2022.1.1 | 2022.1.2 | | Desktop and Server | 2022.1 | 2022.1.1 | Release versions often include a range of new features and updates. If you try and publish your updated workbook or flow to a prior version of Tableau Server, where those features don't exist, the workbook or flow becomes incompatible There are no compatibility issues with _maintenance_ (or dot) release versions—for example, between Tableau Desktop version 2022.2.1 and Tableau Desktop 2022.2.2 or Tableau Desktop 2022.1.4 and Tableau Server version 2022.1.7. There is one exception. Tableau sometimes introduces new connector support with a maintenance release. This can introduce compatibility issues between Tableau Desktop and Tableau Server if Tableau Desktop has been upgraded but Tableau Server hasn't been. ## Finding the version You can find the installed major and minor version of your Tableau product by checking the release number from the UI. ### Tableau Prep Builder To find the release version for your product, open Tableau Prep Builder, then in the top menu do one of the following: - **Windows**: In the top menu, click Help > About Tableau Prep Builder or About Tableau Prep. - **Mac**: In the top menu, click Tableau Prep Builder > About Tableau Prep Builder or Tableau Prep > About Tableau Prep. ### Tableau Prep Conductor Tableau Prep Conductor was introduced as part of Data Management in Tableau Server version 2019.1. To schedule flows to run on Tableau Server, you must be using Tableau Server version 2019.1 or later and Tableau Prep Conductor must be enabled. ### Tableau Desktop To identify which version of the product you are using, with Tableau Desktop open: **Windows** Select Help >About Tableau from the top menu. **Mac** Select Tableau >About Tableau from the top menu. ### Tableau Server To find your version of Tableau Server, open Tableau Server in your web browser. In the top menu bar click the information icon ![A question mark inside a circle.](/tableau/next/en-us/desktopdeploy/en-us/Img/prep_info_icon_server.png) in the top right corner and select About Tableau Server. A dialog opens that tells you which version of Tableau Server you are using ### Tableau Cloud To find your version of Tableau Cloud, open Tableau Cloud in your web browser. In the top menu bar click the information icon in the top right corner and select About Tableau Cloud. A dialog opens that tells you which version of Tableau Cloud you are using. Tableau Prep Conductor was introduced as part of Data Management in Tableau Cloud version 2019.3. To schedule flows to run on Tableau Cloud, you must be using Tableau Cloud version 2019.3 or later and Tableau Prep Conductor must be enabled. ## Other articles in this section [Skip to main content](#main-content) # Troubleshoot Tableau Desktop or Tableau Prep Builder Licensing When you activate Tableau Desktop or Tableau Prep Builder, the activation might not always go exactly as planned. In this article you can find information about how to troubleshoot issues you might encounter and suggestions for how to resolve them. The troubleshooting steps in this topic only apply to Tableau Desktop and Tableau Prep Builder _when activated using a product key_. Troubleshooting other licensing scenarios: - Login-based license management (LBLM) activations The troubleshooting steps do not apply to login-based license management (LBLM) activations. - LBLM on Tableau Cloud For more information about LBLM with Tableau Cloud, see [Understanding License Models](https://help.tableau.com/current/online/en-us/license_product_keys.htm) in the Tableau Cloud help. For troubleshooting with login-based license management on Tableau Cloud, see [Troubleshooting LBLM Licensing](https://help.tableau.com/current/online/en-us/license_lblm.htm#troubleshooting) in the Tableau Cloud help. - LBLM on Tableau Server - For troubleshooting with login-based license management on Tableau Server on Linux, see [Troubleshooting LBLM Licensing](https://help.tableau.com/current/server-linux/en-us/license_lblm.htm#troubleshooting) in the Tableau Server on Linux help. - For troubleshooting with login-based license management on Tableau Server on Windows, see [Troubleshooting LBLM Licensing](https://help.tableau.com/current/server/en-us/license_lblm.htm#troubleshooting) in the Tableau Server on Windows help. - Virtual Desktop licensing For troubleshooting virtual desktop licensing, see [Troubleshoot virtual desktop](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_license_deactivate.htm#troubleshoot_atr). ## Search the Support Knowledge Base To help you find the answer to your questions quickly, you can search the Knowledge Base. The Knowledge Base contains troubleshooting techniques you can use to fix issues, describes known issues that have been resolved, and provides answers to frequently asked questions. 1. To search for troubleshooting articles, go to [Knowledge Base](https://www.tableau.com/support/knowledgebase). 2. Search through top resources by product, or select Ask Agentforce, and type your questions using natural language. ![A webpage showing Agentforce AI with a text box where you can type a question.](/tableau/next/en-us/desktopdeploy/en-us/Img/desktop_deploy_kb_agent_search.png) ## Resolve FlexNet licensing errors when activating or opening Tableau Desktop or Tableau Prep Builder If the Tableau licensing service can't read or access the product key, you might see one of the following errors: - No license found for 'TableauDesktop' - Unable to add license - Function flxActCommonLicSpcPopulateFromTS returned error 50030, 71521, 0 - FLEXNet licensing service is not present - Function flxActAppActivationSend returned error (0,0,0) To troubleshoot the error and resolve it, try the steps in this section in the order shown. **1\. Verify the system date and time** Verify that the date and time on your computer is set to the current date. If the clock on your computer is set to a date prior to the current date, Tableau can't be activated. **2\. Verify that the FlexNet Licensing Service is installed** When you install Tableau Desktop, the FlexNet Licensing Service is installed automatically. Tableau requires this service to run. When you install Tableau Desktop on the Mac, you might be prompted to enter your password to give the installer permission to install FlexNet. For Windows, permission to install FlexNet is implied from the user account settings. To check whether the licensing service is properly installed on your computer, complete the following steps: **Windows** 1. Navigate to the following folder: `C:\Program Files\Common Files\Macrovision Shared\FlexNet Publisher` 2. Verify that the FNPLicensingService application is in the folder. If the FlexNet licensing Service is not installed, try reinstalling Tableau Desktop or check your user account permissions settings. **Mac** 1. Start the Terminal application. 2. Type the following command to list the contents of the FlexNet directory: `ls '/Library/Application Support/FLEXnet Publisher/Service/11.16.2/FNPLicensingService'` If the command doesn't return anything, or if it returns the message `No such file or directory`, the licensing service isn't installed. For information about how to manually install the FlexNet Licensing Service, see [Error: "The FlexNet licensing service is not present on the system" Activating on Mac](https://help.salesforce.com/s/articleView?id=001473989&type=1) in the Salesforce Knowledge Base. **3\. Verify that the FlexNet Licensing Service is running** If you have verified that the FlexNet Licensing Service is installed, verify that the licensing service is running. If it isn't, you might need to manually start the service. To start the service, complete the steps below based on your operating system, and then restart Tableau Desktop. **Windows** 1. From the Windows Start menu, open services.msc. 2. In the Services dialog box, verify that the status for the FlexNet Licensing Service is Started. If the Start option is grayed out, right-click FlexNet Licensing Service in the list and select Properties. On the General tab, click Start, then click OK to close the dialog box. **Mac** 1. Start the Terminal application. 2. Navigate to the FlexNet directory: `'/Applications/Tableau Desktop /Contents/Frameworks/FlexNet/'custactutil -view` For example `'/Applications/Tableau Desktop 2021.3.app/Contents/Frameworks/FlexNet/'custactutil -view` 3. Verify that the FlexNet Licensing Service is running. You should see `Trust Flags = FULLY TRUSTED`and `Status = ENABLED`. ![FlexNet Licensing Service information showing Trust Flags are FULLY TRUSTED and Status is ENABLED](/tableau/next/en-us/desktopdeploy/en-us/Img/Desktop_flexnetlicense.png) 4. Then use the following command to save the output to a file on your desktop: `/Applications/Tableau\ Desktop\ /Contents/Frameworks/FlexNet/custactutil -view > /users/$(whoami)/Desktop/licresults.txt` If the FlexNet service is not running, the FLEXNet package may not be installed, is unreadable by the computer running Tableau Desktop, or Tableau Desktop was installed to a non-default volume. Try the following steps to rebuild the FLEXnet folder: 1. Close all instances of Tableau Desktop. 2. From the MacOS X desktop, press Command+Shift+G. 3. In the Go to Folder dialog, enter: /Library/Preferences/FLEXnet Publisher/ 4. Rename the FLEXnet folder by adding '\_backup'. 5. Start Tableau Desktop and activate your product key If this doesn't succeed, try reinstalling Tableau Desktop. If this still doesn't resolve the issue, contact [Technical Support.](http://www.tableau.com/support/request) If Tableau Desktop is installed on a non-default, or secondary volume, manually move the FNPLicensingService to the Root Library directory using the following steps: 1. In Finder, locate the FNPLicensingService file located in the "/Library/Application Support/FLEXnet Publisher/Service//" folder on the same volume Tableau Desktop is installed on. 2. Copy the FNPLicensingService into the system root library and create the necessary folders: /Library/Application Support/FLEXnet Publisher/Service/ 3. After that file is properly placed, launch and activate Tableau Desktop. **4\. Repair trusted storage** If FlexNet Licensing Services is installed and running but you're still seeing an error, there might be a problem with the Tableau product key information. To resolve this issue, complete the following steps to repair the key information that is located and saved in trusted storage. **Note:** You will need access to the Customer Activation Utility located in the bin folder to perform these steps. If the commands for Flexera aren't working, you won't be able to make a `LicResults.txt` file. **Windows** 1. Open a command window and navigate to the directory where the Customer Activation Utility is. For example: `cd "C:\Program Files\Tableau\Tableau __\bin"` where `__` is the Tableau product version that you installed. 2. Type the following command: `custactutil –localrepair` 3. Launch Tableau. If the repair is not successful, type the following command to create a `LicResults.txt` file: `custactutil -view >LicResults.txt` Contact [Technical Support](http://www.tableau.com/support/request) and include the `LicResults.txt` file that you created. **Mac** 1. Start the Terminal application. 2. Navigate to the FlexNet directory: `cd /Applications/Tableau Desktop .app>/Contents/Frameworks/Flexnet` 3. Enter the following command: `./custactutil -localrepair` 4. Launch Tableau. If the repair is not successful, type the following command to create a `LicResults.txt` file: `./custactutil -view > /users//licresults.txt` Contact [Technical Support](http://www.tableau.com/support/request) and include the `LicResults.txt` file that you created. **Note**: Remove the Flexera folder and open desktop again to recreate this folder before contacting Technical Support. ## Troubleshoot activation errors using activation exit codes When you start Tableau and include the `-activate` option, the activation process returns status information by setting the `ERRORLEVEL` environment variable to an exit code. If activation was successful, the Tableau application exit code is `0` (zero). The table below lists exit codes from the activation process and what they mean. If activation fails, you can also find error information in the Tableau log file. Log files are located in the `Logs` folder in the `My Tableau Repository` folder under the current user's `Documents` folder. For example: `/Users/_/Documents/My Tableau Repository/Logs` The following example script shows how to activate Tableau Desktop for Windows and check for specific errors, such as an invalid product key (536871018) and general licensing issues (536871012). @echo off start/wait tableau.exe -activate __ if %errorlevel% EQU 536871018 (ECHO TABLEAU\_ERROR\_LICENSING\_INVALID\_KEY) if %errorlevel% EQU 536871012 (ECHO TABLEAU\_ERROR\_LICENCING\_GENERAL) if %errorlevel% EQU 0 (ECHO SUCCESS) | Exit Code | Message | Value | | --- | --- | --- | | `536871012` | `TABLEAU_ERROR_LICENSING_GENERAL` | An unknown error occurred during the licensing operation. | | `536871013` | `TABLEAU_ERROR_LICENSING_INTERNAL` | The product is unable to start due to an internal licensing error. | | `536871014` | `TABLEAU_ERROR_LICENSING_SETUP` | The product is unable to start due to an internal licensing error. | | `536871015` | `TABLEAU_ERROR_LICENSING_CONNECT` | An error occurred contacting the Tableau license server. | | `536871017` | `TABLEAU_ERROR_LICENSING_ACTIVATION_ASR` | An error occurred while activating the ASR. | | `536871016` | `TABLEAU_ERROR_LICENSING_ACTIVATION_GENERAL` | Activation failed, please try again. | | `536871018` | `TABLEAU_ERROR_LICENSING_ACTIVATION_INVALID_KEY` | Invalid product key. | | `536871019` | `TABLEAU_ERROR_LICENSING_ACTIVATION_OFFLINE` | Unable to complete offline activation. | | `536871020` | `TABLEAU_ERROR_LICENSING_ACTIVATION_INVALID_MODEL` | An error was returned from the license server. Check the Tableau log file for more information. | | `536871033` | `TABLEAU_ERROR_LICENSING_ACTIVATION_MAX_EXTRA_ACTIVATIONS` | Failed to activate the license because you have reached the limit of activations for this license. | | `536871022` | `TABLEAU_ERROR_LICENSING_UNLICENSED_GENERAL` | An unknown error occurred during the unlicensing operation. Check your product key or contact support. | | `536871023` | `TABLEAU_ERROR_LICENSING_UNLICENSED_NONE_FOUND` | No licenses found. | | `536871024` | `TABLEAU_ERROR_LICENSING_UNLICENSED_EXPIRED` | Only expired product keys were found. | | `536871025` | `TABLEAU_ERROR_LICENSING_UNLICENSED_EXPIRED_TRIAL` | Your trial for this version has ended. | | `536871026` | `TABLEAU_ERROR_LICENSING_UNLICENSED_EXPIRED_SUBSCRIPTION` | The product key is expired. | | `536871027` | `TABLEAU_ERROR_LICENSING_UNLICENSED_EXPIRED_MAINTENANCE` | Maintenance has expired. | | `536871028` | `TABLEAU_ERROR_LICENSING_RESYNC_GENERAL` | Your product keys could not be synchronized. | | `536871029` | `TABLEAU_ERROR_LICENSING_REGISTRATION_GENERAL` | An error occurred during product registration. | | `536871030` | `TABLEAU_ERROR_LICENSING_SERVICE_INSTALL` | An unknown error occurred during licensing operations. | | `536871031` | `TABLEAU_ERROR_LICENSING_SERVICE_UNINSTALL` | An unknown error occurred during licensing operations. | ## Troubleshoot accessing the licensing server Any environments that required special configuration (static IP safe listing for example) to access `licensing.tableau.com` or `atr.licensing.tableau.com` will need to be updated before you can activate, refresh, or deactivate a Tableau product key. To check whether this is the problem: 1. In a web browser, navigate to the following addresses: - `https://licensing.tableau.com/_status/healthz` - `https://atr.licensing.tableau.com/_status/healthz` You should see an "OK" message displayed on the page. 2. If you don't see the success page, you may need to update your local environment to access the licensing services. For more details, see the [Tableau Community](https://community.tableau.com/s/question/0D54T00000C6VDSSA3/important-tableau-licensing-server-is-moving). For additional details about internet address requirements for Tableau Desktop and Tableau Prep Builder, see [Required Addresses, Proxies, and Ports](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_proxy.htm). ## Troubleshoot license reporting (Tableau Desktop only) When Tableau Server and Tableau Desktop instances are properly configured, Tableau Desktop license usage information is available in two administrative views, [Desktop License Usage](https://help.tableau.com/current/server/en-us/adminview_desktop_license_usage.htm) and [Desktop License Expiration](https://help.tableau.com/current/server/en-us/adminview_desktop_license_expiration.htm). If you can't see these views, or if there's no data in them, there might be a problem with license reporting. The sections below can help you troubleshoot the cause. For information about how to configure Tableau Desktop reporting, see [Manage Tableau Desktop License Usage](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_reporting_admin.htm). ### Administrative views aren't available The Desktop License Reporting administrative views are available only to Tableau Server administrators. If you don't see links to the Desktop License Usage and Desktop License Expiration views on the Server Status page (select Manage All Sites from the Sites menu), verify the following: - You are signed in as a Tableau Server administrator. - License reporting is enabled in Tableau Server. (The feature is disabled by default.) For more information, see the procedure for enabling license reporting on Tableau Server in the [Manage Tableau Desktop License Usage](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_reporting_admin.htm) article in this guide. ### Administrative views don't include expected content If you aren't seeing the data you expect, it could be for one of the reasons listed here. #### Tableau Desktop was configured less than eight hours ago By default Tableau Desktop reports licensing data at an eight hour interval. You might not see usage data in the administrative views if it has been less than eight hours since instances of Tableau Desktop were configured for reporting. Tableau Desktop reports every eight hours while running with the count of hours beginning when you start a properly configured instance of Tableau Desktop. If Tableau Desktop is not still running when the eight hour time is reached, a report is sent the next time Tableau Desktop is started. Wait a minimum of eight hours after Tableau Desktop instances are configured before you look for those licenses in the Desktop License Reporting views. The following events force an immediate report from a properly configured Tableau Desktop instance to Tableau Server: - Activating Tableau Desktop - Deactivating Tableau Desktop - Renewing maintenance on a license for Tableau Desktop #### Tableau Desktop has not been restarted since license reporting was configured If Tableau Desktop was already running when license reporting was configured with a server address to report to, Tableau Desktop must be restarted. #### Tableau Desktop has not been opened since being configured for license reporting If Tableau Desktop has not been opened since being configured for reporting, you might not see usage data in the administrative views. License information is reported only when Tableau Desktop is running. #### Tableau Desktop is incorrectly configured for license reporting Verify that instances of Tableau Desktop are configured correctly with the address of the Tableau Server to report to. Use log files on the Tableau Desktop computer to help determine if the instance is configured correctly. Find the log file `%Documents%\My Tableau Repository\Logs\log.txt`. Search for "`licUsageReport`" to find entries related to license reporting. #### Error messages for license reporting The following table lists log messages that can help identify issues with license reporting.
Log message Details and possible causes
licUsageReport: Response code from server: <server> is: 200 Tableau Desktop reported successfully to the server.
licUsageReport: Response code from server: <server> is: 0

Internet communication error: Couldn't connect to server (server_name).

Tableau Desktop is configured for the wrong protocol. For example, the server is configured for HTTPS and Tableau Desktop is configured to report using HTTP.

Tableau Desktop is reporting to a non-existent server.

Tableau Desktop is reporting to an instance of Tableau Server that is not running.

licUsageReport: License reporting server config does not exist The registry key is not set or is in the wrong place in the registry (Windows) or .plist file (Mac).

On Mac computers, this message can be logged when a .plist file has been created in the wrong location. For example, the .plist file was created in or copied to ~\Library\Preferences instead of \Library\Preferences.

On Mac computers, this message can be logged when a .plist file has been created,but the file is then updated with a new or changed server name and the Mac computer is not restarted.

### Changing the default reporting interval By default, when configured for Desktop License Reporting, Tableau Desktop reports to the configured server or servers every eight hours. You can modify the registry or .plist file on Tableau Desktop computers to change this interval. This is especially useful for troubleshooting. #### Windows To change the frequency that Tableau Desktop reports to the server from a Windows computer, edit the registry to add a string value to the `ReportingServer` key: - Path: `HKEY_LOCAL_MACHINE\SOFTWARE\Tableau\ReportingServer` - Name: add a string value named `scheduleReportInterval`. - Data: The amount of time, in seconds, between reports sent by Tableau Desktop to the server. By default this is 8 hours and if there is no entry the default is used. Increase this for troubleshooting if necessary, but keep in mind that the more frequent the interval, the more network traffic generated. For example, the following image shows a registry configured so Tableau Desktop reports to the configured Tableau Servers every hour (3600 seconds): ![The Schedule Report Interval key highlighted in the registry editor.](/tableau/next/en-us/desktopdeploy/en-us/Img/license_reporting_server01.png) #### Mac To change the frequency that Tableau Desktop reports to the server for Mac, edit the `com.tableau.ReportingServer.plist` file in `/Library/Preferences` and add a `scheduleReportInterval` key. Set this to the length of time, in seconds, between reports from Tableau Desktop to the configured Tableau Server. The following example shows the contents of a `.plist` file that's configured to send information every hour (3600 secons) to two servers, `https://mytableau02:8010` and `http://mytableau`. Server https://mytableau02:8010,http://mytableau scheduleReportInterval 3600 [Skip to main content](#main-content) # Troubleshoot Your Tableau Desktop or Tableau Prep Builder Installation When you install Tableau Desktop or Tableau Prep Builder, the installation might not always go exactly as planned. In this article you can find information about how to troubleshoot issues you might encounter and suggestions for how to resolve them. ## Search the Support Knowledge Base To help you find the answer to your questions quickly, you can search the Tableau Knowledge Base. The Knowledge Base contains troubleshooting techniques you can use to fix issues, describes known issues that have been resolved, and provides answers to frequently asked questions. 1. To search for troubleshooting articles, go to [Knowledge Base](https://www.tableau.com/support/knowledgebase). 2. Type in a description. 3. On the Support page, choose Knowledge Base from the Source tab. ![A form with fields for filtering results by product, version, source, and topic.](/tableau/next/en-us/desktopdeploy/en-us/Img/desktop_deploy_kb_choose.png) ## Repair an installation (Windows only) A repair of an installation is the process of installing a new build of the same version over the existing installation. Repairing an installation keeps the software in a working state by overwriting changed files and reinstalling missing files. To run a repair of an installation: 1. Go to Control Panel > Programs \> Programs and Features. 2. Select Tableau program from the list. 3. Right click Uninstall/Change. 4. In the Modify Setup window that appears, click Repair, and allow the repair process to finish. ## Create an installation log If you are working with Tableau Support, they may request log files from your installation. Tableau Desktop or Tableau Prep Builder can keep a log of the installation process. Logging is on by default for the Tableau installer for both Windows and Mac. By default, the log files are stored in the user's temporary folder (the location specified in the `%temp%` environment variable) for Windows and in `/private/var/log` for the Mac. It's a good idea to keep the log files for the installation process to help you troubleshoot in case anything goes wrong. If so, you can review the log file and search for entries that include `Error` or `Fail` to help you spot the problem. **Note:** When logging at the `DEBUG` level, full environment information is gathered when Tableau starts. This means that if you have any sensitive information in an environment variable, it may be included in a log. Logging at the default `INFO` level only gathers safe environment information. If you want to change the location or name of the log files, or if you're not sure if logging is enabled, complete the following steps. Logging must be turned on before you start installation. 1. Download the installer (`.exe` file). 2. Open a command window as an administrator. 3. Navigate to the directory where you downloaded the installer file. 4. Run the following command: `__ /log "__"` Replace `_installer_` with the name of the Tableau installer file and replace `_log_file_path_and_name_` with the path and name of the file where you want the installation log file to be saved. For example: `tableauDesktop-64bit-2021-3-1.exe /log "C:\Users\henryw\Desktop\install.txt"`. ## Troubleshoot internet errors Tableau Desktop and Tableau Prep Builder require certain firewall and proxy settings to load map views, to load web pages, and to process license requests. If you encounter one of the following errors, the administrator for the organization's network needs to make changes to the network web proxy and firewall configuration settings. - The licensing process requests offline activation. - Map views appear blank in Tableau Desktop. - Web pages in dashboards fail to load. - The online map can't be loaded. For information about how to configure internet access for Tableau Desktop, see [Required Addresses, Proxies, and Ports](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_proxy.htm) ## Resolve memory errors If Tableau runs out of memory on the computer, it displays an out-of-memory error. The following factors can impact memory when using Tableau Desktop or Tableau Prep Builder. - The Tableau Desktop version. - If you install 64-bit Tableau Desktop on a 64-bit Windows operating system, Tableau can access up to 8 TB of system memory. - The size and type of data you're analyzing. For example, a large crosstab with many columns and millions of rows of values, or a view that shows many marks, can quickly exhaust memory. - Other applications running on the computer. - The operating system on the computer. ### Possible resolutions To address out-of-memory issues, consider upgrading your operating system or Tableau version to a 64-bit computer. This lets Tableau access a larger amount of system memory. You can also review the data in your workbooks and how you're aggregating that data when you display it in views. Instead of displaying many rows of values, which might require lots of scrolling to review the data, consider displaying summary data. Tableau Desktop is more effective and uses less memory when the data in the view presents the bigger picture, and instead allows you and others to drill down into specific areas to view the details. For more information about how to optimize your workbook performance, see [Optimize Workbook Performance](https://help.tableau.com/current/pro/desktop/en-us/help.htm#performance_tips.htm) in the Tableau Help. ## Troubleshoot installing Tableau Desktop Free Edition If you install Tableau Desktop Free Edition on a computer that previously had a licensed version of Tableau Desktop installed and using login-based license management (LBLM), you may not see the "Use Tableau for free" option after you install. If this is the case, you can disable LBLM on the computer and the option should display. ## Troubleshoot opening or saving files on a Dell computer (Tableau Desktop only) If you installed Tableau Desktop on a Dell computer and that computer has an older version of the Dell Backup and Recovery (DBAR) application installed, Tableau might close unexpectedly when you try to open or save a workbook or try to access a data source. This is because the Dell Backup and Recovery software interferes with the open and save operations for the 64-bit version of Tableau Desktop. For information about how to resolve this issue, see the [Error "Tableau has stopped working" Opening or Saving a File on a Dell Computer](http://kb.tableau.com/articles/issue/error-tableau-has-stopped-working-opening-or-saving-file-on-a-dell) article in the Tableau Knowledge Base. ## Troubleshoot maintenance updates (Tableau Desktop only) Tableau provides maintenance updates at regular intervals for all currently supported versions of Tableau Desktop. The following table lists reasons why maintenance updates might not be installed on a specific installed version of Tableau Desktop.
Reason Description Resolution
Your product maintenance might have expired. You can elect to purchase support and maintenance services to have ongoing access to product updates, technical support and so on, but this service must be renewed. For information about how to renew your product maintenance, see the Product Renewal FAQs on the Tableau website.
The maintenance date for your product key is not up to date. If you know that your maintenance services are current, you might need to update the maintenance expiration date for your product key. To refresh the product key with the date that your current maintenance period expires, open Tableau Desktop and select Help > Manage Product Keys.

Select the product key and then click Refresh. Close and restart Tableau Desktop.

If this doesn't resolve the issue or if the Maintenance date is not correct, contact Tableau Support.

There is a delay between the maintenance release and the prompt to update. There can be several days' delay between when a maintenance release first becomes available and when it is available through the product update process. This gives users and administrators time to evaluate and test the release in their environment before installing it. If you don't want to wait for the automatic product updates process, you can sign in to the Tableau Customer Portal to download the latest maintenance release. For information about how to download products, see Install From the User Interface in this guide.
Product updates are turned off. As a user or as an administrator, you can turn off automatic product updates. Doing this enables you to control when product updates are distributed to the computers. Turning this option off disables the Enable Automatic Product Updates menu option. It also disables the Check for Product Updates menu option. If you're a user, open Tableau Desktop, go to Help > Settings and Performance, and clear the check mark next to Enable Automatic Product Updates Then restart Tableau. If your administrator has turned off product updates for your instance of Tableau Desktop, this option is not available.

If you're an administrator, turn product updates on or off for your users. For details, see Control Product Updates for Tableau Desktop in this guide.

Tableau Desktop is still open on the computer. Tableau Desktop checks for updates only at startup. Exit and restart Tableau Desktop. When Tableau Desktop restarts, it checks for product updates.
Tableau Desktop can't contact the Tableau product update server. Tableau Desktop must be able to access the TableauAutoUpdate.xml file to check for product updates. Make sure that the computer can access TableauAutoUpdate.xml file and that the file doesn't contain an error message instead of the Tableau update information. For details, see Control Product Updates for Tableau Desktop in this guide.
[Skip to main content](#main-content) # Upgrade Tableau Desktop and Tableau Prep Builder Tableau regularly releases new versions of Tableau Desktop, Tableau Prep Builder, and Tableau Desktop Public Edition. To take advantage of new features as well as other improvements and enhancements, upgrade to the latest version. **Note:** Use [Tableau Release Navigator](https://public.tableau.com/shared/GYP3SDD2Z?:display_count=n&:origin=viz_share_link) to search for features in Tableau Desktop, Server, and Prep, or to see a full list of features when comparing your current version of Tableau to a later one. ## Before you upgrade - **Are there any power users within your organization?** If so, they should install and test the new version before the rest of the users do. Tableau tests each new version thoroughly, but every environment is unique and a test drive is never a bad idea. - **Does your organization also use Tableau Server?** You can run into compatibility issues when you try to share files between different versions of Tableau Desktop and between Tableau Desktop and Tableau Server and Tableau Cloud. Make sure that the version of Tableau Desktop you're installing and subsequent updates are compatible with the version of Tableau Server being used. For example, you can't publish to Tableau Server from Tableau Desktop if you're using a Tableau Desktop version that is newer than your Tableau Server version. For more information, see [Tableau Version Compatibility](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_version_compat_top.htm). - **Is your organization ready to upgrade all workbooks?** After you install a release upgrade, any existing workbooks you open and then save in the newer version will be upgraded. After that, these workbooks, (as well as any new workbooks you create using the new version) can't be opened with an older version of Tableau Desktop unless you downgrade the workbook. For more information about version compatibility and downgrading workbooks, see [Finding and Resolving Compatibility Issues](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_compatibility.htm). - **Is Tableau Desktop configured to install the latest maintenance release?** By default, Tableau Desktop is configured to automatically install the latest maintenance upgrade (for example 2025.3.3) for you unless this feature has been disabled by the administrator. - **Do you want to keep older versions?** Multiple versions of Tableau Desktop and Tableau Prep Builder can be installed side-by side. The installed items that are shared by each version, such as file types actions, registry entries, and so on, aren't versioned, so they are assigned to last version of the product that was installed. You can only install one version of Tableau Desktop Public Edition at one time. - **Do you want to install the latest maintenance release or a release upgrade?** Tableau products are not always released at the same time. When installing a new version of Tableau Desktop, make sure it is compatible with Tableau Server. For more information, see [Tableau Version Compatibility](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_version_compat_top.htm#versionDiff) To upgrade: - For Tableau Desktop and Tableau Prep Builder, download the maintenance or upgrade release. Go to the [Downloads](http://www.tableau.com/support/esdalt) page to see the latest releases. - For Tableau Desktop Public Edition, go to [Tableau Public](https://www.tableau.com/products/public/download) to find the latest installer. - Follow the installation instructions in [Install From the User Interface](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_download_and_install.htm) and [Install From the Command Line](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_automate.htm). - For automatic product upgrades, installers are downloaded to the `Downloads/TableauAutoUpdate` folder. If the `Downloads` folder doesn't exist, the installers are downloaded to the `TEMP/TableauAutoUpdate` folder. ## What you need to know about release upgrades For information about new features added in recent release upgrades, see the [Release Navigator](https://public.tableau.com/app/profile/tableau.core.product.marketing/viz/shared/GYP3SDD2Z). For information about security issue resolutions, bug fixes, and other details in a release for all Tableau products, see the [Known Issues](https://issues.salesforce.com/) page. ### Changes to existing workbooks and data sources (Tableau Desktop only) When you upgrade to a new release version of Tableau Desktop, bookmarks, workbooks, and data sources that you were working with (that is, that are in the local Tableau repository on your computer) are still available in the new version. For information about the Tableau repository, see [Files and Folders](https://help.tableau.com/current/pro/desktop/en-us/help.htm#environ_filesandfolders.htm) in the Tableau Help. Any recent workbooks, your recent connections list and any customizations that your organization has made to the discover pane are automatically imported when you launch your new version of Tableau Desktop. After you open and save a workbook or data source with the upgraded version of Tableau Desktop, you can no longer open it with older versions. Instead you would need to downgrade the workbook to open it. **Note:** If you were participating in the Tableau Software Beta program, you may also have a beta version of the Tableau repository. The beta repository will still exist after you install the new major version, but Tableau Desktop will no longer use it. To make your beta workbooks accessible in the new release version, copy the workbooks from the beta repository to your new repository. ### Changes to sample data sources and accelerator workbooks With a release upgrade, new sample data sources and accelerator workbooks replace the old samples—unless you've modified and saved any of the sample data sources or accelerators to an alternate location. (Prior to version 2022.2, these accelerators were called sample workbooks.) The modified data sources and workbooks are retained and the equivalent new sample data sources or accelerators are not installed. This is done on a case-by-case basis. For example, if you've modified the Sample - Superstore data source, but not any of the other sample data sources or accelerators, the installer will replace all of the other sample data sources and accelerators, but not the Sample - Superstore data source. ### Install a release version upgrade on the same computer Typically, you upgrade to the new release version number on the same computer where you were running the previous release version. You don't have to uninstall the older version before you install the new version. You can install multiple release upgrade versions of Tableau Desktop and Tableau Prep Builder on the same computer. Upgrading a maintenance release with a newer version will overwrite the older version. To determine whether the upgrade version will overwrite your current version, you can look at the version numbering for the product. The following examples shows whether an upgrade will overwrite the currently installed product version.
Current versionUpgrade versionOverwrite?
2021.3.12021.4.1No
2021.4.12021.4.2Yes
After you've been using the newer version for a while and have upgraded all your workbooks or flows, it's a good practice to uninstall the older version to avoid confusion and clutter. ### Install a release version upgrade on a different computer If you're installing a release version upgrade of Tableau Desktop or Tableau Prep Builder on a different computer from the one where you installed an older version, you must first deactivate the product key for Tableau Desktop or Tableau Prep Builder on the original computer. You can then use that product key to activate Tableau Desktop on the new computer. You won't be able to use the new version until you transfer the license. If you need to do this, see [Move or Deactivate Product Keys](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_move_or_deactivate.htm) . If you're installing a release version upgrade of Tableau Desktop or Tableau Prep Builder in an environment with Tableau Cloud or Tableau Server where login-based license management is used, you only need to sign in to activate your new installation of Tableau Desktop or Tableau Prep Builder. You do not need to deactivate the older version. The older version, if unused, is automatically reclaimed by login-based license management. For more information, see [Login-based License Management](https://help.tableau.com/current/server/en-us/license_lblm.htm). > [!IMPORTANT] > > Tableau Prep Builder is designed to work with Tableau Desktop. We recommend that you install Tableau Prep Builder on the same machine as Tableau Desktop. ### Updates to workbook themes (Tableau Desktop only) If you upgrade from an earlier version of Tableau and you open a workbook that uses the Default theme, your workbook will automatically pick up any updates to the theme. If your workbook is set to a theme other than Default, it will retain that setting. Conversely, you can change your workbook's theme from Default to a different, earlier theme. See [Format at the Workbook Level](https://help.tableau.com/current/pro/desktop/en-us/help.htm#formatting_workbook.htm) in the Tableau Help for details. ### Updates to custom geocoding (Tableau Desktop only) After you upgrade, it's a good idea to refresh your custom geocoding so you can take advantage of any fixes made to the geocoding data in Tableau. See [Data Blending vs. Custom Geocoding](https://help.tableau.com/current/pro/desktop/en-us/help.htm#maps_customgeocode_datablend.htm) in the Tableau Help. ## What you need to know about maintenance upgrades (Tableau Desktop only) Your copy of Tableau Desktop can stay current with the latest features, security resolutions, and fixes through dot (maintenance) releases. By default, Tableau Desktop is configured to install dot releases for you automatically with a feature named Automatic Product Updates. When you start Tableau Desktop for the first time after a dot release becomes available, you see a prompt offering to download it after you exit Tableau Desktop. You can choose to postpone or skip the update. (The Product Update feature will not automatically install a major upgrade.) You can also check for product updates at any time by selecting Check for Product Updates from the Help menu. If a new maintenance version is available, Tableau gives you an opportunity to download and install the latest version. **Note:** Automatic Product Updates and Check for Product Updates are not available if your Administrator has turned off this feature ### Changes to existing workbooks and data sources (Tableau Desktop only) With a dot release, there's no change to the workbooks, data sources, and other files in your Tableau repository, and everything in Tableau Desktop should look the same as before. One exception is that Tableau sometimes makes new data source connectors available with a maintenance release. For information about the individual security resolutions, bug fixes, and other changes in any dot release, see the [Release Notes](http://www.tableau.com/support/releases) page. Another resource is the [Subscription and Maintenance Policy](http://mkt.tableau.com/files/Tableau-Maintenance-Policy.pdf), which provides basic information about product maintenance. ### If maintenance releases aren't installed automatically (Tableau Desktop only) If maintenance updates aren't being installed on your computer, your copy of Tableau might not be configured for automatic updates, or there might be a problem with updating. For more information, see the [Troubleshoot maintenance updates (Tableau Desktop only)](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_troubleshoot.htm#Maintenance_updates) section in the troubleshooting article of this guide. You can turn Product Updates off or on from within Tableau Desktop: - Choose Help > Settings and Performance > Enable Automatic Product Updates. This option is only available if Product Updates was enabled during the product install. If the feature was disabled during installation, this menu item is also disabled. [Skip to main content](#main-content) # Using the User Interface Uninstaller You can have multiple Tableau Desktop and Tableau Prep Builder installations on your computer. If you want to remove older versions or you want to perform a clean installation with default settings, you can completely remove the products, including preferences, saved application state and sample files. **Windows** 1. Go to Control Panel > Programs \> Programs and Features. 2. From the list of programs, right-click the Tableau product and select Uninstall/Change. 3. From the Modify Setup menu, select Uninstall. 4. Navigate to C:/Program Files/Tableau. 5. Delete the Tableau folder for the version of Tableau product that you uninstalled. **Mac** 1. From the Applications folder, delete the Tableau application. 2. From your Documents folder, delete My Tableau Repository. Be sure to preserve any user-created files. As an alternative to deleting My Tableau Repository, you can renamed the folder. For example: _My Tableau Repository Backup_. 3. From Preferences in the Library folder, delete all files whose names begin with com.tableau. 4. From Saved Application State in the Library folder, delete all folders whose names begin with com.tableau. Some folders are hidden on the Mac. - To show hidden folders, press Command+Shift+Dot. - To navigate to hidden folders: 1. ​​In Finder, select Go > Go To Folder... (Command+Shift+G). 2. In dialog box, type the folder name such as ~/Library/Preferences. > The ~ is a shortcut for the current user's Home directory, located at /Users/<_username_\>. If Tableau Desktop or Tableau Prep is used by multiple users on the affected computer, repeat steps 2 through 4 for each user. [Skip to main content](#main-content) # Where's the installer? This topic describes how to find and download the installers for Tableau Desktop, Tableau Desktop Public Edition, Tableau Prep Builder, and Tableau Reader. ## Tableau Desktop and Tableau Prep Builder installers You can find the Tableau Desktop and Tableau Prep Builder installers on the [Product Downloads](http://www.tableau.com/support/esdalt) page, and if you are a Tableau Customer, on the [Customer Portal](http://customer.tableau.com/) page. > [!IMPORTANT] > >  Tableau products are not always released at the same time. When installing a new version Tableau Desktop, make sure it's compatible with Tableau Server. For example, a new release of Tableau Desktop might be available, but a compatible version of Tableau Server might not be available for several months. See [Finding and Resolving Compatibility Issues](https://help.tableau.com/v0.0/desktopdeploy/en-us/desktop_deploy_compatibility.htm). ### Product Downloads The _Product Downloads_ page requires a Tableau.com account to access the installers. You can also find all available versions. After you download and install the product, you will need to activate the product. **Note:** Beginning with version 2026.1.0, use the Tableau Desktop installer for both Tableau Desktop Professional Edition and Tableau Desktop Free Edition. 1. Go to the [Product Downloads](http://www.tableau.com/support/esdalt) page and select Tableau Desktop or Tableau Prep Builder from the list on the left side of the page. 2. Select the version you want to install. ![Tableau Desktop release notes and download links.](/tableau/next/en-us/desktopdeploy/en-us/Img/desktop_deploy_alt_download.png) 3. In the Download Files section of the page, select the installer for your operating system to download it. ![Download Files screen](/tableau/next/en-us/desktopdeploy/en-us/Img/desktop_deploy_win_mac.png) ### Tableau Customer Portal The Tableau Customer Portal is managed by your internal Tableau Portal Administrator or by someone in your IT department. For more information, see [Getting Started with the Customer Portal](https://kb.tableau.com/articles/howto/getting-started-with-the-customer-portal?lang=en-gb). 1. As a Customer Portal user, go to the [Customer Portal.](http://customer.tableau.com/) 2. Under Quick Links, select Product Downloads. 3. Select the appropriate link to download the installer for your product and operating system. ## Tableau Desktop Public Edition installer Tableau Public is a platform where you can explore and share data visualizations online. Tableau Desktop Public Edition is a free data visualization tool that you can use to publish to Tableau Public. You can also post to Tableau Public from Tableau Desktop, Tableau Server, or Tableau Cloud. To get the Tableau Desktop Public Edition installer: 1. Go to [Tableau Public.](https://www.tableau.com/products/public/download) 2. Select DOWNLOAD THE APP. 3. Fill out the registration form, then select DOWNLOAD THE APP on the form. To access the Tableau Public environment, you will need to create a profile. You can post to Tableau Public from Tableau Desktop, Tableau Server, or Tableau Cloud. ## Tableau Reader installer Tableau Reader is a free desktop application that you can use to open and interact with data visualizations built in Tableau Desktop. As an alternative, you can use the Tableau Viewer role. For more information, see [Tableau Viewer vs. Tableau Reader](https://www.tableau.com/products/viewer-vs-reader). To get the Tableau Reader installer: 1. Go to [Tableau Reader](https://www.tableau.com/products/reader/download). 2. Select DOWNLOAD THE APP. The download begins automatically.