Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →Connect to IBM Cloud Object Storage Data in Jaspersoft Studio
Execute SQL to remote IBM Cloud Object Storage data in Jaspersoft Studio.
This article shows how to connect to IBM Cloud Object Storage from Jaspersoft Studio as a standard JDBC data source with the CData JDBC Driver for IBM Cloud Object Storage. You will use the standard Jaspersoft wizards to build SQL queries to IBM Cloud Object Storage. The queries are executed directly to the IBM Cloud Object Storage APIs, enabling real-time connectivity to IBM Cloud Object Storage data.
Connect to IBM Cloud Object Storage Data as a JDBC Data Source
To create a JDBC data source in Jaspersoft Studio, create a data adapter:
- In the Repository Explorer view, right-click the Data Adapters node and click Create Data Adapter.
- Select Database JDBC Connection.
- Enter a user-friendly name for the driver.
- On the Driver Classpath tab, click Add. In the resulting dialog, navigate to the lib subfolder of the installation directory. Select the driver JAR.
- On the Database Location tab, enter the class name of the JDBC driver: cdata.jdbc.ibmcloudobjectstorage.IBMCloudObjectStorageDriver.
- Enter the JDBC URL.
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:
- Log in to your IBM Cloud account.
- 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:
- Log in to your IBM Cloud account.
- Navigate to the Platform API Keys page.
- On the middle-right corner click "Create an IBM Cloud API Key" to create a new API Key.
- 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.
- Extracts the access token and authenticates requests.
- 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.
Below is a typical JDBC URL for IBM Cloud Object Storage:
jdbc:ibmcloudobjectstorage:ApiKey=myApiKey;CloudObjectStorageCRN=MyInstanceCRN;Region=myRegion;OAuthClientId=MyOAuthClientId;OAuthClientSecret=myOAuthClientSecret;
Create Reports with IBM Cloud Object Storage Data
Follow the steps below to build an SQL query to IBM Cloud Object Storage, the basis of a simple report:
- Click File -> New Jasper Report. Select a template, select the parent project, and specify the report file.
- In the Data Adapter menu, select the data adapter you created in the previous section.
- In the Diagram tab, drag tables into the box and click the columns you want. Or, enter a custom query on the Texts tab. For example:
SELECT Key, Etag FROM Objects WHERE Bucket = 'someBucket'
- Select the fields you want to include in the dataset. This example uses all fields.
- Skip the Group By step and finish the wizard.
In the Preview tab, you can see the report as it would look with the current IBM Cloud Object Storage data.
Create a Chart
The following sections show how to create a chart tied to its own SQL query. When retrieving the data from the remote data source, more restrictive queries, written for specific report objects, can result in faster performance.
Create a DataSet
Follow the steps below to create a new dataset to populate the chart:
- In the report editing area, click the Design tab.
- In the Outline view, right-click the root node for the report and click Create Dataset.
- Enter a name for the dataset and click the option to create a new dataset from a connection or data source.
- In the Data Adapter menu, select the data adapter you created in the first section.
- Enter a query such as the following:
SELECT Key, Etag FROM Objects WHERE Bucket = 'someBucket'
- Select the fields you want in the dataset. This example uses Key and Etag.
- Skip the step to group by fields and finish the wizard.
Configure the Chart
After adding the dataset, follow the steps below to map column values to the chart axes in the chart wizard:
- Click the Summary node in the Outline view. In the Properties view, set the height to 400 pixels. The summary band is printed at the end of the report.
- Drag a chart from the Palette onto the summary. The chart wizard is displayed.
- Select the chart type. This example uses a bar chart.
- In the Dataset menu, select the dataset you created for the chart.
- In the Dataset tab, select the option to use the same JDBC connection used to fill the master report.
- Specify the chart's series: Click the button next to the Series menu and click Add. In the Expression Editor that is displayed, double-click the Key column to set the expression to $F{Key}.
Specify the y-axis values: In the chart wizard, click the button next to the Value box. In the Expression Editor, double-click Etag to set the expression to $F{Etag}.
- Specify the labels for the series elements: In the chart wizard, click the button next to the Label box. In the Expression Editor, double-click the Key column to set the expression to $F{Key}. If needed, convert the column type to string, as in the following expression:
$F{Key}.toString()
- Expand the chart to fill the summary section: right-click the chart and click Size to Container -> Fit Both.
Running the Report
You can now generate reports on IBM Cloud Object Storage data just as you would any other JDBC data source. Jaspersoft Studio periodically refreshes the data across report runs.