We are proud to share our inclusion in the 2024 Gartner Magic Quadrant for Data Integration Tools. We believe this recognition reflects the differentiated business outcomes CData delivers to our customers.
Get the Report →Build AI/ML Models with Live Harvest Data using Dataiku
Connect Harvest Data with Dataiku using the CData API Driver for JDBC.
Dataiku is a data science and machine learning platform used for data preparation, analysis, visualization, and AI/ML model deployment, enabling collaborative and efficient data-driven decision-making. When paired with the CData API Driver for JDBC, Dataiku enhances data integration, preparation, real-time analysis, and reliable model deployment for Harvest data.
With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Harvest data. When you issue complex SQL queries to Harvest, the driver pushes supported SQL operations, like filters and aggregations, directly to Harvest and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying allows you to work with and analyze Harvest data using native data types.
This article shows how you can easily integrate to Harvest using CData API Driver for JDBC in Dataiku DSS (Data Science Studio) platform, allowing you to prepare the data and build custom AI/ML models.
Preparing the Dataiku DSS environment
In this section, we will explore how to set up Dataiku, as previously introduced, with Harvest data. Be sure to install Dataiku DSS (On-Prem version) for your preferred operating system, beforehand.
Install the CData API Driver for JDBC
First, install the CData API Driver for JDBC on the same machine as Dataiku. The JDBC Driver will be installed in the following path:
C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.api.jar
Connecting the JDBC Driver in Dataiku DSS
To use the CData JDBC driver in Dataiku, you must create a new SQL database connection and add the JDBC Driver JAR file in the DSS connection settings.
- Log into Dataiku DSS platform. It should open locally in your browser (e.g. localhost:11200)
- Click on Navigate to other sections of Dataiku menu on the top right section of the platform and select Administration.
- Select the Connections tab.
- In Connections, click on New Connections button.
- Now, scroll down and select Other SQL databases.
Generate a JDBC URL for connecting to Harvest, beginning with jdbc:api: followed by a series of semicolon-separated connection string properties.
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 given below:
jdbc:api:Profile=C:\profiles\Harvest.apip;ProfileSettings='APIKey=my_personal_key;AccountId=_your_account_id';
- On the New SQL database (JDBC) connection screen, enter a name in the New connection name field and specify the basic parameters:
- JDBC Driver Class: cdata.jdbc.api.APIDriver
- JDBC URL: JDBC connection URL obtained in the previous step
- Driver jars directory: the folder path where the JAR file is installed on your system
Next, select the SQL dialect of your choice. Here, we have selected 'SQL Server' as the preferred dialect. Click on Create. If the connection is successful, a prompt will display, saying 'Connection OK'.
- The Data Catalog window will appear. Select the desired connection, catalog, and schema from the Connection to browse, Restrict to catalog, and Restrict to schema dropdowns, then click on List Tables. The Dataiku platform will list all the required tables.
- Select any table from the list and click Preview to view the table data. Click Close to exit the window.
Creating a new project
To prepare data flows, create dashboards, analyze the Harvest data, and build AI and ML models in the Dataiku DSS platform, you need to first create a new project.
- Select Projects from the Navigate to other sections of Dataiku menu.
- In the Projects screen, click New Project and select + Blank Project.
- In the New Project window, assign a Name and Project Key. Click Create. The new project dashboard opens up.
- Select Notebooks from the menu at the top of the project screen.
- Click on + Create Your First Notebook dropdown menu and select Write your own option.
- In the New Notebook window, select SQL.
- Now, select the required connection from the Connection dropdown and enter a name in the Notebook Name field.
Testing the connection
To test the Harvest connection and analyze the Harvest data, write a query in the query compiler and click Run. The queried/filtered Harvest data results will then appear on the screen.
Get Started Today
Download a free, 30-day trial of the CData API Driver for JDBC to integrate with Dataiku, and effortlessly build custom AI/ML models from Harvest data.
Reach out to our Support Team if you have any questions.