Replicate Multiple Highrise Accounts via the CData Sync CLI

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

Configure Highrise Connections

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

Windows

<?xml version="1.0" encoding="UTF-8" ?>
<CDataSync>
 <DatabaseType>SQLite</DatabaseType>
 <DatabaseProvider>System.Data.SQLite</DatabaseProvider>
 <ConnectionString>OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost;AccountId=MyAccountId;InitiateOAuth=GETANDREFRESH;</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>OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost;AccountId=MyAccountId;InitiateOAuth=GETANDREFRESH;</ConnectionString>
 <ReplicateAll>False</ReplicateAll>
 <NotificationUserName></NotificationUserName>
 <DatabaseConnectionString>Data Source=C:\my.db</DatabaseConnectionString>
</CDataSync>

Highrise uses the OAuth authentication standard. To authenticate to Highrise, obtain the OAuthClientId, OAuthClientSecret, and CallbackURL by registering an app with Highrise. You will also need to set the AccountId to connect to data.

See the "Getting Started" section in the help documentation for a guide to using OAuth.

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

REPLICATE Deals;

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

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

REPLICATE PROD_Deals SELECT * FROM Deals 

Alternatively, you can use a different schema:

REPLICATE PROD.Deals SELECT * FROM Deals

Run Sync

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

Windows

HighriseSync.exe -g MyProductionHighriseConfig.xml -f MyProductionHighriseSync.sql

Java

java -Xbootclasspath/p:c:\sqlitejdbc.jar -jar HighriseSync.jar -g MyProductionHighriseConfig.xml -f MyProductionHighriseSync.sql