Establishing a Connection

Configure a Connection Profile

From the CData ribbon, click Get Data and select From Tableau CRM connection/s to launch the CData Query window. To setup a new connection, you will have to click the New Tableau CRM Connection button. Here you can set the connection settings, test the connection, and save the connection profile.

Connecting to Tableau CRM

OAuthJWT

Tableau CRM uses the OAuth 2 authentication standard. You will need to obtain the OAuthClientId and OAuthClientSecret by registering an app with Tableau CRM. For further information, see Creating a Custom OAuth Application.

Set the AuthScheme to OAuthJWT.

Obtaining the OAuthJWT Consumer Key

To obtain the OAuthJWT consumer key:

Log in to Salesforce.com.
From Setup, enter Apps in the Quick Find box and then click the link to create an app. In the Connected Apps section of the resulting page, click New.
Enter a name to be displayed to users when they log in to grant permissions to your app, along with a contact Email address.
Click Enable OAuth Settings and enter a value in the Callback URL box. Set this value only to create the Connected App as it is required. It will not actually be needed for this type of authentication. The Callback URL is in the format:
```
http://localhost:8019/src/oauthCallback.rst
```
Enable Use digital signatures.
Upload your certificate.
Select the scope of permissions that your app should request from the user.
Click your app name to open a page with information about your app. The OAuth consumer key is displayed.

After creating your OAuth Application, set the following connection properties:

AuthScheme: OAuthJWT.
InitiateOAuth: GETANDREFRESH.
OAuthJWTCert: The JWT Certificate store.
OAuthJWTPassword: The password of the JWT Certificate store.
OAuthJWTIssuer: The OAuth Client ID.
OAuthJWTCertType: The type of the certificate store specified by OAuthJWTCert.

Note: This flow never issues a refresh token.

OAuth

Set AuthScheme to OAuth.

The following subsections describe how to authenticate to Tableau CRM from these authentication flows:

Desktop: a connection to a server on the user's local machine, frequently used for testing and prototyping.
Web: access to data via a shared website.
Headless Server: a dedicated computer that provides services to other computers and their users, which is configured to operate without a monitor and keyboard.

For information about how to create a custom OAuth application, see Creating a Custom OAuth Application. For a complete list of connection string properties available in Tableau CRM, see Connection.

Desktop Applications

CData provides an embedded OAuth application that simplifies OAuth desktop Authentication. Alternatively, you can create a custom application. See "Creating a Custom OAuth Application" for information on creating custom applications and reasons for doing so.

For authentication, the only differences between the two methods is that you must set two additional connection properties when using custom OAuth applications.

After setting the following connections properties, you are ready to connect:

InitiateOAuth: GETANDREFRESH. Used to automatically get and refresh the OAuthAccessToken.
OAuthClientId: (custom applications only) The client Id assigned when you registered your application.
OAuthClientSecret: (custom applications only) The client secret that was assigned when you registered your application.
CallbackURL: The redirect URI that was defined when you registered your application.

When you connect, the add-in opens Tableau CRM's OAuth endpoint in your default browser. Log in and grant permissions to the application.

When the access token expires, the add-in refreshes it automatically.

Note: To configure the session timeout in Salesforce, navigate to Setup > Administration Setup > Security Controls > Session Settings.

Automatic refresh of the OAuth access token:

To have the add-in automatically refresh the OAuth access token, do the following:

Before connecting to data for the first time, set the following connection parameters:
- InitiateOAuth: REFRESH.
- OAuthClientId: The client Id in your application settings.
- OAuthClientSecret: The client secret in your application settings.
- OAuthAccessToken: The access token returned by GetOAuthAccessToken.
- OAuthSettingsLocation: The path where you want the add-in to save the OAuth values, which persist across connections.
On subsequent data connections, set the following:
- InitiateOAuth
- OAuthSettingsLocation

Manual refresh of the OAuth access token:

The only value needed to manually refresh the OAuth access token is the OAuth refresh token.

To manually refresh the OAuthAccessToken after the ExpiresIn period (returned by GetOAuthAccessToken) has elapsed, call the RefreshOAuthAccessToken stored procedure.
Set the following connection properties:
- OAuthClientId: The Client Id in your application settings.
- OAuthClientSecret: The Client Secret in your application settings.
Call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken.
After the new tokens have been retrieved, set the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken. This opens a new connection.

Store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

Connection Properties

The Connection properties describe the various options that can be used to establish a connection.

Managing Connections

After successfully authenticating to Tableau CRM you will be able to customize the data you are importing. To learn more about this, see Managing Connections.

Excel Add-In for Tableau CRM Analytics