Dashboard Extensions in Tableau Server
Dashboard extensions are web applications that run in custom dashboard zones and can interact with the rest of the dashboard using the Tableau Extensions API. Dashboard extensions give users the ability to interact with data from other applications directly in Tableau.
Note: You must be a server administrator to enable dashboard extensions on the server, or to block specific extensions from running. You must be a server administrator (or site administrator on Tableau Online) to add extensions to the safe list and to control the type of data the extensions can access. The server administrator (or site administrator on Tableau Online) can also configure whether users on the site will see prompts when they add or view extensions in a dashboard.
For information about using dashboard extensions in Tableau, see above Dashboard Extensions.
Before you run extensions on Tableau Server
Dashboard extensions are web applications and could be running on any computer set up as a web server. This includes local computers, computers in your domain, and third-party web sites. Because extensions could be hosted on third-party sites and could have access to the data in the dashboard, you want to only allow the extensions you trust. See Test extensions for security.
For security, the default settings for dashboard extensions on Tableau Server and Tableau Online limit the dashboard extensions that are allowed to run.
- By default, only extensions that use the HTTPS protocol are allowed, which guarantees an encrypted channel for sending and receiving data (the only exception is for
- By default, when extensions are enabled on the server, only extensions that require summary data (the aggregated data) from the view are allowed.
- If the extension requires full data (access to the underlying data) the extension will not be able to run on Tableau Server or Tableau Online unless you explicitly add the extension to the safe list and grant the extension access to full data.
Control dashboard extensions access to data
Server administrators can control a global setting to allow extensions for all sites on the server. Server administrators can also put extensions on a global block list to prevent them from running. By default, extensions are enabled on the server (with the constraints previously described). To change this setting for the server, go to Manage All Sites > Settings > Extensions. If the server just has a single site, the global controls appear on the settings page for the site.
Server administrators can control whether to enable extensions for the site and whether to enable the default behavior (or policy) for extensions. That is, the default policy is that only extensions that request summary data are allowed to run on the site, and that all users will see prompts asking for permission to run. To change these settings for the site go to Settings > Extensions.
Server administrators can add or remove extensions from the safe list for a site. When you add an extension to the safe list, you can control whether to allow the extension to have access to full data.
Identifying an extension
As a web application, an extension is associated with a URL. You use this URL to test and verify the extension. You also use the URL to add the extension to the safe list to allow full data access, or to the block list to prohibit any access.
If you have the extension manifest file (
.trex), an XML file that defines properties for the extension, you can find the URL from the
If you have added the extension to the dashboard, you can find the URL from the extension properties. From the More Options menu, click About.
The About dialog box lists the name of the extension, the author of the extension, the web site of the author, along with the URL of the extension.
Add extensions to the safe list and configure user prompts
To ensure that users can use extensions that are trusted, you can add them to the safe list for the site.
On the safe list, you can control whether to grant the extension full data access. You can also control whether users will see a prompt asking them to allow the extension access to data. If the extension does not require full data access, you don’t need to add it to the safe list. You might want to add an extension to the safe list just so that you can configure whether or not users see the prompts.
- Go to Settings > Extensions.
- Under Enable Specific Extensions, add the URL of the extension. See Identifying an extension.
- Choose to Allow or Deny the extension Full Data Access.Full data access is access to the underlying data in the view, not just the summary or aggregated data. Full data access also includes information about the data sources, such as the names of the connection, fields, and tables. In most cases, if you are adding an extension to the safe list you will also be allowing to have access to full data.
- Choose to Show or Hide the User Prompts.Users see the prompts by default when they are adding an extension to a dashboard, or when they are interacting with a view that has an extension.
Assign permnmission: Download Summary data
To allow extensions to operate properly the users must have permissions to “Download Summary data”.
You can set permissions as a Tableau Server Administrator and you have to set the permissions on every project/workbook where you want your Tableau users to view dashboards with extensions.
Block specific extensions
The default global policy allows unknown extensions to run, provided that they only access summary data. Server administrators can keep specific extensions from running by adding them to the block list for the server. If an extension is on the global block list it overrides any settings for the extension on the safe list for a site.
- To add an extension to the blocked list for the server, go to Manage All Sites > Settings > Extensions. On single-site installations, the block list is on the site Extensions settings page.
- Under Block Specific Extensions, add the URL of the extension. See above “Identifying an extension”.
Test extensions for security
Examine the source files
*.trex), you can find the source location, or URL indicated where the extension is hosted, the name of the author, and the web site of the author or company to contact for support. The
element specifies in the URL, the
element, specifies the name of the organization and the web site to contact for support (
website="SUPPORT_URL"). The web site is the Get Support link user see in the About dialog box for the extension.
All extensions are required to use HTTPS protocol (
https://) for hosting their extensions. You should examine the source files for the extension to ensure that any reference to external libraries is also using HTTPS or is hosted on the same web site as the extension. The one exception to the requirement of HTTPS is if the extension is hosted on the same computer as Tableau (
To the extent possible, make sure you understand what the code is doing. In particular, try to understand how the code is constructing requests to external sites, and what information is being sent in the request. In particular, check if any user-supplied data is validated to prevent cross-site scripting.
Understand data access
The Tableau Extensions API provides methods that can access the names of the active tables and fields in the data source, the summary descriptions of the data source connections, and the underlying data in a dashboard. If an extension uses any of these methods in a view, the extension developer must declare that the extension requires full data permission in the manifest file (
.trex). The declaration looks like the following.
Tableau uses this declaration to provide a prompt to users at run time that gives them the option of allowing this access or not. If the extension uses any one of these four methods, without declaring full-data permission in the manifest file, the extension will load but the method calls will fail.
getDataSourcesAsync() method is called.
Test the extension in an isolated environment
If possible, test the dashboard extension in an environment that is isolated from your production environment and from user computers. For example, add a dashboard extensions to a safe list on a test computer or virtual machine that’s running a version of Tableau Server that is not used for production.
Monitor traffic created by the dashboard extension
When you test a dashboard extension, use a tool like Fiddler, Charles HTTP proxy, or Wireshark to examine the requests and responses that the extension makes. Make sure that you understand what content the extension is requesting. Examine the traffic to be sure that the extension is not reading data or code that is not directly related to the purpose of the extension.