Ready to get started?

Connect to live data from Harvest with the API Driver

Connect to Harvest

Create an SAP BusinessObjects Universe on the CData ODBC Driver for Harvest



Provide connectivity to Harvest data through an SAP BusinessObjects universe.

This article shows how to create and publish an SAP BusinessObjects universe on the CData ODBC Driver for Harvest. You will connect to Harvest data from the Information Design Tool as well as the Web Intelligence tool.

Connect to Harvest as an ODBC Data Source

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

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.

When you configure the DSN, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

Create an ODBC Connection to Harvest Data

This section shows how to create a connection to the Harvest ODBC data source in the Information Design Tool. After you create a connection, you can analyze data or create a BusinessObjects universe.

  1. Right-click your project and click New -> New Relational Connection.

  2. In the wizard that is displayed, enter a name for the connection.
  3. Select Generic -> Generic ODBC datasource -> ODBC Drivers and select the DSN.

  4. Finish the wizard with the default values for connection pooling and custom parameters.

Analyze Harvest Data in the Information Design Tool

In the Information Design Tool, you can use both published and local ODBC connections to browse and query data.

  1. In the Local Projects view, double-click the connection (the .cnx file) to open the Harvest data source.

  2. On the Show Values tab, you can load table data and enter SQL queries. To view table data, expand the node for the table, right-click the table, and click Show Values. Values will be displayed in the Raw Data tab.

  3. On the Analysis tab, you can drag and drop columns onto the axes of a chart.

Publish the Local Connection

To publish the universe to the CMS, you additionally need to publish the connection.

  1. In the Local Projects view, right-click the connection and click Publish Connection to a Repository.

  2. Enter the host and port of the repository and connection credentials.

  3. Select the folder where the connection will be published.

  4. In the success dialog that results, click Yes to create a connection shortcut.

Create a Universe on the ODBC Driver for Harvest

You can follow the steps below to create a universe on the ODBC driver for Harvest. The universe in this example will be published to a repository, so it uses the published connection created in the previous step.

  1. In the Information Design Tool, click File->New Universe.

  2. Select your project.

  3. Select the option to create the universe on a relational data source.

  4. Select the shortcut to the published connection.

  5. Enter a name for the Data Foundation.

  6. Import tables and columns that you want to access as objects.

  7. Enter a name for the Business Layer.

Publish the Universe

You can follow the steps below to publish the universe to the CMS.

  1. In the Local Projects view, right-click the business layer and click Publish -> To a Repository.

  2. In the Publish Universe dialog, enter any integrity checks before importing.

  3. Select or create a folder on the repository where the universe will be published.

Query Harvest Data in Web Intelligence

You can use the published universe to connect to Harvest in Web Intelligence.

  1. Open Web Intelligence from the BusinessObjects launchpad and create a new document.

  2. Select the Universe option for the data source.

  3. Select the Harvest universe. This opens a Query Panel. Drag objects to the Result Objects pane to use them in the query.