Ready to get started?

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

 Download Now

Learn more:

IBM Cloud Object Storage Icon IBM Cloud Object Storage JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with IBM Cloud Object Storage.

Create an SAP BusinessObjects Universe on the CData JDBC Driver for IBM Cloud Object Storage



Provide connectivity to IBM Cloud Object Storage data through an SAP BusinessObjects universe.

This article shows how to use the CData JDBC Driver for IBM Cloud Object Storage to connect to IBM Cloud Object Storage from SAP BusinessObjects Business Intelligence applications. You will use the Information Design Tool to analyze IBM Cloud Object Storage data and create a universe on the CData JDBC Driver for IBM Cloud Object Storage. You will then connect to the universe from Web Intelligence.

Create the JDBC Connection to IBM Cloud Object Storage

Follow the steps below to create a connection to the IBM Cloud Object Storage JDBC data source in the Information Design Tool.

  1. Copy the CData JAR and .lic file into the following subfolder in the installation directory for BusinessObjects: dataAccess\connectionServer\jdbc\drivers\jdbc. The CData JAR is located in the lib subfolder of the installation directory.
  2. Right-click your project and click New -> New Relational Connection.
  3. In the wizard that results, click Generic -> Generic JDBC datasource -> JDBC Drivers.
  4. On the next page of the wizard enter the connection details.
  5. On the next page, set the Authentication Mode option to "Use specified username and password". Enter the username, password, and JDBC URL. The JDBC URL begins with jdbc:ibmcloudobjectstorage: and is followed by a semicolon-separated list of connection properties.

    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.

    Built-in Connection String Designer

    For assistance in constructing the JDBC URL, use the connection string designer built into the IBM Cloud Object Storage JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

    java -jar cdata.jdbc.ibmcloudobjectstorage.jar

    Fill in the connection properties and copy the connection string to the clipboard.

    When you configure the JDBC URL, 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.

    A typical JDBC URL is below:

    jdbc:ibmcloudobjectstorage:ApiKey=myApiKey;CloudObjectStorageCRN=MyInstanceCRN;Region=myRegion;OAuthClientId=MyOAuthClientId;OAuthClientSecret=myOAuthClientSecret;
  6. Enter the driver class: cdata.jdbc.ibmcloudobjectstorage.IBMCloudObjectStorageDriver
  7. Finish the wizard with the default values for connection pooling and custom parameters.

Analyze IBM Cloud Object Storage Data in the Information Design Tool

You can use the JDBC connection to analyze IBM Cloud Object Storage data in the Information Design Tool.

  1. In the Local Projects view, double-click the connection (the .cnx file) to open the IBM Cloud Object Storage data source.
  2. On the Show Values tab, you can load table data and enter SQL queries. To view table data, expand the node for the table, right-click the table, and click Show Values. Values will be displayed in the Raw Data tab.
  3. On the Analysis tab, you can then analyze data by dragging and dropping columns onto the axes of a chart.

Publish the Local Connection

To publish the universe to the CMS, you additionally need to publish the connection.

  1. In the Local Projects view, right-click the connection and click Publish Connection to a Repository.
  2. Enter the host and port of the repository and connection credentials.
  3. Select the folder where the connection will be published.
  4. In the success dialog that results, click Yes to create a connection shortcut.

Create a Universe on the JDBC Driver for IBM Cloud Object Storage

You can follow the steps below to create a universe on the JDBC driver. The universe in this example will be published to a repository, so it uses the published connection created in the previous step.

  1. In the Information Design Tool, click File->New Universe.
  2. Select your project.
  3. Select the option to create the universe on a relational data source.
  4. Select the shortcut to the published connection.
  5. Enter a name for the Data Foundation.
  6. Import tables and columns that you want to access as objects.
  7. Enter a name for the Business Layer.

Publish the Universe

You can follow the steps below to publish the universe to the CMS.

  1. In the Local Projects view, right-click the business layer and click Publish -> To a Repository.
  2. In the Publish Universe dialog, enter any integrity checks before importing.
  3. Select or create a folder on the repository where the universe will be published.

Query IBM Cloud Object Storage Data in Web Intelligence

You can use the published universe to connect to IBM Cloud Object Storage in Web Intelligence.

  1. Copy the cdata.jdbc.ibmcloudobjectstorage.lic file to the following subfolder in the BusinessObjects installation directory: \dataAccess\connectionServer\jdbc\drivers\jdbc. The license file is located in the lib subfolder of the installation directory.
  2. Open Web Intelligence from the BusinessObjects launchpad and create a new document.
  3. Select the Universe option for the data source.
  4. Select the IBM Cloud Object Storage universe. This opens a Query Panel. Drag objects to the Result Objects pane to use them in the query.