Configuring a Connection
After Installing the Connector you can connect and create a Data Source for data in HubSpot.
Setting Up a Data Source
Complete the following steps to connect to the data:
- Under Connect | To a Server, click More....
- Select the data source called HubSpot by CData.
- Enter the information required for the connection.
- Click Sign In.
- If necessary, select a Database and Schema to discover what tables and views are available.
Using the Connection Builder
The connector makes the most common connection properties available directly in Tableau. However, it can be difficult to use if you need to use more advanced settings or need to troubleshoot connection issues. The connector includes a separate connection builder that allows you to create and test connections outside of Tableau.
There are two ways to access the connection builder:
- On Windows, use a shortcut called Connection Builder in the Start menu, under the CData Tableau Connector for HubSpot folder.
- You can also start the connection builder 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 Test Connection to validate that they work. You can also use the Copy to Clipboard button to save the connection string. This connection string can be given to the Connection String option included in the connector connection window in Tableau.
Authenticating to HubSpot
HubSpot supports OAuth authentication and PrivateAppToken-based authentication.Note: The HubspotV3 schema contains two tables that only work with PrivateAppToken authentication: QuoteAssociations and Quotes. For further information, see Data Model > HubSpot V3 Data Model > Tables.
OAuth
HubSpot provides embedded OAuth credentials that simplify connection from a Desktop application . To connect from a Web application, you must create a custom OAuth application, as described in Creating a Custom OAuth Application.To connect via OAuth from all authentication flows, you must set AuthScheme to OAuth.
The following subsections describe how to authenticate to HubSpot from the available OAuth flows. For information about how to create a custom OAuth aplication, and why you might want to create one even for auth flows that already have embedded OAuth credentials, see Creating a Custom OAuth Application.
For a complete list of connection string properties available in HubSpot, see Connection.
Desktop Applications
CData provides an embedded OAuth application that simplifies authentication at the desktop;.You can also authenticate from the desktop via a custom OAuth application, which you configure and register at the HubSpot console. For further information, see Creating a Custom OAuth Application.
Get and Refresh the OAuth Access Token
After setting the following, you are ready to connect:
- InitiateOAuth: GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
- OAuthClientId (custom applications only): The client Id assigned when you registered your custom OAuth application.
- OAuthClientSecret (custom applications only): The client secret assigned when you registered your custom OAuth application.
- CallbackURL (custom applications only): The redirect URI defined when you registered your custom OAuth application.
- The connector obtains an access token from HubSpot and uses it to request data.
- Extracts the access token from the callback URL and authenticates requests.
- Saves OAuth values in the location specified in OAuthSettingsLocation. These values persist across connections.
Private App Token
To connect using a Hubspot Private App Token, set the AuthScheme property to PrivateAppToken and OAuthAccessToken to the value of your application's access token.
To generate a HubSpot Private App Token:
- In your HubSpot account, click the settings icon in the main navigation bar.
- In the left sidebar menu, navigate to Integrations > Private Apps.
- Click Create private app.
- On the Basic Info tab, configure the details of your application (name, logo, and description).
- On the Scopes tab, select Read or Write for each scope you want your private application to be able to access. This determines the data the driver has access to retrieve. Refer to the OAuthRequiredScopes and OAuthOptionalScopes properties for recommended scopes to select.
- After you are done configuring your application, click create app in the top right.
- Review the information about your application's access token, click Continue creating, and then click Show token.
You can now set the retrieved token in the OAuthAccessToken property. (OAuthAccessToken is used for Private App Access Tokens and OAuth Access Tokens.)
Next Step
See Using the Connector to create data visualizations.