Learn more
 

Replicate Multiple Klipfolio Accounts


Replicate multiple Klipfolio accounts to one or many databases.

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

Configure Klipfolio Connections

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

Windows

<?xml version="1.0" encoding="UTF-8" ?> <CDataSync> <DatabaseType>SQLite</DatabaseType> <DatabaseProvider>System.Data.SQLite</DatabaseProvider> <ConnectionString>Profile=C:\profiles\Klipfolio.apip;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\Klipfolio.apip;ProfileSettings='APIKey=your_api_key';</ConnectionString> <ReplicateAll>False</ReplicateAll> <NotificationUserName></NotificationUserName> <DatabaseConnectionString>Data Source=C:\my.db</DatabaseConnectionString> </CDataSync>

Start by setting the Profile connection property to the location of the Klipfolio Profile on disk (e.g. C:\profiles\Klipfolio.apip). Next, set the ProfileSettings connection property to the connection string for Klipfolio (see below).

Klipfolio API Profile Settings

In order to authenticate to Klipfolio, you'll need to provide your API Key. You can generate an API key from the Klipfolio Dashboard app through either the My Profile page or from Users if you are an administrator (you must have the user.manage permission). Set the API Key in the ProfileSettings property to connect.

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

REPLICATE DataSources;

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

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

REPLICATE PROD_DataSources SELECT * FROM DataSources

Alternatively, you can use a different schema:

REPLICATE PROD.DataSources SELECT * FROM DataSources

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

Ready to get started?

Learn more or sign up for a free trial:

CData Sync

In this article

Related articles