Learn more
 

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.

In this article

Related articles

How to publish and share IBM Cloud Object Storage Data dashboards with Tableau Server


The CData ODBC driver for IBM Cloud Object Storage enables you integrate IBM Cloud Object Storage data into Tableau dashboards.

Integrate connectivity to IBM Cloud Object Storage data into your enterprise reporting capabilities. The CData ODBC Driver for IBM Cloud Object Storage enables you to access live IBM Cloud Object Storage data in business intelligence tools like Tableau Server. Connectivity to IBM Cloud Object Storage APIs enables you to monitor changes to your data in real time. Other members of your organization can access your dashboards from a Web browser and get updates from their mobile phone.

This article walks through the process of configuring a DSN on the client and server machines, publishing a data source for IBM Cloud Object Storage to Tableau Server, and publishing an entire Workbook to Tableau Server (including the data source). If you publish a data source, you will be able to create new, refreshable workbooks in Tableau Server.

Connect to IBM Cloud Object Storage as an ODBC Data Source

To create a data source or workbook in Tableau Desktop and publish the data source or workbook to Tableau server, you will need to configure a DSN on each machine (Desktop and Server), specifying connection properties and creating DSNs using the same name on each machine. Information for connecting to IBM Cloud Object Storage follows, along with different instructions for configuring a DSN in Windows and Linux environments.

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.

Windows

If you are installing the CData ODBC Driver for IBM Cloud Object Storage on Windows, DSN configuration is the last step of the driver installation. If you already have the driver installed, or you wish to configure new DSNs, you can use the Microsoft ODBC Data Source Administrator.

Linux

If you are installing the CData ODBC Driver for IBM Cloud Object Storage in a Linux environment, the driver installation predefines a system DSN. You can modify the DSN by editing the system data sources file (/etc/odbc.ini) and defining the required connection properties.

/etc/odbc.ini

[CData IBMCloudObjectStorage Source] Driver = CData ODBC Driver for IBM Cloud Object Storage Description = My Description ApiKey = myApiKey CloudObjectStorageCRN = MyInstanceCRN Region = myRegion OAuthClientId = MyOAuthClientId OAuthClientSecret = myOAuthClientSecret

For specific information on using these configuration files, please refer to the help documentation (installed and found online).

Publish the IBM Cloud Object Storage Data Source to Tableau Server

With the connections to IBM Cloud Object Storage data configured, you are ready to publish a IBM Cloud Object Storage data source on Tableau, ready to be leveraged by users in your organization to create workbooks based on IBM Cloud Object Storage data.

Create and Publish a Data Source

  1. In the Connect pane, click More -> Other Databases (ODBC). Select CData IBMCloudObjectStorage Sys, the system DSN.

    The driver installation automatically creates matching user and system DSNs: The system DSN is needed to connect from Tableau Server.

  2. In the Database menu, select CData.
  3. In the Table box, enter a table name or click New Custom SQL to enter an SQL query.
  4. Drag the table onto the join area.
  5. From the Server menu, click Publish Data Source -> (YOUR DATA SOURCE).
  6. Enter the URL to the server. For most instances, you will authenticate with the Tableau Server username and password. Other authentication scenarios can be found below:
    • If Tableau is configured to use Kerberos and your computer has valid Active Directory credentials, Tableau connects to the server.
    • If Tableau is configured to use SAML, a login prompt for your external identity provider is displayed.
    • If Tableau is configured to use Active Directory, enter your Windows username and password.
  7. In the resulting dialog, set the Project, Data Source, and other properties. If you want to schedule refreshes, select Embedded Password in the Authentication menu. Click Publish.

You and other users in your organization can now create and share workbooks based on the published data source.

Refresh Workbooks

With a system DSN configured on the client (Tableau Desktop) machine and server (Tableau Server) machine, you can refresh workbooks connected to the IBM Cloud Object Storage data source. From the Web interface for Tableau Sever, click Data -> (YOUR DATA SOURCE) -> Refresh.

Publish a Completed Workbook with IBM Cloud Object Storage Data to Tableau Server

If you have a specific Workbook that you wish to share with your organization, you can create the Workbook on Tableau Desktop and publish the Workbook directly to Tableau Server.

  1. To connect to IBM Cloud Object Storage and select data, follow steps 1-5 above.
  2. Click Server -> Sign in and configure the connection to the server. For most instances, you will authenticate with the Tableau Server username and password. Other authentication scenarios can be found below:
    • If Tableau is configured to use Kerberos and your computer has valid Active Directory credentials, Tableau connects to the server.
    • If Tableau is configured to use SAML, a login prompt for your external identity provider is displayed.
    • If Tableau is configured to use Active Directory, enter your Windows username and password.
  3. With the data selected, select dimensions and measures to visualize and select a type of chart or graph to build your visualization(s).
  4. Once the Workbook is complete, click Server -> Publish Workbook to publish the Workbook to Tableau Server.
  5. In the resulting dialog, set the Project, Name, Description and other properties. If you want to schedule refreshes, click Edit under Data Sources and change the Authentication option to Embedded Password. Click Publish.

You and other users in your organization can now review the published workbook from Tableau Server.