Search External IBM Cloud Object Storage Objects in Salesforce Connect

CData Connect Server, enables you to access IBM Cloud Object Storage data from cloud-based applications like the Salesforce console and mobile applications like the Salesforce1 Mobile App. In this article, you will use CData Connect Server and Salesforce Connect to access external IBM Cloud Object Storage objects alongside standard Salesforce objects.

Configuring Connect Server

To work with live IBM Cloud Object Storage data in Salesforce Connect, we need to connect to IBM Cloud Object Storage from Connect Server, provide user access to the new virtual database, and create OData endpoints for the IBM Cloud Object Storage data.

Add a Connect Server User

Create a User to connect to IBM Cloud Object Storage from Reveal through Connect Server.

1. Click Users -> Add
2. Configure a User
3. Click Save Changes and make note of the Authtoken for the new user

Connect to IBM Cloud Object Storage from Connect Server

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

1. Open Connect Server and click Connections
2. Select "IBM Cloud Object Storage" from Available Data Sources
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, 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.
4. Click Save Changes
5. Click Privileges -> Add and add the new user (or an existing user) with the appropriate permissions (SELECT is all that is required for Reveal).

Add IBM Cloud Object Storage OData Endpoints in Connect Server

After connecting to IBM Cloud Object Storage, create OData Endpoints for the desired table(s).

1. Click OData -> Tables -> Add Tables
2. Select the IBM Cloud Object Storage database
3. Select the table(s) you wish to work with and click Next
4. (Optional) Edit the table definition to select specific fields and more
5. Save the settings

(Optional) Configure Cross-Origin Resource Sharing (CORS)

When accessing and connecting to multiple different domains, there is a possibility of violating the limitations of cross-site scripting. In that case, configure the CORS settings in OData -> Settings.

• Enable cross-origin resource sharing (CORS): ON
• Allow all domains without '*': ON
• Access-Control-Allow-Methods: GET, PUT, POST, OPTIONS
• Access-Control-Allow-Headers: Authorization

Save the changes to the settings.

Connect to IBM Cloud Object Storage Data as an External Data Source

Follow the steps below to connect to the feed produced by the API Server.

1. Log into Salesforce and click Setup -> Integrations -> External Data Sources.
2. Click New External Data Source.
3. Enter values for the following properties:
   • External Data Source: Enter a label to be used in list views and reports.
   • Name: Enter a unique identifier.
   • Type: Select the option "Salesforce Connect: OData 4.0".

   • URL: Enter the URL to the OData endpoint of the API Server. The format of the OData URL is CONNECT_SERVER_URL/api.rsc/

4. Select JSON in the Format menu.

5. In the Authentication section, set the following properties:
   • Identity Type: If all members of your organization will use the same credentials to access the API Server, select "Named Principal". If the members of your organization will connect with their own credentials, select "Per User".
   • Authentication Protocol: Select Password Authentication to use basic authentication.
   • Certificate: Enter or browse to the certificate to be used to encrypt and authenticate communications from Salesforce to your server.
   • Username: Enter the username for a user known to CData Connect Server.
   • Password: Enter the user's authtoken.

Synchronize IBM Cloud Object Storage Objects

After you have created the external data source, follow the steps below to create IBM Cloud Object Storage external objects that reflect any changes in the data source. You will synchronize the definitions for the IBM Cloud Object Storage external objects with the definitions for IBM Cloud Object Storage tables.

1. Click the link for the external data source you created.
2. Click Validate and Sync.
3. Select the IBM Cloud Object Storage tables you want to work with as external objects.

Access IBM Cloud Object Storage Data as Salesforce Objects

After adding IBM Cloud Object Storage data as an external data source and syncing IBM Cloud Object Storage tables as external objects, you can use the external IBM Cloud Object Storage objects just as you would standard Salesforce objects.

• Create a new tab with a filter list view:

• Create reports of external objects:

Simplified Access to IBM Cloud Object Storage Data from Applications

At this point, you have a direct connection to live IBM Cloud Object Storage data from Salesforce. For more information on gaining simplified access to data from more than 100 SaaS, Big Data, and NoSQL sources in applications like Salesforce, refer to our Connect Server page.