On this Page

Overview

You can use this Snap to invoke Tableau's REST API.

Prerequisites

None.

Support for Ultra Pipelines

Works in Ultra Task Pipelines.

Limitations

Supports Tableau 10.5. To know more about the REST APIs supported by the Snap refer to REST API - What's New?
To publish hyper files without packaging them as a data source, the file must contain exactly one schema in one table.

Known Issues

None.

Snap Input and Output

Input/Output	Type of View	Number of Views	Examples of Upstream and Downstream Snaps	Description
Input	Document	Min:1 Max:1	Mapper Copy
Output	Document	Min:1 Max:1	Mapper	REST output sent to the output view with Tableau REST XML (for example, Headers and REST Status line) with response entity converted from XML to JSON.

Field Name	Field Dependency	Description
Label*	N/A	Specify the name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your Pipeline.
REST operation*	N/A	Specify the Tableau REST operation to perform. Alternatively, click the Suggestion icon to fetch the list of REST API calls supported. For a list of Tableau REST operations, see the Tableau API Reference documentation.
Timeout	N/A	Specify the timeout for HTTP in seconds.
Maximum retries	N/A	Specify the maximum number of HTTP request retries.
Upload file	N/A	Enter the path of the file that you want to upload. If you enter a relative path, this Snap considers it as an SLDB file. If this field is left empty, HTTP entity and Batch Size fields are ignored. If you enter an expression in this field, the input document is used to evaluate the expression. Each input document invokes one file upload. This field does not support wildcard or glob pattern. Datasource and Workbook files should be same version as Tableau REST API (for example the ".tde" tableau data extract file should have been created from Tableau version 9.x for the publish data source REST operation). Used only for publish datasource and publish workbook REST operations to write data into Tableau.
Chunk size	N/A	Specify the chunk size (in kilobytes) to upload. Specify 0 if you do not want chunking mechanism to be used during upload/publish. This field only applies to publishing Tableau workbooks or Tableau datasources operations with an upload file defined. This is a recommended setting for large files and is mandatory for file sizes greater than 64 MB. Default value: 1000
Snap Execution	N/A	Select one of the three modes in which the Snap executes. Available options are: Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline runtime. Execute only: Performs full execution of the Snap during Pipeline execution without generating preview data. Disabled: Disables the Snap and all Snaps that are downstream from it. Default Value: Execute only Example: Validate & Execute

Behavioral Change

In the 4.23 release, the Tableau REST Snap had a defect where it used site ID and user ID from the Tableau Account even if the selected REST operation required a site ID and/or user ID from the input document. This issue is fixed in the 4.24 release, so that the Snap uses values for the said IDs from the input document when available. Since this fix changes the Snap behavior, it is possible for production Pipelines to fail after the 4.24 release. Hence, you need to reconfigure the Tableau REST Snap using the site ID and user ID values from the input document.

Troubleshooting

See related information to find documentation from Tableau.
Start new development with more simpler REST operations like query sites before troubleshooting more complex REST operations like publish datasource.
You may wish to use a second tool (for example, curl) for independent verification of Tableau Server configuration.
Tableau uses ID with GUID like values as opposed to worded names for input parameters (for example SiteId is used instead of Site Name)

Example

Publishing Datasource in a Single Request

The following example Pipeline shows how to publish a data source to Tableau using the Tableau REST Snap:

A Mapper Snap maps the data source details (to be created/published) to the input view of Tableau REST Snap. sample1.tde is the data source that will be published in Tableau:

A Tableau REST Snap uses the publish_datasource operation to publish the specified data source, sample1.tde, to Tableau. In this operation, the Tableau file specified in the Upload file field uploads its data to sample1.tde:

Successful execution of the Snap shows the following preview with the data source ID and name:

Downloads

	File	Modified
Labels No labels View	File Tableau_REST_Publish_Datasource.slp	Mar 29, 2019 by Mohammed Iqbal

Snap Pack History

Click to view/expand

Release	Snap Pack Version	Date	Type	Updates
4.27	main12833	13 Nov 2021	Stable	Upgraded with the latest SnapLogic Platform release.
4.26	main11181	14 Aug 2021	Stable	Added the following Tableau Snaps to support hyper extract files for Tableau 10.25 and later versions. Hyper Formatter: Converts the incoming documents to Tableau hyper extract format and sends the output (extract) to the binary output view. Hyper Parser: Parses Tableau hyper extract files and converts them to a document format. Hyper Write: Creates a hyper file in a temporary location (local disk) for incoming documents and publishes it to Tableau Server/Online without packaging it into a data source.
4.25	425patches10994	04 Aug 2021	Latest	Fixed an issue with Tableau REST Snap where the Snap was not able to filter or route the output data shows either duplicate records or incorrect results.
4.25	main9554	08 May 2021	Stable	Upgraded with the latest SnapLogic Platform release.
4.24	main8556	13 Feb 2021	Stable	Fixed an issue when updating user information in the Tableau REST Snap by not overwriting the site ID or user ID if the entries already exist. Behavioral Change In the 4.23 release, the Tableau REST Snap had a defect where it used site ID and user ID from the Tableau Account even if the selected REST operation required a site ID and/or user ID from the input document. This issue is fixed in the 4.24 release, so that the Snap uses values for the said IDs from the input document when available. Since this fix changes the Snap behavior, it is possible for production Pipelines to fail after the 4.24 release. Hence, you need to reconfigure the Tableau REST Snap using the site ID and user ID values from the input document.
4.23	main7430	14 Nov 2021	Stable	Upgraded with the latest SnapLogic Platform release.
4.22	main6403	12 Sep 2020	Stable	Upgraded with the latest SnapLogic Platform release.
4.21	snapsmrc542	09 May 2020	Stable	Upgraded with the latest SnapLogic Platform release.
4.20	snapsmrc535	08 Feb 2020	Stable	Upgraded with the latest SnapLogic Platform release.
4.19	snaprsmrc528	19 Nov 2019	Stable	Upgraded with the latest SnapLogic Platform release.
4.18	snapsmrc523	10 Aug 2019	Stable	Upgraded with the latest SnapLogic Platform release.
4.17	ALL7402	11 Jun 2019	Latest	Pushed automatic rebuild of the latest version of each Snap Pack to SnapLogic UAT and Elastic servers.
4.17	snapsmrc515	11 Jun 2019	Latest	Added the Snap Execution field to all Standard-mode Snaps. In some Snaps, this field replaces the existing Execute during preview check box.
4.16	snapsmrc508	16 Feb 2019	Stable	Upgraded with the latest SnapLogic Platform release.
4.15	snapsmrc500	15 Dec 2018	Stable	Upgraded with the latest SnapLogic Platform release.
4.14	snapsmrc490	15 Aug 2018	Stable	Upgraded with the latest SnapLogic Platform release.
4.13	snapsmrc486	12 May 2018	Stable	Enhanced Tableau Snap Pack to support Tableau version 10.5 (Server version), this includes support for refresh task related REST API calls in the Tableau REST Snap.
4.12	snapsmrc480	17 Feb 2018	Stable	Upgraded with the latest SnapLogic Platform release.
4.11	snapsmrc465	11 Nov 2017	Stable	Upgraded with the latest SnapLogic Platform release.
4.10	snapsmrc414	12 Aug 2017	Stable	Upgraded with the latest SnapLogic Platform release.
4.9	snapsmrc405	13 May 2017	Stable	Extended the support for Tableau 9 and 10 REST Snap to access the TDE files on S3 (using the IAM role on the Snap Account). Support extended for Tableau 10.1 server version. Updated the Snap account with the properties, XML Schema URL and API version (other). Updated the Snap account with Access Key ID, Secret Key and IAM role to support access to files on S3. Tableau REST Snap extended support to access the TDE files on S3.
4.8	tableau92770	17 Mar 2017	Latest	Addressed an issue where the TDE Formatter threw a Field conversion failed error.
4.8	snapsmrc398	11 Feb 2017	Stable	Upgraded with the latest SnapLogic Platform release.
4.7	snapsmrc382	23 Nov 2016	Stable	Upgraded with the latest SnapLogic Platform release.
4.6	snapsmrc362	13 Aug 2016	Stable	Enhanced to support chunking when publishing large files for the Tableau 9&10 REST Snap. Enhanced error reporting when fields are improperly mapped from input Tableau 9&10 REST Snap. Enhanced error handling to appropriately route errors in the Tableau 9&10 Write Snap. Enhanced error handling to appropriately route errors in the Snap for the TDE Formatter Snap. Extended the TDE Formatter Snap support for Linux Snaplexes. Doc Enhancement: Examples added to Tableau 9 Snap documentation. Resolved an issue in Tableau REST Snap that caused failures when publishing workbook and datasources. Resolved an issue in TDE Formatter and Tableau REST Snap that cause errors on Windows Groundplex. Resolved an issue in Tableau REST Snap that only made available 100 entries of datasource.
4.5.1	tableau91634	18 May 2016	Latest	Initial release of the Snap Pack with Tableau 9&10 REST, Write and the TDE Formatter Snaps. Supports Tableau 9.1 version of Tableau server.

See Also

Process and APIs required for Publishing