On this Page
|Table of Contents|
You can use this Snap to invoke Tableau's REST API.
Support for Ultra Pipelines
Works in Ultra Task Pipelines.
- 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.
Snap Input and Output
|Input/Output||Type of View||Number of Views||Examples of Upstream and Downstream Snaps||Description|
|Output||Document||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.|
|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.|
Specify the Tableau REST operation to perform. Alternatively, click the Suggestion icon to fetch the list of REST API calls supported till Tableau 10.5. For a list of Tableau REST operations, see the Tableau API Reference documentation.
Specify the timeout for HTTP in seconds.
Specify the maximum number of HTTP request retries.
Enter the path of the file that you want to upload.
Specify the chunk size (in kilobytes) to upload. Specify 0 if you do not want chunking mechanism to be used during upload/publish.
Default value: 1000
Select one of the three modes in which the Snap executes. Available options are:
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.
- 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)
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:
|Multiexcerpt include macro|