Skip to main content

Publish to Tableau Server Tool Icon Publish to Tableau Server Tool

Warning

The Publish to Tableau Server tool is deprecated. Install the Tableau Output tool which provides updated features.

As of 2023.2, the Publish to Tableau Server Tool will not be delivered with Designer anymore. To retain this tool, see our guide in the Alteryx Community.

Version

Description

v2.0.0

  • As of 2018.4, the tool comes pre-installed, and will contain future updates.

  • Attach a .tds file for data source metadata. Requires Alteryx version 2018.2 or 2018.3, and Tableau Server 10.5 or newer.

v1.09.2

  • Support for Tableau Hyper. Fixed path issue. Field validation update. Requires Alteryx version 2018.1 and Tableau Server 10.5 or newer.

v1.08.1

  • Compatible with Alteryx version 10.5-11.8 and Tableau Server 9.01-10.3.

Use the Publish to Tableau Server tool to publish an Alteryx data stream as either a Tableau Hyper data extract (.hyper) or Tableau data extract (.tde) file.

Note

After publishing an Alteryx data stream as a Tableau Hyper data extract (.hyper) file, the file may incorrectly display with a TDE (.tde) extension. The data source is actually a HYPER file. You can verify this by downloading and extracting the *.tdsx zip file and viewing the *.hyper file in Data, followed by Extracts.

Tool Configuration

  1. Use the Sign in to Tableau Server tab to create a connection, or use a saved connection.

  2. In Saved connections, select a connection. To remove a saved connection, select it and then select Delete.

  3. Enter the Username and Password used to connect to Tableau Server from a web browser.

  4. Enter the Server URL used to log on to Tableau Server. An example is https://tableau.mycompany.com.

  5. Enter a Site (site name) or leave it blank to use the default site. An example site name is ExternalDemo. Tableau Server is designed to host multiple sites on the same server instance. Tableau Online doesn't have a default site.

  6. To save the connection information as a new connection, use Add connection (optional) to type a name for the connection. Select Save to save the new connection.

  7. Select Connect to connect to Tableau Server.

Configure the Data Source

  1. Project name: Select a project name where you want to publish the new data source

  2. Data source name: Enter the name given to the newly created data source on Tableau Server, or select one from the list. If including metainfo, type the name of the .tds file without any differences.

  3. Output options: Choose output behavior.

    • Create: Create a new file in the specified project folder. If a file already exists with the same data source name, an error displays.

    • Overwrite: Create a new file in the specified folder and overwrite any existing file with the same name.

    • Append: Append to an existing file.

  4. Data source format: Select an output format.

    • TableauHyper DataExtract (*.hyper): Create a Tableau Hyper data extract file.

    • Tableau Data Extract (*.tde): Create a Tableau data extract file.

  5. Data sourcemetainfo(optional): If you only want to publish a .hyper or .tde file, leave this blank. To publish a Tableau data extract (.tdsx) file, which includes a Tableau data source (.tds) file, follow the instructions below to prepare the .tds file. The filename and extension must be the same as the Data source name.

Prepare the TDS File using a File Editor

The path used to publish the .tdsx file is 'Data/Extracts/[filename].hyper'.

  1. Using a file editor, open the .tds file that contains the metainfo for the data source.

  2. Edit the dbname path to match the publishing path. For example, if your hyper file is stored at: C:/temp/filename.hyper then change C:/temp/filename.hyper to Data/Extracts/filename.hyper.

  3. Optionally, edit the datasource version to match the Tableau Server version. This process should only be used when publishing to a lower version.

  4. Save the changes.

The .tds file is now ready. In Data source metainfo (optional), enter or browse to the path of the .tds file.

When you run the workflow, the Publish to Tableau Server tool combines the .tds file and upstream data (the data stream used as the input) into a .tdsx file. The .tdsx file publishes to Tableau Server, providing users with access to the data source and metainfo, such as comments and hierarchies.