Seamlessly Bring IBM Cloud Object Storage Data into Retool Using CData Connect AI

Retool enables the rapid creation of custom internal tools using a low-code or no-code approach. By integrating IBM Cloud Object Storage into Retool with CData Connect AI, you can access live data from IBM Cloud Object Storage in real time, enabling you to build more efficient apps and streamline workflows.

This guide walks you through the simple steps to connect IBM Cloud Object Storage to Retool via CData Connect AI using OpenAPI or the Virtual SQL Server API. You can securely connect to your IBM Cloud Object Storage data, ensuring seamless integration and real-time updates, empowering you to create smarter apps and enhance operational efficiency. Let's get started!

Configure the IBM Cloud Object Storage Connectivity for Retool (in CData Connect AI)

Overview

Here is an overview of the steps:

1. Configure: (Optional) Set up your IBM Cloud Object Storage data source in CData Connect AI, add a Workspace, add assets to your Workspace, and generate a Personal Access Token (PAT).
2. Connect: Link Retool to CData Connect AI using OpenAPI or the Virtual SQL Server API.
3. Explore: Use your connected data to build smarter apps and explore advanced integrations.

Prerequisites

Ensure you have the following before starting:

1. An active IBM Cloud Object Storage account and credentials.
2. A CData Connect AI account. Log in or sign up for a free trial here.
3. A Retool account. Sign up here.

Connect to IBM Cloud Object Storage from Connect AI

CData Connect AI uses a straightforward, point-and-click interface to connect to data sources.

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.

Configure IBM Cloud Object Storage Endpoints for Retool

After connecting to IBM Cloud Object Storage, create a workspace for your desired table(s).

1. Navigate to the Workspaces page and click Add to create a new Workspace (or select an existing workspace).
2. Click Add to add new assets to the Workspace.
3. Select the IBM Cloud Object Storage connection (e.g. IBMCloudObjectStorage1) and click Next.
4. Select the table(s) you wish to work with and click Confirm.
5. Make note of the OpenAPI URL or the Virtual SQL Server URL for your workspace, e.g. https://cloud.cdata.com/api/openapi/v3/{workspace_name}...

With the connection, PAT, and Workspace configured, you are ready to connect to IBM Cloud Object Storage data from Retool.

Connect Retool to IBM Cloud Object Storage in CData Connect AI

Now that you've configured your IBM Cloud Object Storage connection in CData Connect AI, it's time to integrate it with Retool.

Retool can be connected to IBM Cloud Object Storage in CData Connect AI via either OpenAPI or the Virtual SQL Server API. Choose the method that best suits your workflow:

Connect via OpenAPI

To connect using the OpenAPI specification, follow these steps:

1. On CData Connect AI, from the left-hand side, go to Workspaces then select a Workspace.
2. Click the View Endpoints, and under the OpenAPI, copy the OpenAPI URL for the workspace. Keep the default options. See OpenAPI section for more information.
3. Login to Retool and then go to the Resources tab, click Create new > Resource.
4. In the Select a resource type search bar, and search for OpenAPI.
   
5. Click OpenAPI. The Configure OpenAPI screen appears. Enter the following information to configure the OpenAPI connector:
• Name: The Connection Name to identify the connector on Retool.
• Specification URL: The OpenAPI URL you copied from the Workspace in CData Connect AI. Paste the URL here.
• Forward headers when fetching OpenAPI spec: Check this box.
• Under the URL parameters, keep the key-value pair unchanged.
• In the Headers section, write the key as Authorization and in the value, write Basic.
• For the Basic connection value, Retool requires a base64-encoded version of your CData Connect AI username:PAT combination (where PAT is the token you generated earlier). Use a tool like this to encode the value. For example, [email protected]:12345 encodes to dGVzdEBjZGF0YS5TIzNDU=. Copy this encoded value and paste it into the value field after Basic with a space.
• Username: Enter your CData Connect AI username. This is displayed in the top-right corner of the CData Connect AI interface. For example, [email protected].
• Password: Enter the PAT you generated on the Settings page.

6. Click Test connection to test your connection configuration. Once you have a successful connection, click Create resource.
7. Create the app in Retool in which to integrate your data.
8. Click Create resource query.
9. Select the new resource you created, and view the endpoints that are available.
10. You can now build your app with your live IBM Cloud Object Storage data.

Connect via Virtual SQL Server API

To connect using the Virtual SQL Server API, follow these steps:

1. Login to Retool, then go to Resources. Click Connect New at the top-right and select Resources.

2. Enter Microsoft SQL in the search bar, click the resulting option, and enter the following details:

• Name: A name for the connection to CData Connect AI.
• Host: tds.cdata.com.
• Port: 1433.
• Database Name: Enter the Connection Name of the CData Connect AI data source you want to connect to (for example, Salesforce1).
• Database Username: Enter your CData Connect AI username. This is displayed in the top-right corner of the CData Connect AI interface. For example, [email protected].
• Database Password: Enter the PAT you generated on the Settings page.

3. Click Test Connection. If the connection fails, you might need to whitelist CData Connect AI IPs for Retool and other data sources. Check out the documentation here.
4. If it succeeds, click Create Resource.
5. Your connection is now set up, and you can build your app with live IBM Cloud Object Storage data.

Build Retool Apps with Your Live IBM Cloud Object Storage Data

Now that you have integrated IBM Cloud Object Storage with Retool using CData Connect AI, it's time to utilize your live data to its full potential. Let's build a simple app:

• Step 1: Set Up the Table (on home screen)
  • Create a New App in Retool.
  • Select your IBM Cloud Object Storage connection.
  • Add a Table component and bind it to IBM Cloud Object Storage's data.
  
• Step 2: Add Filters (on top-right)
  • Add a Dropdown to filter by Opportunity Stage.
  • Add a Text Input for searching Account Name.
  
• Step 3: Display Key Metrics (below Table)
  • Add a Text component to show Total Amount of filtered opportunities.
  • Use a query to sum the Amount for filtered data.
• Step 4: Add Visuals (top-right or side panel)
  • Add a Bar Chart to visualize opportunities by Stage.
  • Add a Line Chart to show Expected Revenue over time.
• Step 5: Test and Deploy (top-right)
  • Test filters, search, and charts.
  • Deploy the app and share the link for access.

With these steps, you've successfully created a dynamic app to manage and visualize your Salesforce opportunities. Enjoy exploring your live data and leveraging it for better insights!

Try CData Connect AI Free for 14 Days

Experience real-time IBM Cloud Object Storage data access and enhanced app development with CData Connect AI in Retool. Start your free trial today!