Ready to get started?

Learn more or sign up for a free trial:

CData Sync

Replicate Multiple Sugar CRM Accounts



Replicate multiple Sugar CRM accounts to one or many databases.

CData Sync for Sugar CRM 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 Sugar CRM connections. In this article we show how to use the CLI to replicate multiple Sugar CRM accounts.

Configure Sugar CRM Connections

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

Windows

<?xml version="1.0" encoding="UTF-8" ?> <CDataSync> <DatabaseType>SQLite</DatabaseType> <DatabaseProvider>System.Data.SQLite</DatabaseProvider> <ConnectionString>User=MyUser;Password=MyPassword;URL=MySugarCRMAccountURL;CacheMetadata=True;</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>User=MyUser;Password=MyPassword;URL=MySugarCRMAccountURL;CacheMetadata=True;</ConnectionString> <ReplicateAll>False</ReplicateAll> <NotificationUserName></NotificationUserName> <DatabaseConnectionString>Data Source=C:\my.db</DatabaseConnectionString> </CDataSync>

The User and Password properties, under the Authentication section, must be set to valid SugarCRM user credentials. This will use the default OAuth token created to allow client logins. OAuthClientId and OAuthClientSecret are required if you do not wish to use the default OAuth token.

You can generate a new OAuth consumer key and consumer secret in Admin -> OAuth Keys. Set the OAuthClientId to the OAuth consumer key. Set the OAuthClientSecret to the consumer secret.

Additionally, specify the URL to the SugarCRM account.

Note that retrieving SugarCRM metadata can be expensive. It is advised that you store the metadata locally as described in the "Caching Metadata" chapter of the help documentation.

Configure Queries for Each Sugar CRM 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 Sugar CRM API. The statement below caches and incrementally updates a table of Sugar CRM data:

REPLICATE Accounts;

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 Sugar CRM accounts into the same database:

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

REPLICATE PROD_Accounts SELECT * FROM Accounts

Alternatively, you can use a different schema:

REPLICATE PROD.Accounts SELECT * FROM Accounts

Run Sync

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

Windows

SugarCRMSync.exe -g MyProductionSugarCRMConfig.xml -f MyProductionSugarCRMSync.sql

Java

java -Xbootclasspath/p:c:\sqlitejdbc.jar -jar SugarCRMSync.jar -g MyProductionSugarCRMConfig.xml -f MyProductionSugarCRMSync.sql