Replicate Multiple Freshdesk Accounts via the CData Sync CLI

CData Sync for Freshdesk is a stand-alone application that provides solutions for a variety of replication scenarios such as replicating sandbox and production instances into your database. Both Sync for Windows and Sync for Java include a command-line interface (CLI) that makes it easy to manage multiple Freshdesk connections. In this article we show how to use the CLI to replicate multiple Freshdesk accounts.

Configure Freshdesk Connections

You can save connection and email notification settings in an XML configuration file. To replicate multiple Freshdesk accounts, use multiple configuration files. Below is an example configuration to replicate Freshdesk to SQLite:

Windows

<?xml version="1.0" encoding="UTF-8" ?>
<CDataSync>
 <DatabaseType>SQLite</DatabaseType>
 <DatabaseProvider>System.Data.SQLite</DatabaseProvider>
 <ConnectionString>Domain=MyDomain;APIKey=myAPIKey;</ConnectionString>
 <ReplicateAll>False</ReplicateAll>
 <NotificationUserName></NotificationUserName>
 <DatabaseConnectionString>Data Source=C:\my.db</DatabaseConnectionString>
 <TaskSchedulerStartTime>09:51</TaskSchedulerStartTime>
 <TaskSchedulerInterval>Never</TaskSchedulerInterval>
</CDataSync>

Java

<?xml version="1.0" encoding="UTF-8" ?>
<CDataSync>
<DatabaseType>SQLite</DatabaseType>
 <DatabaseProvider>org.sqlite.JDBC</DatabaseProvider>
 <ConnectionString>Domain=MyDomain;APIKey=myAPIKey;</ConnectionString>
 <ReplicateAll>False</ReplicateAll>
 <NotificationUserName></NotificationUserName>
 <DatabaseConnectionString>Data Source=C:\my.db</DatabaseConnectionString>
</CDataSync>

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.

Configure Queries for Each Freshdesk Instance

Sync enables you to control replication with standard SQL. The REPLICATE statement is a high-level command that caches and maintains a table in your database. You can define any SELECT query supported by the Freshdesk API. The statement below caches and incrementally updates a table of Freshdesk data:

REPLICATE Tickets;

You can specify a file containing the replication queries you want to use to update a particular database. Separate replication statements with semicolons. The following options are useful if you are replicating multiple Freshdesk accounts into the same database:

You can use a different table prefix in the REPLICATE SELECT statement:

REPLICATE PROD_Tickets SELECT * FROM Tickets 

Alternatively, you can use a different schema:

REPLICATE PROD.Tickets SELECT * FROM Tickets

Run Sync

After you have configured the connection strings and replication queries, you can run Sync with the following command-line options:

Windows

FreshDeskSync.exe -g MyProductionFreshDeskConfig.xml -f MyProductionFreshDeskSync.sql

Java

java -Xbootclasspath/p:c:\sqlitejdbc.jar -jar FreshDeskSync.jar -g MyProductionFreshDeskConfig.xml -f MyProductionFreshDeskSync.sql