Query Zendesk Data in ColdFusion

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

Create a JDBC Data Source for Zendesk 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.

   👁 Adding a JDBC data source to ColdFusion. (Salesforce is shown.)
   

3. Populate the driver properties:

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

     Connecting to Zendesk

     To connect, set the URL and provide authentication. The URL is your Zendesk Support URL: https://{subdomain}.zendesk.com.

     Authenticating to Zendesk

     You can authenticate using the Basic or OAuth methods.

     Using Basic Authentication

     To use Basic authentication, specify your email address and password or your email address and an API token. Set User to your email address and follow the steps below to provide the Password or ApiToken.

     • Enable password access in the Zendesk Support admin interface at Admin > Channels > API.
     • Manage API tokens in the Zendesk Support Admin interface at Admin > Channels > API. More than one token can be active at the same time. Deleting a token deactivates it permanently.

     Using OAuth Authentication

     See the Getting Started guide in the CData driver documentation for an authentication guide.

     Built-in Connection String Designer

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

     java -jar cdata.jdbc.zendesk.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 below:

     jdbc:zendesk:URL=https://subdomain.zendesk.com;[email protected];Password=test123;InitiateOAuth=GETANDREFRESH;

   • Driver Class: Enter the driver class. The driver class is cdata.jdbc.zendesk.ZendeskDriver.
   • 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 Zendesk data source in the Actions column. After reporting a status of OK, the Zendesk data source is ready for use.

Execute Queries

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

Note: To use the cfquery and cfscript, create a .cfm file. Inside the .cfm file, write the code to execute the query (see below). Place the file directly in the root directory of your web server (e.g., wwwroot in Adobe ColdFusion). Restart the service after placing the file for the changes to take effect.

<cfquery name="ZendeskQuery" dataSource="CDataZendesk">
 SELECT * FROM Tickets WHERE Industry = <cfqueryparam value="#Industry#" cfsqltype="cf_sql_varchar">
</cfquery>
<cfdump var="#ZendeskQuery#">

Below is the equivalent in CFScript:

<cfscript>
result = queryExecute(
 "SELECT * FROM Tickets WHERE Industry = ?", 
 [
 { value="Floppy Disks", cfsqltype="cf_sql_varchar" }
 ],
 { datasource="CDataZendesk" }
);

writeDump( var= result );
</cfscript> 

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

http://MyServer:8500/query.cfm?Industry=Floppy Disks