Build Dashboards with HubDB Data in DBxtra

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 connect to HubDB data as a generic ODBC Data Provider and create charts, reports, and dashboards based on HubDB data in DBxtra.

Connect to HubDB Data

1. If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can configure the DSN using the built-in Microsoft ODBC Data Source Administrator. 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.

2. Open the DBxtra application and in the New menu click Project and name the Project. 👁 Creating a New Project.
   
3. Select ODBC Connection as the Data Connection Type. 👁 Creating an ODBC Connection.
   
4. Click the browse option () for the Data Source.
5. In the Data Link Properties window, select Microsoft OLE DB Provider for ODBC Drivers on the Provider tab. 👁 Select the Provider
   
6. On the Connection tab, select the Data Source Name and the initial catalog to use (CData). 👁 Select the Provider
   
7. Name the Connection and select the appropriate User Groups. 👁 Connection name and User Groups
   
8. Double-click the Connection from within the Project to connect to the data. 👁 Connecting to the data.
   

Create a Dashboard with HubDB Data

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

1. Right-click Report Objects under the Project and select New Report Object. 👁 Creating a Report Object for the Project
   
2. In the new Report Object, click the link to create the Query.
3. In the Select Data Connection window, select the newly created data connection. 👁 Select Data Connection
   
4. On the Query tab, expand the connection objects and select the Tables, Views, and specific columns you wish to include in your dashboard. You can specify search requirements and even create complex queries which include JOINs and aggregations. 👁 Selecting the data/building the query.
   
5. On the Dashboard tab, select the visualizations and features for your dashboard. Assign the data values from the query to the appropriate fields for the Dashboards items (Values, Series, etc.) 👁 Building the Dashboard.
   

With a new Dashboard created, you are ready to begin analysis of HubDB data. Thanks to the ODBC Driver for HubDB, you can refresh the Dashboard and immediately see any changes made at the source. In the same way, you can create and view Reports with live, up-to-date HubDB data.