Replicate Multiple Smartsheet Accounts via the CData Sync CLI

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

Getting Started

---

Configure Smartsheet Connections

You can save connection and email notification settings in an XML configuration file. To replicate multiple Smartsheet accounts, use multiple configuration files. Below is an example configuration to replicate Smartsheet 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:33333;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:33333;InitiateOAuth=GETANDREFRESH;</ConnectionString>
 <ReplicateAll>False</ReplicateAll>
 <NotificationUserName></NotificationUserName>
 <DatabaseConnectionString>Data Source=C:\my.db</DatabaseConnectionString>
</CDataSync>

Smartsheet uses the OAuth authentication standard. To authenticate using OAuth, register an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties.

However, for testing purposes you can instead use the Personal Access Token you get when you create an application; set this to the OAuthAccessToken connection property.

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

REPLICATE Sheet_Event_Plan_Budget;

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

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

REPLICATE PROD_Sheet_Event_Plan_Budget SELECT * FROM Sheet_Event_Plan_Budget 

Alternatively, you can use a different schema:

REPLICATE PROD.Sheet_Event_Plan_Budget SELECT * FROM Sheet_Event_Plan_Budget

Run Sync

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

Windows

SmartsheetSync.exe -g MyProductionSmartsheetConfig.xml -f MyProductionSmartsheetSync.sql

Java

java -Xbootclasspath/p:c:\sqlitejdbc.jar -jar SmartsheetSync.jar -g MyProductionSmartsheetConfig.xml -f MyProductionSmartsheetSync.sql