Ready to get started?

Learn more or sign up for a free trial:

CData Sync

Replicate SuiteCRM Data to Multiple Databases



Replicate SuiteCRM data to disparate databases with a single configuration.

Always-on applications rely on automatic failover capabilities and real-time access to data. CData Sync for SuiteCRM integrates live SuiteCRM data into your mirrored databases, always-on cloud databases, and other databases such as your reporting server: Automatically synchronize with remote SuiteCRM 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 SuiteCRM data to one or many databases without any need to change your configuration.

Connect to SuiteCRM 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>URL=http://mySuiteCRM.com;User=myUser;Password=myPassword;</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>URL=http://mySuiteCRM.com;User=myUser;Password=myPassword;</ConnectionString> <ReplicateAll>False</ReplicateAll> <NotificationUserName></NotificationUserName> <DatabaseConnectionString>Data Source=C:\my.db</DatabaseConnectionString> </CDataSync>

The User and Password properties must be set to valid SuiteCRM user credentials. Additionally, specify the URL to the SuiteCRM application, for example http://suite.crm.com.

Note that retrieving SuiteCRM metadata can be expensive. It is advised that you store the metadata locally as described in the Caching Metadata section of the data provider help documentation.

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

REPLICATE Accounts;

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

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

Java

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