Build Visualizations of HubDB Data in Birst



Use CData drivers and the Birst Cloud Agent to build real-time visualizations of HubDB data in Birst.

Birst is a cloud business intelligence (BI) tool and analytics platform that helps organizations quickly understand and optimize complex processes. When paired with the CData JDBC Driver for HubDB, you can connect to live HubDB data through the Birst Cloud Agent and build real-time visualizations. In this article, we walk you through, step-by-step, how to connect to HubDB using the Cloud Agent and create dynamic reports in Birst.

With powerful data processing capabilities, the CData JDBC Driver offers unmatched performance for live HubDB data operations in Birst. When you issue complex SQL queries from Birst to HubDB, the driver pushes supported SQL operations, like filters and aggregations, directly to HubDB and utilizes the embedded SQL Engine to process unsupported operations client-side (often SQL functions and JOIN operations). With built-in dynamic metadata querying, the JDBC driver enables you to visualize and analyze HubDB data using native Birst data types.

Configure a JDBC Connection to HubDB Data in Birst

Before creating the Birst project, you will need to install the Birst Cloud Agent (in order to work with the installed JDBC Driver). Also, copy the JAR file for the JDBC Driver (and the LIC file, if it exists) to the /drivers/ directory in the installation location for the Cloud Agent.

With the driver and Cloud Agent installed, you are ready to begin.

  1. Create a new project in Birst.
  2. Name the connection (e.g. CDataHubDB).
  3. Choose Live Access.
  4. Select an agent.
  5. Set Database Type to Other.
  6. Set SQL Type to MSSQL
  7. Set the Connection string.

    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.

    Built-in Connection String Designer

    For assistance in constructing the JDBC URL, use the connection string designer built into the HubDB JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

    java -jar cdata.jdbc.hubdb.jar

    Fill in the connection properties and copy the connection string to the clipboard.

    When you configure the JDBC URL, 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.

    Below is a typical JDBC connection string for HubDB:

    jdbc:hubdb:AuthScheme=OAuth;OAuthClientID=MyOAuthClientID;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333;InitiateOAuth=GETANDREFRESH
  8. Set the Driver Name: cdata.jdbc.hubdb.HubDBDriver and click Save.

NOTE: Since authentication to HubDB is managed from the connection string, you can leave Security Credentials blank.

Configure HubDB Data Objects

Now that the connection is configured, we are ready to configure the schema for the dataset, choosing the tables, views, and columns we wish to visualize.

  1. Select the Schema (e.g. HubDB).
  2. Click on Tables and/or Views to connect to those entities and click Apply.
  3. Select the Tables and Columns you want to access and click Done.

With the objects configured, you can perform any data preparation and discover any relationships in your data using the Pronto Prepare and Relate tools.

Build a Visualization

After you prepare your data and define relationships between the connected objects, you are ready to build your visualization.

  1. Select the Visualizer tool from the menu.
  2. Select Measures & Categories from your objects
  3. Select and configure the appropriate visualization for the Measure(s) you selected.

Using the CData JDBC Driver for HubDB with the Cloud Agent and Birst, you can easily create robust visualizations and reports on HubDB data. Download a free, 30-day trial and start building Birst visualizations today.

Ready to get started?

Download a free trial of the HubDB Driver to get started:

 Download Now

Learn more:

HubDB Icon HubDB JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with HubDB.