Connect to Freshdesk Data in NetBeans

The CData JDBC Driver for Freshdesk integrates connectivity to live Freshdesk data in IDEs that support JDBC. The JDBC standard enables you to use built-in data access wizards and other tools supporting rapid development. This article shows how to connect to Freshdesk data in NetBeans. You will create a connection and edit and save Freshdesk data in the Table Editor.

Create a JDBC Data Source for Freshdesk in NetBeans

To create the JDBC data source, expand the Database node in the Service window, right-click the Drivers node, and select New Driver. In the New Driver wizard that results, enter the following information:

• Driver File(s): Click Add and, in the file explorer dialog that appears, select the cdata.jdbc.freshdesk.jar file. The driver JAR is located in the lib subfolder of the installation directory.
• Driver Class: Click Find to search for the driver class inside the JAR. Then select cdata.jdbc.freshdesk.FreshDeskDriver from the menu.
• Name: Enter the name for the driver.

Define Connection Parameters

Follow the steps below to define required connection properties:

1. In the Service window, right-click the Database node and click New Connection.

2. In the New Connection Wizard, enter the following connection properties:

   • Driver Name: In the menu, select the CData JDBC Driver for Freshdesk.
   • User Name: Enter the username. This can also be defined in the JDBC URL.
   • Password: Enter the password. This can also be defined in the JDBC URL.

   • JDBC URL: Specify the JDBC URL.

     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 the following:

     jdbc:freshdesk:Domain=MyDomain;APIKey=myAPIKey;

Query Freshdesk Data

To connect to Freshdesk data, right-click the connection in the Database node and click Connect. After the connection is established, you can expand it to discover schema information.

To load a table in the Data Views window, right-click the table and then click View Data. You can also insert, update, or delete records in the Data Views window.