Ready to get started?

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

Download Now

Query Freshdesk Data in ColdFusion

Write standard ColdFusion data access code to connect to Freshdesk data.

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

Create a JDBC Data Source for Freshdesk 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:freshdesk: and is followed by the connection properties in a semicolon-separated list of name=value pairs.

      FreshDesk makes use of basic authentication. To connect to data, set the following connection properties:

      • Domain: Set this to the domain associated with your FreshDesk account. For example, in your URL: https://my_domain.freshdesk.com.
      • APIKey: Set this to the API key associated with your FreshDesk account. To retrieve your API key, Log into your support Portal -> Click on profile picture in the top right corner -> profile settings page. The API key will be available below the change password section to the right.

      Built-in Connection String Designer

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

      java -jar cdata.jdbc.freshdesk.jar

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

      A typical JDBC URL is below:

      jdbc:freshdesk:Domain=MyDomain;APIKey=myAPIKey;
    • Driver Class: Enter the driver class. The driver class is cdata.jdbc.freshdesk.FreshDeskDriver.
    • 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 Freshdesk data source in the Actions column. After reporting a status of OK, the Freshdesk data source is ready for use.

Execute Queries

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

<cfquery name="FreshDeskQuery" dataSource="CDataFreshDesk"> SELECT * FROM Tickets WHERE Status = <cfqueryparam value="#Status#" cfsqltype="cf_sql_varchar"> </cfquery> <cfdump var="#FreshDeskQuery#">

Below is the equivalent in CFScript:


<cfscript>
result = queryExecute(
  "SELECT * FROM Tickets WHERE Status = ?", 
  [
    { value="2", cfsqltype="cf_sql_varchar" }
  ],
  { datasource="CDataFreshDesk" }
);

writeDump( var= result );
</cfscript> 

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

http://MyServer:8500/query.cfm?Status=2