Integrate IBM Cloud Object Storage with External Services using SnapLogic

SnapLogic is an integration platform-as-a-service (iPaaS) that allows users to create data integration flows with no code. When paired with the CData JDBC Drivers, users get access to live data from more than 250+ SaaS, Big Data and NoSQL sources, including IBM Cloud Object Storage, in their SnapLogic workflows.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live IBM Cloud Object Storage data. When platforms issue complex SQL queries to IBM Cloud Object Storage, the driver pushes supported SQL operations, like filters and aggregations, directly to IBM Cloud Object Storage and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying lets you work with IBM Cloud Object Storage data using native data types.

Connect to IBM Cloud Object Storage in SnapLogic

To connect to IBM Cloud Object Storage data in SnapLogic, download and install the CData IBM Cloud Object Storage JDBC Driver. Follow the installation dialog. When the installation is complete, the JAR file can be found in the installation directory (C:/Program Files/CData/CData JDBC Driver for IBM Cloud Object Storage/lib by default).

Upload the IBM Cloud Object Storage JDBC Driver

After installation, upload the JDBC JAR file to a location in SnapLogic (for example, projects/Jerod Johnson) from the Manager tab.

Configure the Connection

Once the JDBC Driver is uploaded, we can create the connection to IBM Cloud Object Storage.

1. Navigate to the Designer tab
2. Expand "JDBC" from Snaps and drag a "Generic JDBC - Select" snap onto the designer 👁 Adding a Generic JDBC snap onto the designer
   
3. Click Add Account (or select an existing one) and click "Continue"
4. In the next form, configure the JDBC connection properties:
   • Under JDBC JARs, add the JAR file we previously uploaded
   • Set JDBC Driver Class to cdata.jdbc.ibmcloudobjectstorage.IBMCloudObjectStorageDriver

   • Set JDBC URL to a JDBC connection string for the IBM Cloud Object Storage JDBC Driver, for example:

     jdbc:ibmcloudobjectstorage:ApiKey=myApiKey;CloudObjectStorageCRN=MyInstanceCRN;Region=myRegion;OAuthClientId=MyOAuthClientId;OAuthClientSecret=myOAuthClientSecret;RTK=XXXXXX;

     NOTE: RTK is a trial or full key. Contact our Support team for more information. 👁 Configuring a connection (Salesforce is shown)
     

     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.

     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

     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, 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.
     👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
     
5. After entering the connection properties, click "Validate" and "Apply"

Read IBM Cloud Object Storage Data

In the form that opens after validating and applying the connection, configure your query.

• Set Schema name to "IBMCloudObjectStorage"
• Set Table name to a table for IBM Cloud Object Storage using the schema name, for example: "IBMCloudObjectStorage"."Objects" (use the drop-down to see the full list of available tables)
• Add Output fields for each item you wish to work with from the table

Save the Generic JDBC - Select snap.

With connection and query configured, click the end of the snap to preview the data (highlighted below).

Once you confirm the results are what you expect, you can add additional snaps to funnel your IBM Cloud Object Storage data to another endpoint.

Piping IBM Cloud Object Storage Data to External Services

For this article, we will load data in a Google Spreadsheet. You can use any of the supported snaps, or even use a Generic JDBC snap with another CData JDBC Driver, to move data into an external service.

1. Start by dropping a "Worksheet Writer" snap onto the end of the "Generic JDBC - Select" snap.
2. Add an account to connect to Google Sheets 👁 Connecting to Google
   
3. Configure the Worksheet Writer snap to write your IBM Cloud Object Storage data to a Google Spreadsheet 👁 Writing to a Google Spreadsheet
   

You can now execute the fully configured pipeline to extract data from IBM Cloud Object Storage and push it into a Google Spreadsheet.

More Information & Free Trial

Using the CData JDBC Driver for IBM Cloud Object Storage you can create a pipeline in SnapLogic for integrating IBM Cloud Object Storage data with external services. For more information about connecting to IBM Cloud Object Storage, check at our CData JDBC Driver for IBM Cloud Object Storage page. Download a free, 30 day trial of the CData JDBC Driver for IBM Cloud Object Storage and get started today.