Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

On this Page

Table of Contents
maxLevel2
excludeOlder Versions|Additional Resources|Related Links|Related Information

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/OutputType of ViewNumber of ViewsExamples of Upstream and Downstream SnapsDescription
Input Document
  • Min:1
  • Max:1
  • Mapper
  • Copy

OutputDocument
  • 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/ASpecify 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 till Tableau 10.5. For a list of Tableau REST operations, see the Tableau API Reference documentation. 

TimeoutN/A

Specify the timeout for HTTP in seconds.

Maximum retriesN/A

Specify the maximum number of HTTP request retries.

Upload file 


N/A

Enter the path of the file that you want to upload. 

Info
  • 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).


Note

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.

Info

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

Info
iconfalse
titleBehavioral 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

Multiexcerpt include macro
namedownload_instructions
pageOpenAPI

Attachments
patterns*.slp, *.zip

Excerpt Include
Tableau Snap Pack
Tableau Snap Pack
nopaneltrue

See Also