How to connect to Zoho Recruit Data from IntelliJ

The CData JDBC Driver for Zoho Recruit enables you to access Zoho Recruit as a JDBC data source, providing integration with rapid development tools in IDEs. This article shows how to use the data source configuration wizard to connect to Zoho Recruit data in IntelliJ.

Create a JBDC Data Source for Zoho Recruit

Follow the steps below to add the driver JAR and define connection properties required to connect to Zoho Recruit data.

1. In the Data Sources window, right-click and then click Add Data Source -> DB Data Source.

2. In the Data Source Properties dialog that appears, the following properties are required:

   • JDBC Driver Files: Click the button next to this menu to add the JDBC Driver file cdata.jdbc.api.jar, located in the installation directory.
   • JDBC Driver Class: In this menu, select cdata.jdbc.api.APIDriver from the list.

   • Database URL: Enter the connection URL in the JDBC URL property. The URL must start with jdbc:api: and includes connection properties separated with semicolons.

     To authenticate to ZohoRecruit, and connect to your own data or to allow other users to connect to their data, you can use the OAuth standard.

     Using OAuth Authentication

     First, you will need to register an OAuth application with ZohoRecruit. To do so, go to the Zoho Developer Console, add a new Client (Server-based application) and set a valid OAuth redirect URL. Your OAuth application will be assigned a client id and a client secret. Additionally, you will need to set the relevant Domain (.com, .eu, .in, .com.cn, or .jp), which defaults to .com.

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

     • AuthScheme: Set this to OAuth.
     • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
     • OAuthClientId: Set this to the client_id that is specified in your app settings.
     • OAuthClientSecret: Set this to the client_secret that is specified in your app settings.
     • CallbackURL: Set this to the Redirect URI that is specified in your app settings.
     • Domain: Set this in ProfileSettings to your ZohoRecruit account domain (e.g. .com, .eu, .in, .com.cn, .jp).

     Example connection string:

     Profile=C:\profiles\ZohoRecruit.apip;ProfileSettings='Domain=.com';AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;
     

     Built-in Connection String Designer

     For assistance in constructing the JDBC URL, use the connection string designer built into the Zoho Recruit 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.

     👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
     

     A typical JDBC URL is the following:

     jdbc:api:Profile=C:\profiles\ZohoRecruit.apip;ProfileSettings='Domain=.com';AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;

Edit and Save Zoho Recruit Data

To discover schema information, right-click the data source you just created and click Refresh Tables. To query a table, right-click it and then click Open Tables Editor.