Analyze Zoho Recruit Data in R via ODBC
Access Zoho Recruit data with pure R script and standard SQL. You can use the CData ODBC Driver for Zoho Recruit and the RODBC package to work with remote Zoho Recruit data in R. By using the CData Driver, you are leveraging a driver written for industry-proven standards to access your data in the popular, open-source R language. This article shows how to use the driver to execute SQL queries to Zoho Recruit data and visualize Zoho Recruit data in R.
Install R
You can complement the driver's performance gains from multi-threading and managed code by running the multithreaded Microsoft R Open or by running R linked with the BLAS/LAPACK libraries. This article uses Microsoft R Open (MRO).
Connect to Zoho Recruit as an ODBC Data Source
Information for connecting to Zoho Recruit follows, along with different instructions for configuring a DSN in Windows and Linux environments.
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;
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.
Windows
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.
Linux
If you are installing the CData ODBC Driver for Zoho Recruit in a Linux environment, the driver installation predefines a system DSN. You can modify the DSN by editing the system data sources file (/etc/odbc.ini) and defining the required connection properties.
/etc/odbc.ini
[CData API Source] Driver = CData ODBC Driver for Zoho Recruit Description = My Description Profile = C:\profiles\ZohoRecruit.apip ProfileSettings = 'Domain = .com' AuthScheme = OAuth InitiateOAuth = GETANDREFRESH OAuthClientId = your_client_id OAuthClientSecret = your_client_secret CallbackUrl = your_callback_url
For specific information on using these configuration files, please refer to the help documentation (installed and found online).
Load the RODBC Package
To use the driver, download the RODBC package. In RStudio, click Tools -> Install Packages and enter RODBC in the Packages box.
After installing the RODBC package, the following line loads the package:
library(RODBC)
Note: This article uses RODBC version 1.3-12. Using Microsoft R Open, you can test with the same version, using the checkpoint capabilities of Microsoft's MRAN repository. The checkpoint command enables you to install packages from a snapshot of the CRAN repository, hosted on the MRAN repository. The snapshot taken Jan. 1, 2016 contains version 1.3-12.
library(checkpoint)
checkpoint("2016-01-01")
Connect to Zoho Recruit Data as an ODBC Data Source
You can connect to a DSN in R with the following line:
conn <- odbcConnect("CData API Source")
Schema Discovery
The driver models Zoho Recruit APIs as relational tables, views, and stored procedures. Use the following line to retrieve the list of tables:
sqlTables(conn)
Execute SQL Queries
Use the sqlQuery function to execute any SQL query supported by the Zoho Recruit API.
attachments <- sqlQuery(conn, "SELECT , FROM Attachments WHERE Module = 'Candidates'", believeNRows=FALSE, rows_at_time=1)
You can view the results in a data viewer window with the following command:
View(attachments)
Plot Zoho Recruit Data
You can now analyze Zoho Recruit data with any of the data visualization packages available in the CRAN repository. You can create simple bar plots with the built-in bar plot function:
par(las=2,ps=10,mar=c(5,15,4,2)) barplot(attachments$, main="Zoho Recruit Attachments", names.arg = attachments$, horiz=TRUE)