Ready to get started?

Download a free trial of the IBM Cloud Object Storage ODBC Driver to get started:

 Download Now

Learn more:

IBM Cloud Object Storage Icon IBM Cloud Object Storage ODBC Driver

The IBM Cloud Object Storage ODBC Driver is a powerful tool that allows you to connect with live data from IBM Cloud Object Storage, directly from any applications that support ODBC connectivity.

Access IBM Cloud Object Storage data like you would a database - read, write, and update IBM Cloud Object Storage IBMCloudObject, etc. through a standard ODBC Driver interface.

Build Dashboards with IBM Cloud Object Storage Data in Dundas BI



Create dynamic dashboards and perform analytics based on IBM Cloud Object Storage data in Dundas BI.

The CData ODBC Driver for IBM Cloud Object Storage enables access to live data from IBM Cloud Object Storage under the ODBC standard, allowing you work with IBM Cloud Object Storage data in a wide variety of BI, reporting, and ETL tools and directly, using familiar SQL queries. This article shows how to connect to IBM Cloud Object Storage data as a generic ODBC Data Provider and create charts, reports, and dashboards based on IBM Cloud Object Storage data in Dundas BI.

Connect to IBM Cloud Object Storage Data

  1. If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can configure the DSN using the built-in Microsoft ODBC Data Source Administrator. This is also the last step of the driver installation. See the "Getting Started" chapter in the Help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

    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.

    When you configure the DSN, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

  2. Open the Dundas BI interface, open the menu, and click New Data Connector.
  3. Configure the Dundas BI Data Connector:
    • Name the Data Connector.
    • Select "ODBC generic" as the Data Provider.
    • Check the "Use System DSN" checkbox.
    • Select the appropriate System DSN.

Add IBM Cloud Object Storage Data to a Dashboard

You are now ready to create a dashboard with IBM Cloud Object Storage data.

  1. Navigate to the Home page.
  2. Click Explore Data.
  3. Expand the appropriate Data Connector.
  4. Drag the relevant data from the Connector to the panel.
    • You can select an entire "table" to add, but you may need to remove Measures/Rows from the Metric Set to build an appropriate visualization. Alternatively, you can select only the fields you wish to include in the visualization.
    • With the fields selected, you can add any filters or conditions on the Measures and Rows, further customizing the visualization.
  5. Click Re-visualize from the menu bar and select the appropriate visualization for the data.
  6. Click Add To New Dashboard to add the visualization to a new dashboard.
  7. Configure the dashboard, creating dynamic visualizations of IBM Cloud Object Storage data.