Configuring a Connection
The connector comes with a connection builder which allows you to build and test your connection settings outside of Tableau. It also allows you to create a connection string, which can be used to provide options not listed in the connection dialog in Tableau.
Configuring a Connection Builder
There are two ways to access the connection builder:
- On Windows, there will be a shortcut called Connection Builder in the start menu, under the CData Airtable Tableau Data Connector folder.
- The connection builder can also be started by going to the driver install directory and running the .jar file in the lib directory.
In the connection builder, you can set values for connection properties and click the Test Connection button to validate that they work. You can also use the Copy to Clipboard button to save the connection string for use with Tableau.
Connecting to Airtable
The Airtable data source only supports the simple token-based authentication method.
To establish a connection begin by locating your ApiKey. You can find this by logging into your Airtable account and navigating to the API section. Then, click Generate API key.
From the same API section, identify your BaseId. Click on Airtable API, or navigate to https://airtable.com/api and select a base.
Supply the following to connect to data:
- ApiKey: Set this to your API key noted earlier.
- BaseId: Set this to your Base Id noted earlier. In the introduction section you can find "The ID of this base is appxxN2ftedc0nEG7."
- TableNames: A comma separated list of table names for the selected base. These are the same names of tables as found in the UI.
You may also optionally specify the following to further refine data access:
- ViewNames: A comma separated list of views in the format TableA.ViewA,TableA.ViewB,..etc. These are the same names of the views as found in the UI.
Important note : '.' character is not suggested to be used for column names since it is used for bulding column names based on paths and may risk breaking INSERT/UPDATE statements. If you already have column names that contain '.' character, please set PathDelimiter connection property to a character that is not used in column names. PathDelimiter is equal to '.' by default.
- PathDelimiter: The character which will be used as delimiter for bulding column names based on paths.
See Getting Data for the next step, which includes authenticating to the Airtable APIs.