Manage Zoho Recruit Data in DBArtisan as a JDBC Source

The CData JDBC Driver for Zoho Recruit seamlessly integrates Zoho Recruit data into database management tools like DBArtisan by enabling you to access Zoho Recruit data as a database. This article shows how to create a JDBC source for Zoho Recruit in DBArtisan. You can then edit data visually and execute standard SQL.

Integrate Zoho Recruit Data into DBArtisan Projects

Follow the steps below to register Zoho Recruit data as a database instance in your project:

1. In DBArtisan, click Data Source -> Register Datasource.
2. Select Generic JDBC.
3. Click Manage.
4. In the resulting dialog, click New. Enter a name for the driver and click Add. In the resulting dialog, navigate to the driver JAR. The driver JAR is located in the lib subfolder of the installation directory.
5. In the Connection URL box, enter credentials and other required connection properties in the JDBC URL.

   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.

   

   Below is a typical connection string:

   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;

6. Finish the wizard to connect to Zoho Recruit data. Zoho Recruit entities are displayed in the Datasource Explorer.

You can now work with Zoho Recruit data as you work with any other database. See the driver help documentation for more information on the queries supported by the Zoho Recruit API.