Was this page helpful?
Yes No
Tableau Help > Tableau Desktop Deployment Guide Overview > 
Install for Others > Deploy Tableau Desktop

Deploy Tableau Desktop

Important: You must first download the installer for the version that you want to install before proceeding with the instructions in the article.

This article describes how to perform a silent install for Tableau Desktop and perform other installation actions, such as activation, registration and uninstall using the command line. You can also find information about how to upgrade Tableau Desktop to a newer version.

Note: The instructions in this article also apply to Tableau Desktop for Public and Tableau Reader where noted.

In this article

Install on Windows

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 section of this article.

If you are installing Tableau Desktop version 9.2 and earlier, follow the instructions in the Install Tableau Desktop 9.2 and earlier versions section of this article instead.

The syntax for running the Tableau installer from the command line is:

tableau_<product_installer_name>.exe /option1 /option2 PROPERTY1 PROPERTY2

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 tableau_<product_installer_name>.exe file is the Tableau installer for the product and version you're installing. The options specify how the installation process should run—for example, whether it should display output while installing or whether it should create log files. The properties settings specify configuration settings that the installer should make during the installation process.

The following example shows an installer command with some options and some property settings.

tableauDesktop-64bit-10-3-0.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 10.3.

  • 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.

Install Tableau Desktop 9.2 and earlier versions

To install Tableau Desktop 9.2 and earlier versions you can use either the self-extracting executable (.exe) file or you can extract the .msi file from the self-extracting .exe file and use the .msi directly. The self-extracting (.exe) file includes a single .msi installer that works for each supported language.

This section provides instructions about how to install using either method.

Install using the self-extracting .exe file

  1. Download Tableau Desktop to your computer.

  2. Open the Command Prompt as an Administrator and run the installer using the following syntax:

    tableau.exe /option1 /option2

    Example: tableau.exe /q:a /c:"setup /q"

    In this example, /q:a specifies administrator-quiet mode to suppress the license dialog boxes and /c:"setup /q" specifies the name of the setup program to run in quiet mode. You can also replace q with qr to display the license dialog boxes.

Install using the .msi installer package

If you use this method you must first extract the .msi file from the self-extracting .exe and then run the installation process.

  1. Extract the .msi file from the self-extracting .exe file using the following syntax:

    tableau.exe /t:"<full path to folder>" /c

    Example: tableau.exe /t:"C:\Users\asmith\Desktop\TableauDesktopTemp" /c

    In this example /t: specifies where to put the extracted contents and /c specifies that the files should be extracted to the specified location.

  2. Open the directory where you extracted the files and note the full name of the .msi file, such as tableau-setup-std-tableau-6-1.11.0724.1830.msi. You need this information for the next step.

  3. Open a Command Prompt as an Administrator and run the install process using the following command:

    msiexec /i <fullfilename.msi> /q

    Replace <fullfilename.msi> with the .msi file name that you noted in Step 2.

    /q runs the install quietly and suppresses the user interface and license dialog boxes. There is no progress bar and the product doesn't launch automatically when the process completes.

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.

Option Description
quiet Run the installer without messages (status or installation progress) and without requiring user interaction. The product doesn't launch after installation is complete.
passive Run the installer and display dialog boxes and installation status. But does not prompt the user for input. The product launches after installation is complete.
norestart Suppress 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.
repair Run the installer to repair an existing installation of Tableau.
h Help—lists options and properties for the installer. This option only applies to Tableau Desktop 9.3 and later versions.

Installer properties

You can include one or more properties in the command line for the installer. Note the following about properties:

  • Property names 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 Applies to 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 mode. Tableau Desktop 10.1 and later 1=Accept
0=Don't accept (default)
AUTOSAVE Configure Tableau to automatically save your work every few minutes. In the event that Tableau closes unexpectedly, users can open a recovered version of the file (.twbr).

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

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

For more information see Plan Your Tableau Desktop Deployment and Change Installation Settings after Installation.

Tableau Desktop 10.2 and later 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.
Tableau Desktop 9.1 and later (Auto update)

Tableau Desktop 10.2 and later (Check for Product Updates)

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. Tableau Desktop 9.1 and later A host name, such as assets.internal.lan. The default is
downloads.tableau.com
DATABASEDRIVERS Install the default set of drivers for databases that your users might connect to from Tableau Desktop. For more information, see the "Database drivers" section in Before You Install.

To download other drivers, see the Driver Download page. You must distribute other drivers using whatever asset management tools you use for software deployment in your organization.

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

Tableau Desktop 9.3 and later 1=Yes (default)
0=No
DESKTOPSHORTCUT Create a desktop shortcut. All Tableau versions 1=Yes (default)
0=No
DRIVERDIR For Windows, 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. The default location for drivers is Program Files/Tableau/Drivers.

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 10.3 and later A path such as D:\Drivers
INSTALLDIR Specify an installation directory other than the default. All Tableau versions A path such as D:\Software\Tableau.
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 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"
Tableau Desktop 10.1 and later 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 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:
  • 10.0 starting from 10.0.5
  • 10.1 starting from 10.1.2
  • 10.2 starting from 10.2.1
An integer value, in seconds.

The default is 28800 (8 hours).

SKIPAPPLICATIONLAUNCH For Windows. You can set this option to "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 opens automatically when using that option. Tableau Desktop 10.4 and later 1=Yes
0=No (default)
STARTMENUSHORTCUT Create a Tableau entry on the Windows Start menu. All Tableau Versions 1=Yes (default)
0=No

(Back to top)


Extract and run the Windows (MSI) installer

Note: This section applies to Tableau Desktop 9.3 and later versions only.

If you're using a deployment tool that requires the Windows installer (.msi file) to install Tableau Desktop, 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/).

  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 <path_to_the_Tableau_exe_installer> -x <output_folder>

    For example, run the following command:

    Dark.exe C:\tableau-setup-std-tableau-10-1.16.1213.1319-x64.exe -x c:\output

The output folder will contain a folder named AttachedContainer that includes the .msi files.

(Back to top)


Install on Mac

To deploy Tableau Desktop for Mac, 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.

Note: For Tableau Reader or Tableau Public, you would open Tableau Reader.pkg or Tableau Public.pkg instead of Tableau Desktop.pkg.

Example: Tableau Desktop 10.2 and later versions

#!/usr/bin/env bash
# mount the DMG and copy Tableau.app to a folder
output=`yes | hdiutil attach "<DMG_name>.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

You also have the option to run the installer application if you want to perform a silent installation. Type the following at a Terminal prompt:

sudo installer -pkg <path and name of .pkg file> -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.

Example: Tableau Desktop 10.1 and earlier versions

#!/usr/bin/env bash
# mount the DMG and copy Tableau.app to a folder
output=`yes | hdiutil attach "<DMG_name>.dmg"`
sleep 10
volName=`echo "$output" | tail -n 1 |sed 's;^.*\(/Volumes.*$\);\1;'`
ditto "/Volumes/Tableau/Tableau.app" "<destination path>/Tableau.app"
# dismount the Tableau DMG volume
hdiutil detach """${volName}""" -force

Select drivers to install automatically for the Mac

By default, several data source drivers are automatically installed with Tableau Desktop. For a complete list, see Before You Install. To prevent one or all of the drivers from installing automatically, first run the Mac Installer application against Desktop.pkg with ‑showChoiceChangesXML to generate a plist file containing all possible customizations. The syntax is:

installer -showChoiceChangesXML -pkg <path and name of .pkg file> –target / > <name of plist>

For example:

installer -showChoiceChangesXML -pkg Install\ Tableau\ Desktop.pkg –target / > InstallTableauDesktopChoices.xml

Here’s what the section in the resulting plist file looks like for the Oracle driver:

<dict> <key>attributeSetting</key> <integer>1</integer> <key>choiceAttribute</key> <string>selected</string> <key>choiceIdentifier</key> <string>com.tableausoftware.oracle</string> </dict>

To prevent this driver from being installed, change the value of <integer> from 1 to 0, which is the equivalent to deselecting it in the GUI.

After you’ve modified the plist file to deselect any drivers you don’t want, save the file, and then pass it to installer by adding it to the command line:

-applyChoiceChangesXML <pathToXMLFile>

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 https://developer.apple.com/legacy/library/documentation/Darwin/Reference/ManPages/man8/installer.8.html.

Disable the desktop shortcut for the Mac

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.

<dict> <key>attributeSetting</key> <integer>0</integer> <key>choiceAttribute</key> <string>selected</string> <key>choiceIdentifier</key> <string>com.tableausoftware.desktopShortcut</string> </dict>

(Back to top)


Activate Tableau Desktop

After Tableau Desktop has been installed, you need to activate the product by sending an activation request to Tableau. To do this in an automated way, start Tableau from the command line and use the -activate option. This option takes one parameter, which is the product key.

If you want to activate Tableau Server using automated scripts, see Automate Licensing Tasks in the Tableau Server Help.

Windows

Run tableau.exe with the -activate option and a product key, as in the following example:

tableau.exe -activate <product_key>

By default, the tableau.exe file is located in the following folder:

C:\Program Files\Tableau\Tableau <version>\bin

Mac

Run the -activate option on the Tableau object in the Applications path:

./Applications/Tableau.app/Contents/MacOS/Tableau -activate <product_key>

For information about exit codes that you can capture and evaluate if licensing fails, see Troubleshoot activation errors using activation exit codes in the Troubleshoot Installation article in this guide.

(Back to top)


Refresh the product key

If the maintenance date for your product key is not up-to-date, you can refresh the product key. This process updates the product key with the date that your current maintenance period expires and stops expiration messages you may have already received.

To refresh a Tableau Desktop product key using the command line, use the -refresh option. This option takes one parameter, which is the product key.

If you want to refresh a Tableau Server product key using automated scripts, see Automate Licensing Tasks in the Tableau Server Help.

Windows

Run tableau.exe with the -refresh option and a product key, as in the following example:

start/wait tableau.exe -refresh <product_key>

Mac

Run the -refresh option on the Tableau object in the Applications path:

./Applications/Tableau.app/Contents/MacOS/Tableau -refresh <product_key>

(Back to top)


Deactivate the product key

If you want to move Tableau Desktop to another computer, or no longer need it on a computer, you should deactivate the product key. To retrieve and deactivate a Tableau Desktop product key without having to manually remove it from an individual computer, start Tableau from the command line using the -return option. This option takes one parameter, which is the product key.

If you want to deactivate a Tableau Server product key using automated scripts, see Automate Licensing Tasks in the Tableau Server Help.

Windows

Run tableau.exe with the -return option and a product key, as in the following example:

start/wait tableau.exe -return <product_key>

Mac

Run the -return option on the Tableau object in the Applications path:

./Applications/Tableau.app/Contents/MacOS/Tableau -return <product_key>

(Back to top)


Register Tableau Desktop

You can ensure consistent registration across your organization by automating the task of registering individual copies of Tableau.

Registration information is stored on the computer where Tableau is installed. For Windows, the information is in the registry. For 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).

The registration information is saved under one of the following locations:

  • Windows. The following location in the registry: HKEY_CURRENT_USER\Software\Tableau\Registration\Data

  • Mac. The following .plist file location: /Users/<user_name>/Library/Preferences/<.plist_file_name>

To register Tableau from the command line, you need to prefill the registry (Windows) or property list (Mac) values on each computer that will run Tableau Desktop. You can perform the installation process and use the register command line option. When Tableau starts, it reads the registration information and registers Tableau for that user.

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 Tableau Desktop 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 image shows what the registry values look like in the registry editor (regedit):

 

Use the template to register Tableau on another computer

  1. On another computer, install Tableau Desktop.

  2. Run tableau.exe with the register option:

    tableau.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\Logs\log.txt

    If registration fails, the automated script you created needs to be updated. For troubleshooting tips, see Troubleshoot Tableau Desktop Installation.

Mac

Register Tableau and create a template

To register Tableau Desktop 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 Tableau Desktop on at least one Mac computer. This creates the .plist file that you can use as a template to register Tableau Desktop on other computers.

  2. Go to /Users/<user_name>/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/<user_name</Library/Preferences folder on the Mac where you want to install Tableau Desktop.

  4. Run the following command:

    cd /Users/<user_name>/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 <key_value>

    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.

    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 use the following command:

      ./Tableau –activate <product_key>

    • To register Tableau desktop use the following command:

      ./Tableau -register

(Back to top)


Uninstall Tableau Desktop

While it is not necessary to uninstall previous versions of Tableau Desktop when installing a newer version, you can uninstall any version of Tableau Desktop if you no longer need it on your computer.

Windows

To uninstall Tableau Desktop 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-<product_installer_name>.exe /uninstall /quiet

    To uninstall Tableau Desktop 9.2 and earlier versions, from the command prompt type msiexec /x tableau.msi /q instead.

Mac

To uninstall Tableau Desktop on the Mac, drag the application and the Desktop shortcut (if there is one) to your trash folder and then empty your trash.

Any drivers that were installed automatically (Tableau Desktop 10.2 versions and later only) must be uninstalled manually.

(Back to top)


Upgrade Tableau Desktop

You can download the installers for the version that you want to upgrade to from theProduct Downloads and Release Notes page. Then follow the same instructions for installing Tableau Desktop for your operating system in this article to deploy the new version. Maintenance updates are installed automatically to your user's machines unless you have disabled this feature.

Keeping Tableau Desktop up to date with the latest version ensures that your users have the latest software fixes and features for optimum performance and usability. When you upgrade Tableau Desktop, you can either perform a major upgrade or a maintenance update.

For more information about the differences between types of upgrades, version compatibility and so on when considering an upgrade to Tableau Desktop, see Upgrade Tableau Desktop.

(Back to top)