Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →Replicate IBM Cloud Object Storage Data for Use in Salesforce Connect
Replicate IBM Cloud Object Storage data to a PostgreSQL database on Heroku and connect it to Salesforce using Salesforce Connect.
CData Sync is a stand-alone application that provides solutions for a variety of replication scenarios, such as replicating sandbox and production instances into your database. By replicating IBM Cloud Object Storage data to a PostgreSQL database in Heroku, you gain access to IBM Cloud Object Storage external objects (using Salesforce Connect) alongside standard Salesforce objects.
Requirements
For this replication example, you need the following:
- CData Sync (trial or licensed), along with a license (full or trial) for IBM Cloud Object Storage replication.
- A Heroku app with the Heroku Postgress and Heroku Connect add-ons provisioned.
- A Salesforce account.
Configure the Replication Destination
Using CData Sync, you can easily replicate IBM Cloud Object Storage data to a PostgreSQL database on Heroku. For this article, you need an existing PostgreSQL database on Heroku. To add your PostgreSQL database as a replication destination, navigate to the Connections tab.
- Click Add Connection.
- Select PostgreSQL as the destination and enter the necessary connection properties.
To connect to PostgreSQL, set the Host, Port (the default port is 5432) and Database connection properties, then set the user and password you wish to use to authenticate to the server. If the Database property is not specified, the data provider connects to the user's default database.
- Click Test Connection to ensure the connection is configured properly.
- Click Save Changes.
Configure the IBM Cloud Object Storage Connection
You can configure a connection to IBM Cloud Object Storage from the Connections tab. To add a connection your IBM Cloud Object Storage data, navigate to the Connections tab.
- Click Add Connection.
- Select a source (IBM Cloud Object Storage).
- Configure the connection properties.
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.
- Click Connect to ensure that the connection is configured properly.
- Click Save Changes.
Configure Queries for Each IBM Cloud Object Storage Instance
CData Sync enables you to control replication with a point-and-click interface. To configure a replication, navigate to the Jobs tab and click Add Job. Select the Source and Destination for your replication.
Replicate Entire Tables
To replicate an entire table, click Add Tables in the Tables section, choose the table(s) you wish to replicate, and click Add Selected Tables.
Customize Your Replication
You can use the Transform feature to customize your replication, whether you want to only replicate specific fields, compute new fields based on existing fields, and/or filter the results based on specific conditions:
- Add or remove fields using the check boxes
- Add computed fields to the bottom of the column listing
- Add filters using the Filter section
As you make changes using the interface, the SQL query used for the replication changes, going from something simple, like this:
REPLICATE [Objects]
to something customized and more complex, like this:
REPLICATE [Objects] SELECT [Key], [Etag] FROM [Objects] WHERE [Bucket] = someBucket
Schedule Your Replication
In the Schedule section, you can schedule a job to run automatically, configuring the job to run after specified intervals, ranging from once every 10 minutes to once every month.
Once you configure the replication job, click Save Changes. You can configure any number of jobs to replicate IBM Cloud Object Storage data for use as external objects in Salesforce.
Connect to Your Replicated IBM Cloud Object Storage Data as an External Data Source
Once your IBM Cloud Object Storage data is replicated to the PostgreSQL database on Heroku, configure the OData interface for Heroku and connect to the database as an external data source via Salesforce Connect.
Configure the OData Service for Heroku
The first part of connecting to IBM Cloud Object Storage data replicated to a PostgreSQL database on Heroku is configuring the Heroku External Objects for the database.
- In your Heroku dashboard, click the Heroku Connect Add-On.
- Select External Objects. (If this is the first time using Heroku External Object, you will be prompted to create the OData service's login credentials)
- View the OData service URL and credentials (noting the URL and credentials to be used later from Salesforce Connect).
- In Data Sources, select which replicated tables to share.
Refer to the Heroku documentation for more detailed instructions.
Configure an External Data Source in Salesforce
After the OData service for Heroku is configured, we can connect to the replicated IBM Cloud Object Storage data as an external data source from Salesforce Connect.
- In Salesforce, click Setup
- In the Administration section, click Data -> External Data Sources
- Set the data source parameter properties:
- External Data Source: the name you wish to display in the Salesforce user interface
- Name: a unique identifier for the API
- Type: Salesforce Connect: OData 4.0
- URL: Enter the OData endpoint from Heroku Connect (above)
- Format: JSON
- Set Authentication:
- Identity Type: Named Principal
- Authentication Protocol: Password Authentication
- Username: the Heroku Connect username
- Password: the Heroku Connect password
- Click Save.
Synchronize IBM Cloud Object Storage Objects
After you have created the external data source in Salesforce, 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.
- Click the link for the external data source you created.
- Click Validate and Sync.
- Select the IBM Cloud Object Storage tables you want to work with as external objects and click Sync.
Access IBM Cloud Object Storage Data as Salesforce Objects
At this point, you will be able to connect to and work with your replicated IBM Cloud Object Storage entities as external objects just as you would with standard Salesforce objects, whether you are simply viewing the data or building related lists of external IBM Cloud Object Storage data alongside standard Salesforce objects.
Download a 30-day free trial of CData Sync and replicate your IBM Cloud Object Storage data for use with Salesforce Connect today!