Replicate Multiple Microsoft Planner Accounts via the CData Sync CLI

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

Configure Microsoft Planner Connections

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

Windows

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

You can connect without setting any connection properties for your user credentials. Below are the minimum connection properties required to connect.

• InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
• Tenant (optional): Set this if you wish to authenticate to a different tenant than your default. This is required to work with an organization not on your default Tenant.

When you connect the Driver opens the MS Planner OAuth endpoint in your default browser. Log in and grant permissions to the Driver. The Driver then completes the OAuth process.

1. Extracts the access token from the callback URL and authenticates requests.
2. Obtains a new access token when the old one expires.
3. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.

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

REPLICATE Tasks;

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

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

REPLICATE PROD_Tasks SELECT * FROM Tasks 

Alternatively, you can use a different schema:

REPLICATE PROD.Tasks SELECT * FROM Tasks

Run Sync

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

Windows

MicrosoftPlannerSync.exe -g MyProductionMicrosoftPlannerConfig.xml -f MyProductionMicrosoftPlannerSync.sql

Java

java -Xbootclasspath/p:c:\sqlitejdbc.jar -jar MicrosoftPlannerSync.jar -g MyProductionMicrosoftPlannerConfig.xml -f MyProductionMicrosoftPlannerSync.sql