How to connect to Freshdesk Data in DBVisualizer

The CData JDBC Driver for Freshdesk implements JDBC standards to provide connectivity to Freshdesk data in applications ranging from business intelligence tools to IDEs. This article shows how to establish a connection to Freshdesk data in DBVisualizer and use the table editor to edit and save Freshdesk data.

Create a New Driver Definition for Freshdesk Data

Follow the steps below to use the Driver Manager to provide connectivity to Freshdesk data from DBVisualizer tools.

1. In DBVisualizer, click Tools -> Driver Manager.
2. Click the plus sign "" to create a new driver.
3. Select "Custom" as the template.
4. On the Driver Settings tab:
   • Set Name to a user-friendly name (e.g. "CData Freshdesk Driver")
   • Set URL Format to jdbc:freshdesk:
   • In Driver artifacts and jar files (jars are loaded in order from top):
     1. Click the plus sign "" -> "Add Files"
     2. Navigate to the "lib" folder in the installation directory (C:\Program Files\CData[product_name] XXXX\)
     3. Select the JAR file (cdata.jdbc.FreshDesk.jar) and click "Open"
5. The Driver Class should populate automatically. If not, select class (cdata.jdbc.freshdesk.FreshDeskDriver).

Define the Connection to the JDBC Data Source

Close the "Driver Manager" and follow the steps below to save connection properties in the JDBC URL.

1. In the "Databases" tab, click the plus sign "" and select the driver you just created.

2. In the "Connection" section, set the following options:

   • Database Type: If you selected the wizard option, the database type is automatically detected. If you selected the "No Wizard" option, select the Generic or Auto Detect option in the Database Type menu.
   • Driver Type: Select the driver you just created.

   • Database URL: Enter the full JDBC URL. The syntax of the JDBC URL is jdbc:freshdesk: 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.

     When you configure the JDBC URL, 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.

     A typical connection string is below:

     jdbc:freshdesk:Domain=MyDomain;APIKey=myAPIKey;
   • NOTE: Since Freshdesk does not require a User or Password to authenticate, you may use whatever values you wish for Database Userid and Database Password.
3. On the Connection tab, click Connect.

To browse through tables exposed by the Freshdesk JDBC Driver, right-click a table and click "Open in New Tab."

To execute SQL queries, use the SQL Commander tool: Click SQL Commander -> New SQL Commander. Select the Database Connection, Database, and Schema from the available menus.

See the "Supported SQL" chapter in the help documentation for more information on the supported SQL. See the "Data Model" chapter for table-specific information.

More Information & Free Trial