Page tree

Release 6.0.2




This section describes the basics of creating Tableau Server connections from within the application.

NOTE: You can export Tableau format (TDE) files as part of exporting results from the platform. For more information, see Publishing Dialog.


  • This connection type only enables publication. 
    • You cannot read data from Tableau Server.
    • When created in the application, publish-only connections must be created through the Connections page.

Download and Install Tableau SDK

To enable generation of TDE files and publication to Tableau Server, the Tableau Server SDK must be licensed, downloaded, and installed in the  Designer Cloud powered by Trifacta platform .


  1. Navigate to the following:
    1. Centos/RHEL 6.x:
    2. All other operating system versions:
  2. Complete any required licensing steps.
  3. Download this version: Tableau SDK for C/C++/Java (64-bit).
  4. Transfer the file to the Trifacta node.
    1. Extract it in a directory where the trifacta account has read and execute permissions.

      NOTE: The above directory should be located outside of the install directory for the platform software.

    2. Retain the path to this directory. This directory is assumed to have the following name: <tableau-extract-dir>
  5. Platform configuration must be updated to point to this SDK. You can apply this change through the Admin Settings Page (recommended) or trifacta-conf.json. For more information, see Platform Configuration Methods.
  6. Update the following property:

    "batch-job-runner.env.LD_LIBRARY_PATH" = "<tableau-extract-dir>/lib64/tableausdk/"
  7. Add to the Batch Job Runner classpath to the current classpath (<current_classpath_values>). You must replace <tableau-extract-dir> with the path where you extracted the Tableau Server SDK: 

    "batch-job-runner.classpath" ="<current_classpath_values>:<tableau-extract-dir>/lib64/tableausdk/Java/tableaucommon.jar:<tableau-extract-dir>/lib64/tableausdk/Java/tableauserver.jar:<tableau-extract-dir>/lib64/tableausdk/Java/tableauextract.jar"
  8. Save your changes and restart the platform.


Workspace administrators must enable workspace users to publish to TDE format. For more information, see Workspace Admin Page.

Create Tableau Server Connection

Create through application

Any user can create a Tableau Server connection through the application.

NOTE: Only an administrator can make a Tableau Server connection available for all users.


  1. Login to the application.
  2. In the menu, select Settings menu > Connections. See Connections Page.
  3. In the Connections page, click Create Connection. See Create Connection Window.
  4. In the Create Connection window, click the Tableau Server connection card.
  5. Specify the properties for your Tableau Server.

    Server URL

    The URL to the Tableau Server to which you are connecting. To specify an SSL connection, use https:// for the protocol identifier.

    NOTE: By default, this connection assumes that the port number is 80. To use a different port, you must specify it as part of the Server name value: http://<Tableau_Server_URL>:<port_number>

    User NameThe username to use to connect.
    PasswordThe password associated with the username.
    Connection NameThe name of the connection as you want it to appear in the user interface.
    DescriptionThis description is displayed in the user interface.
    Available to All UsersCick this checkbox to make this connection available to all users of the platform.

    For more information, see Create Connection Window.

  6. Click Save

Create through CLI

This connection can also be created through the Trifacta command line interface. Notes on creating the connection:

The CLI tools are stored in the following directory:


Example command (all one command):

./ create_connection --user_name <trifacta_admin_username> --password <trifacta_admin_password> 
--conn_type rest_tableau --conn_name newTableau
--conn_port 80 --conn_description "This is my Tableau connection." 
--conn_credential_type basic --conn_credential_location ~/.trifacta/config_conn.json 
--conn_is_global --cli_output_path ./conn_create.out
create_connectionCLI action type. Please leave this value as create_connection.

Username of the to use. Please specify the full username.

--passwordPassword of the account.
--conn_typeThe type of connection. Set this value to rest_tableau .

The internal name of this connection.

NOTE: This value must be unique within all of your connections.

--conn_descriptionA user-friendly description for this connection appears in the application.
--conn_hostHost of the Tableau Server instance.

Port number of the Tableau Server instance.

--conn_credential_typeThe type of credentials to use. Set this value to trifacta_service.

Specify the location on the Trifacta node where the credentials file is located. See below for more information on the format of this file.

--conn_ is_global

Include this flag to make the connection public and available to all Trifacta users. This flag requires no value.

NOTE: After a connection has been made public, it cannot be made private. You must delete the connection through the CLI and then recreate it.

You cannot delete a connection if it has imported datasets associated with it. You can delete a connection without datasets, but the publication information associated with the connection is dropped.


By default, any connection is tested as part of a create or edit action. Include this flag to skip testing the connection. This flag requires no value.

Tip: After creation, you can test the connection and modify it through the application. See Flows Page.


The path to the file where results of this command are written.

NOTE: The user issuing the command must also have execute permissions on all parent folders in the specified cli_output_path.

Credentials file

For Tableau Server connections, you must create a credentials file and store it on the Trifacta node in a location that is accessible to the CLI. This location must be specified as part of the command. 

The format of this file should look like the following:

  "username": "<userId>",
  "password": "<pwd_for_userId>"


  • <userId> is the user identifier to connect to the Tableau Server.
  • <pwd_for_userId> is the password for the user in use.

For more information on the Trifacta command line interface, see CLI for Connections.

This page has no comments.