Ready to get started?

Learn more about the CData JDBC Driver for Zoho CRM or download a free trial:

Download Now

Query Zoho CRM Data in ColdFusion

Write standard ColdFusion data access code to connect to Zoho CRM data.

The CData JDBC Driver for Zoho CRM seamlessly integrates connectivity to Zoho CRM data with the rapid development tools in ColdFusion. This article shows how to connect to Zoho CRM data in ColdFusion and query Zoho CRM tables.

Create a JDBC Data Source for Zoho CRM in ColdFusion

The JDBC data source enables you to execute SQL from standard ColdFusion tags like cfquery and CFScript like executeQuery.

  1. Copy the driver JAR and .lic file from the installation directory onto the ColdFusion classpath. For example, copy the files into C:\MyColdFusionDirectory\cfusion\wwwroot\WEB-INF\lib. Or, open the Java and JVM page in the ColdFusion Administrator and enter the path to the files in the ColdFusion Class Path box.

    The JAR and license for the driver are located in the lib subfolder of the installation directory.

    Restart the server after this step.

  2. Add the driver as a data source:

    From the ColdFusion administrator interface, expand the Data & Services node and click Data Sources. In the Add New Data Source section, enter a name for the data source and select Other in the Driver menu.

  3. Populate the driver properties:

    • JDBC URL: Enter connection properties in the JDBC URL. The JDBC URL begins with jdbc:zohocrm: and is followed by the connection properties in a semicolon-separated list of name=value pairs.

      You will need to obtain an AuthToken to authenticate to Zoho CRM. You can generate an AuthToken on the Zoho CRM website or by calling the GetAuthToken stored procedure. Note that when you generate an AuthToken from Zoho CRM, you can only generate an AuthToken for your user account. You can generate AuthTokens for other user accounts by calling GetAuthToken.

      See the "Getting Started" chapter in the help documentation for a guide.

      Built-in Connection String Designer

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

      java -jar cdata.jdbc.zohocrm.jar

      Fill in the connection properties and copy the connection string to the clipboard.

      A typical JDBC URL is below:

      jdbc:zohocrm:AuthToken=2ad3b3e719f6bed7368e5e7e26e4f988;
    • Driver Class: Enter the driver class. The driver class is cdata.jdbc.zohocrm.ZohoCRMDriver.
    • Driver Name: Enter a user-defined name for the driver.
    • Username: Enter the username used to authenticate.
    • Password: Enter the password used to authenticate.

You can now test the connection by enabling the CData Zoho CRM data source in the Actions column. After reporting a status of OK, the Zoho CRM data source is ready for use.

Execute Queries

The cfquery tag can pass SQL statements to Zoho CRM, including INSERT, UPDATE, and DELETE.. Use the cfqueryparam tag to create parameterized queries and prevent SQL injection through the query string.

<cfquery name="ZohoCRMQuery" dataSource="CDataZohoCRM"> SELECT * FROM Accounts WHERE Industry = <cfqueryparam value="#Industry#" cfsqltype="cf_sql_varchar"> </cfquery> <cfdump var="#ZohoCRMQuery#">

Below is the equivalent in CFScript:


<cfscript>
result = queryExecute(
  "SELECT * FROM Accounts WHERE Industry = ?", 
  [
    { value="Data/Telecom OEM", cfsqltype="cf_sql_varchar" }
  ],
  { datasource="CDataZohoCRM" }
);

writeDump( var= result );
</cfscript> 

You can then make requests to your .cfm like the following:

http://MyServer:8500/query.cfm?Industry=Data/Telecom OEM