Replicate Multiple Productboard Accounts via the CData Sync CLI
CData Sync for Productboard 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 Productboard connections. In this article we show how to use the CLI to replicate multiple Productboard accounts.
Configure Productboard Connections
You can save connection and email notification settings in an XML configuration file. To replicate multiple Productboard accounts, use multiple configuration files. Below is an example configuration to replicate Productboard to SQLite:
Windows
<?xml version="1.0" encoding="UTF-8" ?> <CDataSync> <DatabaseType>SQLite</DatabaseType> <DatabaseProvider>System.Data.SQLite</DatabaseProvider> <ConnectionString>Profile=C:\profiles\Productboard.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';</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>Profile=C:\profiles\Productboard.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';</ConnectionString> <ReplicateAll>False</ReplicateAll> <NotificationUserName></NotificationUserName> <DatabaseConnectionString>Data Source=C:\my.db</DatabaseConnectionString> </CDataSync>
Authentication
To authenticate to ProductBoard, and connect to your own data or to allow other users to connect to their data, you can use API Key authentication.
Using API Key Authentication
To authenticate using an API Key, you need to obtain your API Key from your ProductBoard workspace settings.
You can then connect by setting the AuthScheme to APIKey and providing your API key:
- AuthScheme: Set this to APIKey.
- APIKey: Set this to your API key from ProductBoard.
Configure Queries for Each Productboard 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 Productboard API. The statement below caches and incrementally updates a table of Productboard data:
REPLICATE Features;
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 Productboard accounts into the same database:
You can use a different table prefix in the REPLICATE SELECT statement:
REPLICATE PROD_Features SELECT * FROM Features
Alternatively, you can use a different schema:
REPLICATE PROD.Features SELECT * FROM Features
Run Sync
After you have configured the connection strings and replication queries, you can run Sync with the following command-line options:
Windows
APISync.exe -g MyProductionAPIConfig.xml -f MyProductionAPISync.sql
Java
java -Xbootclasspath/p:c:\sqlitejdbc.jar -jar APISync.jar -g MyProductionAPIConfig.xml -f MyProductionAPISync.sql