Tableau REST
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 |
|
| |
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. |
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.
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:
|
Behavioral Change
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
Important steps to successfully reuse Pipelines
- Download and import the Pipeline into SnapLogic.
- Configure Snap accounts as applicable.
- Provide Pipeline parameters as applicable.
Snap Pack History
See Also