Connect to IBM Cloud Object Storage Data in RunMyProcess through Connect AI

Akorbi Digital RunMyProcess makes it easy to create applications for complex business applications, such as budget application and contract management. CData Connect AI creates a live connection to IBM Cloud Object Storage and can be used to generate an OData API (natively supported in RunMyProcess) for IBM Cloud Object Storage. By pairing RunMyProcess with CData Connect AI, you get true cloud-to-cloud connectivity to all your SaaS and cloud-based Big Data and NoSQL sources - no need to migrate your data or write your own integrations. Simply connect to Connect AI from RunMyProcess as you would any other REST service and get instant, live access to your IBM Cloud Object Storage data.

In this article, we walk through connecting to IBM Cloud Object Storage from CData Connect AI and accessing IBM Cloud Object Storage data through an OData feed in RunMyProcess.

Connect to IBM Cloud Object Storage from RunMyProcess

To work with live IBM Cloud Object Storage data in RunMyProcess, 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
👁 Adding a Connection

2. Select "IBM Cloud Object Storage" from the Add Connection panel
👁 Selecting a data source

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

   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.
   👁 Configuring a connection (Salesforce is shown)
   
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. 👁 Updating 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. 👁 Creating a new PAT
   
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 RunMyProcess

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). 👁 The Workspaces page.
   👁 Adding a new 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. 👁 Selecting an Asset (Salesforce is shown).
   
4. Select the table(s) you wish to work with and click Confirm. 👁 Selecting Tables (Salesforce is shown).
   
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 RunMyProcess.

Retrieve IBM Cloud Object Storage Data from RunMyProcess DigitalSuite Studio

With the connection to IBM Cloud Object Storage and OData endpoints created, we are ready to add IBM Cloud Object Storage data to RunMyProcess for Retrieval.

Create a Provider

1. Log into RunMyProcess and open DigitalSuite Studio.
2. Click Resources to bring up the Resources page, then select then the CONNECTORS tab. 👁 Connectors page
   
3. Click the + (New Provider) button to create a new provider, choose the account to use, then click Confirm. 👁 Create a new provider
   
4. In the provider settings page, configure the following properties.
   • URL: Set the OData endpoint in the Connect AI OData page: https://cloud.cdata.com/api/odata/{workspace_name}.
   • Authentication Schema: Select Login/Password.
   • Login: Specify a CData Connect AI username (e.g. [email protected]).
   • Password: Specify the PAT of the Connect AI user.
   👁 Selecting a connector
   
5. Fill in the same properties in the ACCEPTANCE and TEST tabs. Note: You can copy the configured settings by clicking 'Copy this configuration button,' then pasting the content in the new tab by clicking 'Paste previously copied configuration.'
6. Click Save to save the properties.

Retrieve IBM Cloud Object Storage Data by Creating a Connector

1. In the CONNECTORS tab, click the button with three dots to create the provider, then select Add connector from the menu.
2. In the following page, set Connector URL to the OData endpoint configured in Connect AI (e.g. https://cloud.cdata.com/api/odata/{workspace_name}) 👁 Connector settings page
   
3. Click Save then Launch to test the connector execution. Click Launch test to execute. The process is successful if you get the JSON response of your configured table information. 👁 Execution test page
   

More Information & Free Trial

Now, you have created a provider and connector to retrieve IBM Cloud Object Storage data. For more information on creating OData feeds from IBM Cloud Object Storage (and more than 100 other data sources), visit the Connect AI page. Sign up for a free trial and start working with live IBM Cloud Object Storage data in RunMyProcess.