Integrate with live IBM Cloud Object Storage Data in Jitterbit

Jitterbit is an enterprise iPaaS (integration platform as a service) that lets you streamline your data workflows. When paired with CData Connect AI, Jitterbit gets access to live IBM Cloud Object Storage data. This article demonstrates how to connect to IBM Cloud Object Storage using Connect AI and integrate with live IBM Cloud Object Storage data in Jitterbit.

CData Connect AI provides a pure OData interface for IBM Cloud Object Storage, allowing you to query data from IBM Cloud Object Storage without replicating the data to a natively supported database. Using optimized data processing out of the box, CData Connect AI pushes all supported SQL operations (filters, JOINs, etc.) directly to IBM Cloud Object Storage, leveraging server-side processing to return the requested IBM Cloud Object Storage data quickly.

Configure IBM Cloud Object Storage Connectivity for Jitterbit

To work with IBM Cloud Object Storage data from Jitterbit, we need to connect to IBM Cloud Object Storage from Connect AI, provide user access to the connection, and create a Workspace for the IBM Cloud Object Storage data.

Connect to IBM Cloud Object Storage from Connect AI

CData Connect AI uses a straightforward, point-and-click interface to connect to data sources.

1. Log into Connect AI, click Sources, and then click Add Connection

2. Select "IBM Cloud Object Storage" from the Add Connection panel

3. Enter the necessary authentication properties to connect to IBM Cloud Object Storage.

   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, 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.
   
4. Click Save & Test
5. Navigate to the Permissions tab in the Add IBM Cloud Object Storage Connection page and update the User-based permissions.

Add a Personal Access Token

When connecting to Connect AI through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect AI. It is best practice to create a separate PAT for each service to maintain granularity of access.

1. Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
2. On the Settings page, go to the Access Tokens section and click Create PAT.
3. Give the PAT a name and click Create.
4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

Configure IBM Cloud Object Storage Endpoints for Jitterbit

After connecting to IBM Cloud Object Storage, create a workspace for your desired table(s).

1. Navigate to the Workspaces page and click Add to create a new Workspace (or select an existing workspace).
2. Click Add to add new assets to the Workspace.
3. Select the IBM Cloud Object Storage connection (e.g. IBMCloudObjectStorage1) and click Next.
4. Select the table(s) you wish to work with and click Confirm.
5. Make note of the OData Service URL for your workspace, e.g. https://cloud.cdata.com/api/odata/{workspace_name}

With the connection, PAT, and Workspace configured, you are ready to connect to IBM Cloud Object Storage data from Jitterbit.

Connect to IBM Cloud Object Storage from Jitterbit using Connect AI

To establish a connection from Jitterbit to CData Connect AI using the OData protocol, follow these steps.

1. Log into Jitterbit.
2. Create a project in Cloud Studio and provide a workspace environment for it.
3. click Sources and enter OData in the search bar.
4. Select the OData connector.
5. Enter the OData connection properties.
• Connection Name: enter a connection name.
• OData Metadata URL: enter https://cloud.cdata.com/api/odata/{workspace_name}.
• Authentication: select Basic Auth.
• User Name: enter your CData Connect AI username. This is displayed in the top-right corner of the CData Connect AI interface. For example, [email protected].
• Password: enter the PAT you generated on the Settings page.

6. Click Test to test the connection, and then click Save Changes.
7. Choose the operation you want to perform and drag it to the workflow in your project.
8. Double-click the query operation to see all the tables and derived views available in your OData endpoint.
9. Select a table and configure the query.

You can now transform and integrate live IBM Cloud Object Storage data in Jitterbit.

Get CData Connect AI

To get live data access to hundreds of SaaS, Big Data, and NoSQL sources directly from Jitterbit, try CData Connect AI today!