Learn more
 

Ready to get started?

Connect to live data from Harvest with the API Driver

Connect to Harvest

In this article

Related articles

Connect to Harvest Data from PowerBuilder


This article demonstrates how to access Harvest data from PowerBuilder using the Harvest JDBC Driver.

The CData JDBC Driver for Harvest is a standards-based control that can be used from any platform or development technology that supports JDBC, including PowerBuilder. This article shows how to use the CData JDBC Driver for Harvest in PowerBuilder.

This article shows how to create a basic PowerBuilder application that uses the CData JDBC Driver for Harvest to retrieve data.

Connect to Harvest Data from PowerBuilder

Follow the steps below to use the Database Painter tool to create a database profile based on an JDBC URL for Harvest. You can use a database profile to save connection properties. In the Database Painter, you can graphically manipulate data as well as execute SQL queries.

  1. Add the driver JAR to the PowerBuilder classpath. Set the CLASSPATH system environment variable to the path to the driver JAR, located in the lib subfolder of the installation directory.

    Note: If you are using PowerBuilder Classic, you can also add the path to the driver JAR by clicking Tools -> System Options -> Java.

  2. Click Tools -> Database Painter.
  3. Right-click the JDBC node and click New Profile.
  4. In the Database Profile Setup dialog, enter the following:
    • Profile Name: Enter a user-friendly name for the profile.
    • Driver Name: Enter the class name of the driver, cdata.jdbc.api.APIDriver
    • URL: Enter the JDBC URL.

      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.

      Built-in Connection String Designer

      For assistance in constructing the JDBC URL, use the connection string designer built into the Harvest JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

      java -jar cdata.jdbc.api.jar

      Fill in the connection properties and copy the connection string to the clipboard. A typical JDBC URL is below:

      jdbc:api:Profile=C:\profiles\Harvest.apip;ProfileSettings='APIKey=my_personal_key;AccountId=_your_account_id';
  5. To view and modify a table, right-click a table and then click Edit Data -> Grid.

Using Harvest Data with PowerBuilder Controls

You can use standard PowerBuilder objects to connect to JDBC data sources and execute queries. The following example shows how to retrieve Harvest data into a DataWindow. You can add the following code to the open method:

SQLCA.DBMS = "JDBC" SQLCA.AutoCommit = False SQLCA.DBParm = "Driver='cdata.jdbc.api.APIDriver',URL='jdbc:api:Profile=C:\profiles\Harvest.apip;ProfileSettings='APIKey=my_personal_key;AccountId=_your_account_id';"; CONNECT USING SQLCA; dw_invoices.SetTransObject(SQLCA); dw_invoices.Retrieve();