Replicate Multiple JobNimbus Accounts via the CData Sync CLI
CData Sync for JobNimbus 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 JobNimbus connections. In this article we show how to use the CLI to replicate multiple JobNimbus accounts.
Configure JobNimbus Connections
You can save connection and email notification settings in an XML configuration file. To replicate multiple JobNimbus accounts, use multiple configuration files. Below is an example configuration to replicate JobNimbus to SQLite:
Windows
<?xml version="1.0" encoding="UTF-8" ?> <CDataSync> <DatabaseType>SQLite</DatabaseType> <DatabaseProvider>System.Data.SQLite</DatabaseProvider> <ConnectionString>Profile=C:\profiles\JobNimbus.apip;AuthScheme=APIKey;ProfileSettings='APIKey=my_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\JobNimbus.apip;AuthScheme=APIKey;ProfileSettings='APIKey=my_api_key';</ConnectionString> <ReplicateAll>False</ReplicateAll> <NotificationUserName></NotificationUserName> <DatabaseConnectionString>Data Source=C:\my.db</DatabaseConnectionString> </CDataSync>
Using API Key Authentication
JobNimbus uses API key authentication to control access to the API. To obtain a JobNimbus API key:
- Log in to your JobNimbus account.
- Navigate to Settings > Integrations > API.
- Generate or copy your existing API key from this page.
After obtaining your API key, set the following connection properties:
- AuthScheme: Set this to APIKey.
- APIKey: Set this to your JobNimbus API key.
Example Connection String
Profile=C:\profiles\JobNimbus.apip;AuthScheme=APIKey;ProfileSettings='APIKey=my_api_key';
Configure Queries for Each JobNimbus 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 JobNimbus API. The statement below caches and incrementally updates a table of JobNimbus data:
REPLICATE AccountUsers;
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 JobNimbus accounts into the same database:
You can use a different table prefix in the REPLICATE SELECT statement:
REPLICATE PROD_AccountUsers SELECT * FROM AccountUsers
Alternatively, you can use a different schema:
REPLICATE PROD.AccountUsers SELECT * FROM AccountUsers
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