Connect to Freshdesk Data in Aqua Data Studio

The CData JDBC Driver for Freshdesk integrates Freshdesk data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to Freshdesk data through the connection manager and execute queries.

Create a JDBC Data Source

You can use the connection manager to define connection properties and save them in a new JDBC data source. The Freshdesk data source can then be accessed from Aqua Data Studio tools.

1. In Aqua Data Studio, select Register Server from the Servers menu.
2. In the Register Server form, select the 'Generic - JDBC' connection.
3. Enter the following JDBC connection properties:
   • Name: Enter a name for the data source; for example, Freshdesk.
   • Driver Location: Click the Browse button and select the cdata.jdbc.freshdesk.jar file, located in the lib subfolder of the installation directory.
   • Driver: Enter the Driver's class name, cdata.jdbc.freshdesk.FreshDeskDriver.

   • URL: Enter the JDBC URL, which starts with jdbc:freshdesk: and is followed by a semicolon-separated list of connection properties.

     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;

Query Freshdesk Data

You can now query the tables exposed.