Learn more
 

Ready to get started?

Learn more or sign up for a free trial:

CData Sync

In this article

Related articles

Replicate Multiple Backlog Accounts


Replicate multiple Backlog accounts to one or many databases.

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

Configure Backlog Connections

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

Windows

<?xml version="1.0" encoding="UTF-8" ?> <CDataSync> <DatabaseType>SQLite</DatabaseType> <DatabaseProvider>System.Data.SQLite</DatabaseProvider> <ConnectionString>APIKey=my_api_key;URL=my.backlog.url;</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>APIKey=my_api_key;URL=my.backlog.url;</ConnectionString> <ReplicateAll>False</ReplicateAll> <NotificationUserName></NotificationUserName> <DatabaseConnectionString>Data Source=C:\my.db</DatabaseConnectionString> </CDataSync>

In order to authenticate using the API Key, specify the following:

  • AuthScheme: Set to APIToken.
  • API Key: Set to the API Key that allows you to make requests to the Backlog API. You can generate this key by opening the Settings page in Backlog and selecting the API section.
  • URL: Set to the your Backlog tenant URL.

In order to authenticate using OAuth, set AuthScheme to "OAuth" and refer to the Help documentation.

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

REPLICATE Issues;

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

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

REPLICATE PROD_Issues SELECT * FROM Issues

Alternatively, you can use a different schema:

REPLICATE PROD.Issues SELECT * FROM Issues

Run Sync

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

Windows

BacklogSync.exe -g MyProductionBacklogConfig.xml -f MyProductionBacklogSync.sql

Java

java -Xbootclasspath/p:c:\sqlitejdbc.jar -jar BacklogSync.jar -g MyProductionBacklogConfig.xml -f MyProductionBacklogSync.sql