Replicate Multiple Onfleet Accounts via the CData Sync CLI

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

Configure Onfleet Connections

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

Windows

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

Onfleet uses HTTP ApiKey Authentication. Your Onfleet API Key is used to authenticate requests. You can generate or view your API Key in the Onfleet dashboard under Settings > API.

Using ApiKey Authentication

After setting the following connection properties, you are ready to connect:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your Onfleet API Key.

Example connection string:

Profile=C:\profiles\Onfleet.apip;AuthScheme=APIKey;ProfileSettings="ApiKey=your_api_key";

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

REPLICATE Administrators;

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

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

REPLICATE PROD_Administrators SELECT * FROM Administrators 

Alternatively, you can use a different schema:

REPLICATE PROD.Administrators SELECT * FROM Administrators

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