Build Charts with HubDB Data in Clear Analytics

The CData ODBC Driver for HubDB enables access to live data from HubDB under the ODBC standard, allowing you work with HubDB data in a wide variety of BI, reporting, and ETL tools and directly, using familiar SQL queries. This article shows how to use Clear Analytics, a Microsoft Excel Add-In, to connect to HubDB as an ODBC source and create queries, tables, and charts (including PivotTables) based on HubDB data.

Connect to HubDB Data

Configure the ODBC Data Source Name

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

There are two authentication methods available for connecting to HubDB data source: OAuth Authentication with a public HubSpot application and authentication with a Private application token.

Using a Custom OAuth App

AuthScheme must be set to "OAuth" in all OAuth flows. Be sure to review the Help documentation for the required connection properties for you specific authentication needs (desktop applications, web applications, and headless machines).

Follow the steps below to register an application and obtain the OAuth client credentials:

1. Log into your HubSpot app developer account.
   • Note that it must be an app developer account. Standard HubSpot accounts cannot create public apps.
2. On the developer account home page, click the Apps tab.
3. Click Create app.
4. On the App info tab, enter and optionally modify values that are displayed to users when they connect. These values include the public application name, application logo, and a description of the application.
5. On the Auth tab, supply a callback URL in the "Redirect URLs" box.
   • If you're creating a desktop application, set this to a locally accessible URL like http://localhost:33333.
   • If you are creating a Web application, set this to a trusted URL where you want users to be redirected to when they authorize your application.
6. Click Create App. HubSpot then generates the application, along with its associated credentials.
7. On the Auth tab, note the Client ID and Client secret. You will use these later to configure the driver.

8. Under Scopes, select any scopes you need for your application's intended functionality.

   A minimum of the following scopes is required to access tables:

   • hubdb
   • oauth
   • crm.objects.owners.read
9. Click Save changes.
10. Install the application into a production portal with access to the features that are required by the integration.
    • Under "Install URL (OAuth)", click Copy full URL to copy the installation URL for your application.
    • Navigate to the copied link in your browser. Select a standard account in which to install the application.
    • Click Connect app. You can close the resulting tab.

Using a Private App

To connect using a HubSpot private application token, set the AuthScheme property to "PrivateApp."

You can generate a private application token by following the steps below:

1. In your HubDB account, click the settings icon (the gear) in the main navigation bar.
2. In the left sidebar menu, navigate to Integrations > Private Apps.
3. Click Create private app.
4. On the Basic Info tab, configure the details of your application (name, logo, and description).
5. On the Scopes tab, select Read or Write for each scope you want your private application to be able to access.
6. A minimum of hubdb and crm.objects.owners.read is required to access tables.
7. After you are done configuring your application, click Create app in the top right.
8. Review the info about your application's access token, click Continue creating, and then Show token.
9. Click Copy to copy the private application token.

To connect, set PrivateAppToken to the private application token you retrieved.

When you configure the DSN, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

Configure the Data Source in Clear Analytics

1. Open Excel and navigate to the CLEAR ANALYTICS ribbon. Once there, open the Data Manager.
2. Select Database as the data source.
3. In the Set Connection section, click the option to create a new database.
4. Select Microsoft ODBC Data Source as the data source and click OK.
5. Select the DSN you already configured from the drop-down menu.
6. Back on the Set Connection section, select Standard (ANSI ODBC) Query Builder as the SQL Builder Provider and click Next.
7. Select the Schema/Owner and choose the domains (tables) that you wish to use in Clear Analytics.
8. Prepare your data objects as needed by customizing the display names and descriptions of the tables and columns.
9. For the vast majority of the CData ODBC Drivers, you will not set a key date for your domains.
10. In the Domain Relations section, add any relational information between tables.
11. In the Domain Tree section, create groups for your data and add the available items to the groups.
12. Review the summary of your data and click Finish.

Create a Chart with HubDB Data

You are now ready to create a chart with HubDB data.

Create a New Query

1. Click Repository in the CLEAR ANALYTICS ribbon.
2. Create a new query.
3. Select the columns you wish to retrieve.
4. Set the aggregation type for your data (use the blank entry if you do not wish to aggregate the data).
5. Set filters and formulas by dragging columns to the lower window.
6. Name your query and click Save.

Build a Chart Based on a Query Report

1. Click Report Explorer in the CLEAR ANALYTICS ribbon.
2. In the Report Explorer pane, click the 'New Report' icon in the toolbar.
3. Select the query you just created.
4. Name the report and click 'Save and Execute'.
5. Click the Results tab within the Report Explorer
6. Expand your report and drag the chart to the Excel spreadsheet.
7. In the resulting PivotChart window, drag the fields (columns) to the Filters, Legends, Axis (Categories), and Values windows.

With a new data source in Clear Analytics established and a chart created, you are ready to begin analysis of HubDB data. With the ODBC Driver for HubDB and Clear Analytics, you can perform self-service analytics in Excel with live data, directly from HubDB.