Connect to Harvest 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 Harvest and can be used to generate an OData API (natively supported in RunMyProcess) for Harvest. 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 Harvest data.

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

Connect to Harvest from RunMyProcess

To work with live Harvest data in RunMyProcess, 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 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 RunMyProcess

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 RunMyProcess.

Retrieve Harvest Data from RunMyProcess DigitalSuite Studio

With the connection to Harvest and OData endpoints created, we are ready to add Harvest 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.
3. Click the + (New Provider) button to create a new provider, choose the account to use, then click Confirm.
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/{virtual_schema_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.
   
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 Harvest 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/{virtual_schema_name})
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.

More Information & Free Trial

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