Tableau Connector SDK

Edit this page   Submit an issue

In this section

Overview

Tableau has great connectivity that allows you to visualize data from virtually anywhere. Tableau includes dozens of connectors already, and also gives you the tools to build a new connector with the Tableau Connector SDK.

With this SDK, you can create a connector that you can use to visualize your data from any database through an ODBC or JDBC driver. You can customize connector behavior, fine-tune SQL generation, use the connectivity test harness to validate the connector behavior during the development process, and then package and distribute the connector to users.

What is a Tableau connector?

A connector is a set of files that describe:

A connector can have most of the same features that any built-in Tableau connector supports, including publishing to a server if the server has the connector, creating extracts, data sources, vizzes, and so on.

A connector developed using this SDK is appropriate for connecting to an ODBC or JDBC driver that interfaces using SQL. The underlying technology works well with relation databases.

See the relationship between the connector files (in blue) and the Tableau Connect pane and connection dialog:

Why build a connector?

You can user the “Other Databases (ODBC)” and “Other Databases (JDBC)” connectors to connect to your database. The Tableau Connector SDK is similar, but offers the following advantages:

If your data source does not fit the relational ODBC/JDBC model, then it may be worth looking into Web data connectors.

What is a TACO file?

A TACO file (.taco) is a packaged Tableau connector file that can be placed in your “My Tableau Repository/Connectors” folder. From there, Tableau automatically loads all connectors it finds.

For more information about packaging your connector into a TACO, see Package and sign your connector for distribution

Overview of the process

These are the general steps you will follow to create a fully functional connector.

  1. Have a look at one of the sample connectors located in the postgres_odbc or postgres_jdbc folder. These connectors can make a good starting point if you copy the connector files to your workspace.

  2. Customize the connector files as needed to name your connector and allow it to connect to your database. See the Example for more information.

  3. Make sure your connector has all the required files:
    • Manifest file. This defines the connector.
    • Connection resolver (ODBC-based connectors only). ODBC connectors should include a driver-resolver element. JDBC connectors do not currently support the driver-resolver.
    • Connection builder JavaScript file. JDBC connectors can make use of a properties builder JavaScript file.
    • Dialect definition file.
    • Connection dialog.

  4. After your connector is able to connect, start running the test tool TDVT to verify your connector is compatible with Tableau. Load the test data into your database, for example.

  5. When the TDVT tests are passing you are ready to package and sign your connector.

Prerequisites for development

To develop connectors, be sure you have the following installed on your computer:

Install the SDK tools

Install the following:

The resulting connector will work on Tableau Desktop and Tableau Server on Windows, Linux, and Mac.

Using a connector

Packaged connector (TACO)

Place your packaged TACO file in the My Tableau Repository/Connectors folder and launch Tableau. See Run your packaged connector (.taco) for more information.

Note: Support for loading TACO files was added in the 2019.4 release of Tableau.

Developer path

You can tell Tableau to load unpackaged connectors with a special command-line argument that tells Tableau where to find your connector. See Run Your “Under Development” Connector for more information.