Build IBM Cloud Object Storage-Connected Visualizations in datapine

datapine is a browser-based business intelligence platform. When paired with the CData Connect AI, you get access to your IBM Cloud Object Storage data directly from your datapine visualizations and dashboards. This article describes connecting to IBM Cloud Object Storage in CData Connect AI and building a simple IBM Cloud Object Storage-connected visualization in datapine.

CData Connect AI provides a pure SQL Server interface for IBM Cloud Object Storage, allowing you to query data from IBM Cloud Object Storage without replicating the data to a natively supported database. Using optimized data processing out of the box, CData Connect AI pushes all supported SQL operations (filters, JOINs, etc.) directly to IBM Cloud Object Storage, leveraging server-side processing to return the requested IBM Cloud Object Storage data quickly.

Configure IBM Cloud Object Storage Connectivity for datapine

Connectivity to IBM Cloud Object Storage from datapine is made possible through CData Connect AI. To work with IBM Cloud Object Storage data from datapine, 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 datapine.

Connecting to IBM Cloud Object Storage from datapine

Once you configure your connection to IBM Cloud Object Storage in Connect AI, you are ready to connect to IBM Cloud Object Storage from datapine.

1. Log into datapine
2. Click Connect to navigate to the "Connect" page
3. Select MS SQL Server as the data source
4. In the Integration step, fill in the connection properties and click "Save and Proceed"
   • Set the Internal Name
   • Set Database Name to the name of the connection we just configured (e.g. IBMCloudObjectStorage1)
   • Set Host / IP to "tds.cdata.com"
   • Set Username to your Connect AI username (e.g. [email protected])
   • Set Password to the corresponding PAT
   • Set Database Port to "14333"
   
5. In the Data Schema step, select the tables and fields to visualize and click "Save and Proceed"
6. In the References step, define any relationships between your selected tables and click "Save and Proceed"
7. In the Data Transfer step, click "Go to Analyzer"

Visualize IBM Cloud Object Storage Data in datapine

After connecting to CData Connect AI, you are ready to visualize your IBM Cloud Object Storage data in datapine. Simply select the dimensions and measures you wish to visualize!

Having connect to IBM Cloud Object Storage from datapine, you are now able to visualize and analyze real-time IBM Cloud Object Storage data no matter where you are. To get live data access to hundreds of SaaS, Big Data, and NoSQL sources directly from datapine, try CData Connect AI today!