Tableau Deployment Guide

Configure Tableau Desktop licence 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 licences in your organisation. For information about how to track Server Licences usage, see View Server Licences(Link opens in a new window) in the Tableau Server help.

Tableau provides the following tools to help you track and manage licensing and usage in your organisation.

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://<tsm-computer-name>:8850. For more information, see Sign in to Tableau Services Manager Web UI(Link opens in a new window) 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 Licence 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:

   

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(Link opens in a new window) in the Tableau Server Help.

Step 2: Configure Desktop for reporting

You can configure Tableau Desktop for reporting licence 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 licence 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.

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 licence 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 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 organisation 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.



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

   <?xml version="1.0" encoding="UTF-8"?>
   <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
   <plist version="1.0">
     <dict>
       <key>Server</key>
       <string>https://mytableau02,http://mytableau</string>
       <key>scheduleReportInterval</key>
       <string>14400</string>
     </dict>
   </plist>

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 Licence Usage administrative view see licence usage data.

The Tableau Desktop Licence Usage administrative view can answer questions such as:

• What types of licences are installed in your organisation.

• Which users have Tableau licences.

• Which licences are used most often and least often.

• Whether trial licences need to be converted to paid licences.

• Which licences are expired or might soon expire.

• When maintenance renewals are due in your organisation.

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 Licence Usage(Link opens in a new window) and Desktop Licence Expiration(Link opens in a new window) in the Tableau Server Help.