Use the CData ODBC Driver for HubDB in SAS JMP

You can use the CData ODBC Driver for HubDB to integrate live data into your statistical analysis with SAS JMP. The driver proxies your queries directly to the HubDB API, ensuring that your analysis reflects any changes to the data. The CData ODBC Driver supports the standard SQL used by JMP in the background as you design reports.

The HubDB API supports bidirectional access. This article shows how to access HubDB data into a report and create data visualization. It also shows how to use SQL to query and manipulate HubDB data from the JMP Query Builder.

Access HubDB Data as an ODBC Data Source

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.

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.

Import HubDB Data with the Query Builder

After you have created the HubDB DSN, you can use SQL to invoke the capabilities of the HubDB API. Follow the steps below to execute some supported queries in the Query Builder:

1. In SAS JMP, click File -> Database -> Query Builder. The Select Database Connection dialog is displayed.
2. Click New Connection.
3. On the Machine Data Source tab, select the DSN. In the next step, the Select Tables for Query dialog is displayed.
4. In the Available Tables section, select a table and click Primary.
5. As you drag Available Columns to the Included Columns tab, the underlying SQL query is updated.
6. Click Run Query to display the data.
7. To refresh the results with the current data, right-click Update from Database and click Run Script.

Manipulate HubDB Data

You can execute data manipulation queries from JSL scripts such as the one below. To execute a script, click New Script in the toolbar. To connect, specify the DSN. You can then use the standard SQL syntax:

Visualize HubDB Data

After importing, you can use the Graph Builder to create graphs visually. To open the Graph Builder, click the Graph Builder button in the toolbar.

1. Drag a dimension column onto the x axis. For example, PartitionKey.
2. Drag a measure column onto the y axis. For example, Name.
3. Select a chart type. For example, a bar chart.