Integrate with Live HubDB Data in MuleSoft (via CData Connect AI)

The MuleSoft Anypoint Platform enables the building, deployment, and management of APIs and integrations, facilitating seamless connectivity across applications and systems. When combined with CData Connect AI, it provides access to HubDB data for visualizations, dashboards, and more. This article explains how to use CData Connect AI to create a live connection to HubDB and how to connect and access live HubDB data from the MuleSoft Anypoint Platform.

Prerequisites

Before configuring and using MuleSoft with CData Connect AI, you must first connect a data source to your CData Connect AI account. For more information, see the Connections section.

Additionally, you need to generate a Personal Access Token (PAT) on the Settings page. Be sure to copy it down, as it serves as your password during authentication.

Configure HubDB Connectivity for MuleSoft

Connectivity to HubDB from MuleSoft is made possible through CData Connect AI. To work with HubDB data from MuleSoft, we start by creating and configuring a HubDB connection.

1. Log into Connect AI, click Sources, and then click Add Connection

2. Select "HubDB" from the Add Connection panel

3. Enter the necessary authentication properties to connect to HubDB.

   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.

   
4. Click Save & Test
5. Navigate to the Permissions tab in the Add HubDB Connection page and update the User-based permissions.

Add a Personal Access Token

When connecting to Connect AI through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect AI. It is best practice to create a separate PAT for each service to maintain granularity of access.

1. Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
2. On the Settings page, go to the Access Tokens section and click Create PAT.
3. Give the PAT a name and click Create.
4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

With the connection configured and a PAT generated, you are ready to connect to HubDB data from Mulesoft.

Connecting to CData Connect AI

Follow these steps to establish a connection from Mulesoft to CData Connect AI through the JDBC driver:

1. Download and install the CData Connect AI JDBC driver.
   • Open the Integrations page of CData Connect AI.
   • Search for and select JDBC.
   • Download and run the setup file.
   • When the installation is complete, the JAR file can be found in the installation directory (inside the lib folder).
2. Log into Mulesoft Anypoint Studio or launch the desktop application.
3. Create a new Mulesoft project. The new project appears in a project folder.
4. In the Mule Palette located on the right, drag an HTTP Listener to the Message Flow area.
5. Click on the HTTP Listener to configure it.
6. Click the + sign on the right of Connector configuration. The HTTP Listener config dialog appears.
7. Configure the HTTP Listener, providing a Port on which to query your data, and click OK.
8. Provide a path on which to perform the actions. The HTTP Listener is now configured.
9. In the Mule Palette on the right, type database in the search bar.
10. Drag the database operation you want to perform to the Message Flow area. For this example, we choose Select.
11. Select Generic Connection from the Connection dropdown in the Database Config dialog.
12. Click the Configure button to configure the JDBC driver. Select Use local file from the drop-down list.
13. Locate the CData Connect AI JAR file from the JDBC driver installation and click OK.
14. Provide the following information:
    • URL: the URL for the connection, for example:

       jdbc:connect:Authscheme=Basic;user=username;password=PAT

      Note: the password is the PAT created in the Prerequisites section.
    • Driver class name: Enter the Driver class name as:

       cdata.jdbc.connect.ConnectDriver

      
15. Click Test Connection.
16. If the connection is successful, provide the SQL Query Text in the editor. You can see the table metadata on the right side in the Output tab.
17. In the Mule Palette, drag Transform Message to the Message Flow area.
18. Click Transform Message to configure it. Change the Output as follows:
19. Save your project and run it. In the console, Mulesoft starts initializing the dependencies.
20. Once you see the message, "Message source 'listener' on flow your_project_name successfully started", you can start querying your data at the endpoint you provided.
21. Query to check out the data using the Postman application (as shown below).

SQL Access to HubDB Data from Cloud Applications

Now you have a direct connection to live HubDB data from MuleSoft Anypoint Platform. You can create more connections to ensure seamless data flow, automate business processes, and manage APIs - all without replicating HubDB data.

To get real-time data access to hundreds of SaaS, Big Data, and NoSQL sources (including HubDB) directly from your cloud applications, explore the CData Connect AI.