Create Tableau Server Connections

Contents:

Expand all Collapse all

Contents:

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 Export Results Window.

Limitations

This connection type only enables publication.
- You cannot read data from Tableau Server.
- Publish-only connections must be created in the Connections page.

Create Tableau Server Connection

You can create the connection through the application or through the command line interface.

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.

Steps:

Login to the application.
In the menu, select Settings menu > Connections. See Connections Page.
In the Connections page, click Create Connection. See Create Connection Window.
In the Create Connection window, click the Tableau Server connection card.

Specify the properties for your Tableau Server.

Property	Description
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 Name	The username to use to connect.
Password	The password associated with the username.
Connection Name	The name of the connection as you want it to appear in the user interface.
Description	This description is displayed in the user interface.
Available to All Users	Cick this checkbox to make this connection available to all users of the platform.

For more information, see Create Connection Window.

Click Save.

Create through CLI

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

The CLI tools are stored in the following directory:

/opt/trifacta/bin/

Example command (all one command):

./trifacta_cli.py 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_host  example.com
--conn_credential_type basic --conn_credential_location ~/.trifacta/config_conn.json 
--conn_is_global --cli_output_path ./conn_create.out

Parameter	Description
`create_connection`	CLI action type. Please leave this value as `create_connection`.
`--user_name`	Username of the Alteryx account to use. Please specify the full username.
`--password`	Password of the account.
`--conn_type`	The type of connection. Set this value to `rest_tableau`.
`--conn_name`	The internal name of this connection. NOTE: This value must be unique within all of your connections.
`--conn_description`	A user-friendly description for this connection appears in the application.
`--conn_host`	Host of the Tableau Server instance.
`--conn_port`	Port number of the Tableau Server instance.
`--conn_credential_type`	The type of credentials to use. Set this value to `trifacta_service`.
`--conn_credential_location`	Specify the location on the Alteryx 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 Alteryx 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.
`--conn_skip_test`	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.
`--cli_output_path`	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 Alteryx 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>"
}

where:

<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 Alteryx command line interface, see CLI for Connections.

Send Feedback

Page tree