Create IBM Cloud Object Storage-Connected Visualizations in Klipfolio

Klipfolio is an online dashboard platform for building real-time business dashboards for your team or your clients. When paired with CData Connect Server, you get instant access to IBM Cloud Object Storage data for visualizations, reports, and more. This article shows how to create a virtual database for IBM Cloud Object Storage in Connect Server and build visualizations from IBM Cloud Object Storage data in Klipfolio.

CData Connect Server provides a pure SQL Server interface for IBM Cloud Object Storage, allowing you to easily build reports from live IBM Cloud Object Storage data in Klipfolio — without replicating the data to a natively supported database. As you build visualizations, Klipfolio generates SQL queries to gather data. Using optimized data processing out of the box, CData Connect Server pushes all supported SQL operations (filters, JOINs, etc) directly to IBM Cloud Object Storage, leveraging server-side processing to quickly return the requested IBM Cloud Object Storage data.

Create a Virtual SQL Server Database for IBM Cloud Object Storage Data

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

1. Login to Connect Server and click Connections.
2. Select "IBM Cloud Object Storage" from Available Data Sources.
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, you will need to 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 Changes
5. Click Privileges -> Add and add the new user (or an existing user) with the appropriate permissions.

With the virtual database created, you are ready to connect to IBM Cloud Object Storage data from Klipfolio.

Connect to IBM Cloud Object Storage in Klipfolio

The steps below outline connecting to CData Connect Server from Klipfolio to create a new IBM Cloud Object Storage data source.

1. Open Klipfolio
2. Click in Data Feeds on the left panel to add a new data source.
3. Search for and select MS SQL as the Service.
4. Click "Create a custom MSSQL data source"
5. Configure the data source by setting the SQL Server connection properties:
   • Host: your instance (e.g., CONNECT_SERVER_URL)
   • Port: 1433
   • Database: your database (e.g., IBMCloudObjectStorage1)
   • Driver: MS SQL
   • Username: your Connect Server username
   • Password: your Connect Server password
   • SQL Query: any query to retrieve data (e.g., SELECT * FROM Objects)
   • Select the checkbox to "Include column headers"
6. Click "Get data" to preview the IBM Cloud Object Storage data before building a data model.

Build a Data Model

After retrieving the data, click "Continue." In the new window, configure your data model.

1. Confirm that the model includes all columns you wish to work with
2. Name your model
3. (optional) Set the Description
4. Set "Header in row" to 1
5. Click the toggle to "Exclude data before row" and set the value to 2
6. Click "Save data feed"

Create a Klip

With the data modeled, we are ready to create a Klip (or visualization) of the data to be used in the Klipfolio platform for dashboards, reporting, and more.

1. Click "Add Metric"
2. Select a measure, placed on the y-axis, to track.
3. Select up to five dimensions/columns, for the x-axis, that you wish to visualize.
4. Click "Save metric"

SQL Access to IBM Cloud Object Storage Data from Applications

Now you have a Klip built from live IBM Cloud Object Storage data. You can add it to a new dashboard, share, and more. Easily create more data sources and new visualizations, produce reports, and more — all without replicating IBM Cloud Object Storage data.

To get SQL data access to 200+ SaaS, Big Data, and NoSQL sources directly from your applications, try CData Connect Server.