Search External Harvest Objects in Salesforce Connect

CData Connect AI, enables you to access Harvest data from cloud-based applications like the Salesforce console and mobile applications like the Salesforce Mobile App. In this article, you will use CData Connect AI and Salesforce Connect to access external Harvest objects alongside standard Salesforce objects.

Connect to Harvest from Salesforce

To work with live Harvest data in Salesforce Connect, we need to connect to Harvest from Connect AI, provide user access to the connection, and create a Virtual Schema for the Harvest data.

Connect to Harvest 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 "Harvest" from the Add Connection panel

3. Enter the necessary authentication properties to connect to Harvest.

   Start by setting the Profile connection property to the location of the Harvest Profile on disk (e.g. C:\profiles\Harvest.apip). Next, set the ProfileSettings connection property to the connection string for Harvest (see below).

   Harvest API Profile Settings

   To authenticate to Harvest, you can use either Token authentication or the OAuth standard. Use Basic authentication to connect to your own data. Use OAuth to allow other users to connect to their data.

   Using Token Authentication

   To use Token Authentication, set the APIKey to your Harvest Personal Access Token in the ProfileSettings connection property. In addition to APIKey, set your AccountId in ProfileSettings to connect.

   Using OAuth Authentication

   First, register an OAuth2 application with Harvest. The application can be created from the "Developers" section of Harvest ID.

   After setting the following connection properties, you are ready to connect:

   • ProfileSettings: Set your AccountId in ProfileSettings.
   • AuthScheme: Set this to OAuth.
   • OAuthClientId: Set this to the client ID that you specified in your app settings.
   • OAuthClientSecret: Set this to the client secret that you specified in your app settings.
   • CallbackURL: Set this to the Redirect URI that you specified in your app settings.
   • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage how the driver obtains and refreshes the OAuthAccessToken.
   
4. Click Save & Test
5. Navigate to the Permissions tab in the Add Harvest 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 Personal 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 Harvest Endpoints for Salesforce Connect

After connecting to Harvest, create a virtual schema for your desired table(s).

1. Navigate to the Virtual Schemas page and click Add to create a new Virtual Schema (enter a Virtual Schema Name and click Confirm), or select an existing one.
2. Click Add to open the Add Asset dialog and add new assets to the Virtual Schema.
3. Select the Harvest connection (e.g. API1) and click Next.
4. Select the table(s) you wish to work with and click Confirm.
5. Click View Endpoints and make note of the OData Service URL for your virtual schema, e.g. https://cloud.cdata.com/api/odata/{virtual_schema_name}

With the connection, PAT, and Virtual Schema configured, you are ready to connect to Harvest data from Salesforce Connect.

Connect to Harvest Data as an External Data Sources

Follow the steps below to connect to the feed produced by Connect AI.

1. Log into Salesforce and click Setup -> Integrations -> External Data Sources.
2. Click Now External Data Sources.
3. Enter values for the following properties:
   • External Data Sources: 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 Connect AI: https://cloud.cdata.com/api/odata/{virtual_schema_name}
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 Connect AI, 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 a CData Connect AI username (e.g. [email protected]).
   • Password: Enter the user's PAT.

Synchronize Harvest Objects

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

1. Click the link for the external data source you created.
2. Click Validate and Scan.
3. Select the Harvest tables you want to work with as external objects.

Access Harvest Data as Salesforce Objects

After adding Harvest data as an external data source and syncing Harvest tables as external objects, you can use the external Harvest 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 Harvest Data from Cloud Applications

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