Integrate with Live IBM Cloud Object Storage 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 IBM Cloud Object Storage data for visualizations, dashboards, and more. This article explains how to use CData Connect AI to create a live connection to IBM Cloud Object Storage and how to connect and access live IBM Cloud Object Storage 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 IBM Cloud Object Storage Connectivity for MuleSoft

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

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

2. Select "IBM Cloud Object Storage" from the Add Connection panel

3. Enter the necessary authentication properties to connect to IBM Cloud Object Storage.

   Register a New Instance of Cloud Object Storage

   If you do not already have Cloud Object Storage in your IBM Cloud account, follow the procedure below to install an instance of SQL Query in your account:

   1. Log in to your IBM Cloud account.
   2. Navigate to the page, choose a name for your instance and click Create. You will be redirected to the instance of Cloud Object Storage you just created.

   Connecting using OAuth Authentication

   There are certain connection properties you need to set before you can connect. You can obtain these as follows:

   API Key

   To connect with IBM Cloud Object Storage, you need an API Key. You can obtain this as follows:

   1. Log in to your IBM Cloud account.
   2. Navigate to the Platform API Keys page.
   3. On the middle-right corner click "Create an IBM Cloud API Key" to create a new API Key.
   4. In the pop-up window, specify the API Key name and click "Create". Note the API Key as you can never access it again from the dashboard.

   Cloud Object Storage CRN

   If you have multiple accounts, specify the CloudObjectStorageCRN explicitly. To find the appropriate value, you can:

   • Query the Services view. This will list your IBM Cloud Object Storage instances along with the CRN for each.
   • Locate the CRN directly in IBM Cloud. To do so, navigate to your IBM Cloud Dashboard. In the Resource List, Under Storage, select your Cloud Object Storage resource to get its CRN.

   Connecting to Data

   You can now set the following to connect to data:

   • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
   • ApiKey: Set this to your API key which was noted during setup.
   • CloudObjectStorageCRN (Optional): Set this to the cloud object storage CRN you want to work with. While the connector attempts to retrieve this automatically, specifying this explicitly is recommended if you have more than Cloud Object Storage account.

   When you connect, the connector completes the OAuth process.

   1. Extracts the access token and authenticates requests.
   2. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.
   
4. Click Save & Test
5. Navigate to the Permissions tab in the Add IBM Cloud Object Storage 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 IBM Cloud Object Storage 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 IBM Cloud Object Storage Data from Cloud Applications

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

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