Replicate AgileCRM Data to Multiple Databases via the CData Sync CLI

Always-on applications rely on automatic failover capabilities and real-time access to data. CData Sync for AgileCRM integrates live AgileCRM data into your mirrored databases, always-on cloud databases, and other databases such as your reporting server: Automatically synchronize with remote AgileCRM data from Windows or any machine running Java.

You can use Sync's command-line interface (CLI) to easily control almost all aspects of the replication. You can use the CLI to replicate AgileCRM data to one or many databases without any need to change your configuration.

Connect to AgileCRM Data

You can save connection strings and other settings like email notifications in XML configuration files.

The following example shows how to replicate to SQLite.

Windows

<?xml version="1.0" encoding="UTF-8" ?>
<CDataSync><DatabaseType>SQLite</DatabaseType>
  <DatabaseProvider>System.Data.SQLite</DatabaseProvider>
  <ConnectionString>Profile=C:\profiles\Agilecrm.apip;ProfileSettings='APIKey=your_api_key;Domain=your_domain;User=your_email';</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>Profile=C:\profiles\Agilecrm.apip;ProfileSettings='APIKey=your_api_key;Domain=your_domain;User=your_email';</ConnectionString>
<ReplicateAll>False</ReplicateAll>
<NotificationUserName></NotificationUserName>
<DatabaseConnectionString>Data Source=C:\my.db</DatabaseConnectionString>
</CDataSync>

Set the ProfileSettings connection property to the connection string for AgileCRM (see below).

AgileCRM API Profile Settings

Log in to AgileCRM and go to Admin Settings > Developers & API > REST API to find your API key. Your domain is the subdomain from your AgileCRM account URL.

Configure Replication Queries

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 AgileCRM API. The statement below caches and incrementally updates a table of AgileCRM data:

REPLICATE Campaigns;

You can specify a file containing the replication queries. This enables you to use the same replication queries to replicate to several databases.

Run Sync

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

Windows

APISync.exe -g MySQLiteConfig.xml -f APISync.sql

Java

java -Xbootclasspath/p:c:\sqlitejdbc.jar -jar APISync.jar -g MySQLiteConfig.xml -f APISync.sql