Viewing HubDB Data in RAD Studio Data Explorer

Embarcadero RAD Studio provides a development environment for Delphi and C++Builder applications. With the CData ODBC Driver for HubDB, you gain access to live HubDB data within RAD Studio, abstracting the data into tables, views, and stored procedures that can be used to both retrieve and update HubDB data. This article will walk through connecting to HubDB using the Data Explorer.

Configure a Connection to HubDB

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

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.

Connecting to HubDB Data Using Data Explorer

You can create a simple application for displaying HubDB data by utilizing the CData FireDAC Components for HubDB and a new VCL Forms Application:

1. Open the Data Explorer in RAD Studio and expand FireDAC.
2. Right-click the ODBC Data Source node in the Data Explorer.
3. Click Add New Connection.
4. Enter a name for the connection.
5. In the FireDAC Connection Editor that appears, set the DataSource property to the name of the ODBC DSN for HubDB.
6. Back in the Data Explorer, expand the tables for the connection.

7. Create a new VCL Forms application and drag a table (for example: NorthwindProducts) onto the form.

8. Select the NorthwindProductsTable object on the form and set the Active property to true.

9. Right-click on the object, bind visually, and link everything (*) to a new control (TStringGrid).

10. Arrange the TStringGrid on the form and run the application to see the NorthwindProducts data.

Related Articles

Below you can find other articles for using the CData ODBC Driver with RAD Studio, Delphi, and C++ Builder.

• DataBind Controls to HubDB Data in C++Builder
• DataBind Controls to HubDB Data in Delphi
• Build a Simple VCL Application for HubDB Data