Replicate Multiple Superchat Accounts via the CData Sync CLI

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

Configure Superchat Connections

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

Windows

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

Superchat uses API Key authentication. The API key is passed via the X-API-KEY request header on every call.

Authentication

To authenticate to Superchat, you need to obtain your API key from the Superchat workspace settings.

Using API Key Authentication

You can obtain your API key from Settings > Integrations > API Key in your Superchat workspace.

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

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your Superchat API key.

Example connection string:

Profile=C:\profiles\Superchat.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';

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

REPLICATE Channels;

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

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

REPLICATE PROD_Channels SELECT * FROM Channels 

Alternatively, you can use a different schema:

REPLICATE PROD.Channels SELECT * FROM Channels

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