The CData JDBC Driver for IBM Cloud Object Storage enables you to provide access to IBM Cloud Object Storage data across the enterprise. This article shows how to deploy the driver on JasperReports server and create a simple report based on a reporting domain, a business view of IBM Cloud Object Storage data.

Deploy the Driver JAR

Follow the steps below to deploy the driver JAR on JasperReports Server. The instructions below contain specifics for IBM Cloud Object Storage and the Tomcat server bundled with JasperReports Server. If you are using JBoss AS 7 instead of Tomcat, you can follow the standard process to deploy the IBM Cloud Object Storage JDBC Driver on JBoss.

1. Copy the driver JAR and .lic file, located in the lib subfolder of the installation directory, to the lib subfolder of the apache-tomcat folder, located in the JasperReports Server installation directory.
2. Navigate to apache-tomcat -> webapps -> jasperserver-pro -> META-INF and add the following resource entry to the context.xml file:
   view source

   <Resource name="jdbc/ibmcloudobjectstorage"   auth="Container" type="javax.sql.DataSource" driverClassName="cdata.jdbc.ibmcloudobjectstorage.IBMCloudObjectStorageDriver"  url="jdbc:ibmcloudobjectstorage:ApiKey=myApiKey;CloudObjectStorageCRN=MyInstanceCRN;Region=myRegion;OAuthClientId=MyOAuthClientId;OAuthClientSecret=myOAuthClientSecret;" maxActive="20" maxIdle="10" maxWait="-1" factory="com.jaspersoft.jasperserver.tomcat.jndi.JSCommonsBasicDataSourceFactory"/>

   Specify the required connection properties in the JDBC URL — the url attribute.

   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.

   view source

   java -jar cdata.jdbc.ibmcloudobjectstorage.jar

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

   

3. 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.
4. Navigate to jasperserver-pro -> WEB-INF and add the following reference to the web.xml file:
   view source

   <resource-ref>

   <description>IBM Cloud Object Storage data JSP</description>

   <res-ref-name>jdbc/ibmcloudobjectstorage</res-ref-name>

   <res-type>javax.sql.DataSource</res-type>

   <res-auth>Container</res-auth>

   </resource-ref>
5. Restart the server.

Create the IBM Cloud Object Storage JDBC Data Source

Follow the steps below to map the IBM Cloud Object Storage JDBC driver to a JDBC data source:

1. Log into JasperReports Server and click Create -> Data Source.
2. In the Type menu, select JNDI Data Source.
3. In the Service Name box, enter the JDNI lookup defined in the resource definition in the web.xml file. In the example, the lookup is “jdbc/ibmcloudobjectstorage”.
4. Click Save to create the Data Source.

Create a Domain

A domain is a metadata and access-control layer that surfaces a relevant business view to report creators. Follow the steps below to select IBM Cloud Object Storage columns, apply filters, and execute SQL to create a domain.

1. Click Create -> Domain. Enter an Id for the domain and select a save location.
2. Click Browse in the Data Source section and select the IBM Cloud Object Storage data source you created.
3. In the Domain Design section, click Create with Domain Designer.
4. Select the schema containing your tables.
5. On the Tables tab, select a table in the Data Source pane and then click the arrow to add them to the Selected Tables pane.
6. On the Derived Tables tab, you can define domains based on SQL queries. For example,
   view source

   SELECT Key, Etag FROM Objects WHERE Bucket = 'someBucket'
7. On the Joins tab, you can join tables by selecting the columns you want to build the join condition and selecting the join type.
8. On the Pre-Filters tab, drag and drop columns to define search criteria that filters the data exposed through the domain.
9. On the Display tab, select IBM Cloud Object Storage data into the data sets presented to the user.
10. Click OK to accept your changes and click Submit to create the domain.

Explore Data in Real Time

After you have created a domain, you are ready to connect to data. Follow the steps below to create an Ad Hoc View in the Ad Hoc Editor.

1. Click Create -> Ad Hoc View.
2. In the resulting dialog, select the IBM Cloud Object Storage domain you created.
3. On the Choose Data page, select columns that you want to use in the view. In the Pre-Filters section, you can create filters based on the selected fields. In the Display section, you can modify column information as presented by the domain.
4. After completing the wizard, select the view type and add columns to the view. JasperSoft uses the metadata of the driver to detect the available dimensions and measures, based on the data type. Drag dimensions and measures onto the Columns and Rows boxes. Right-click a measure to change the summary calculation. Drag the Columns slider to the the desired data level in the Filters section.
5. To access updates to the data as you design the view, change the menu selection from Sample Data to Full Data in the design mode toolbar. As you make changes, JasperSoft Server executes the underlying SQL queries to the driver.
6. Save the view.

Create a Real-Time Report

You can now create reports hosted on JasperSoft Server. To do so from the Ad Hoc Editor, click Save Ad Hoc View and click Create Report.