Replicate Multiple REST Accounts

CData Sync is a standalone application designed to support a variety of replication scenarios, such as replicating both sandbox and production instances into your database. It includes a web-based interface that simplifies the management of multiple REST connections. In this article, we demonstrate how to use the web app to replicate multiple REST accounts into a single database.

Configure Replication Destinations

Using CData Sync, you can replicate data from REST to any number of databases, both cloud-based and on-premises. In this example, we use SQLite as the replication destination to demonstrate the process. To add it as a destination, navigate to the Connections tab.

For each destination database:

1. Click Add Connection. 👁 Add a new connection.
   
2. Select the Destinations tab and locate the SQLite connector. 👁 Configure a Destination connection to SQLite.
   
3. Click the Configure Connection icon at the end of that row to open the New Connection page. If the Configure Connection icon is not available, click the Download Connector icon to install the SQLite connector. For more information about installing new connectors, see Connections in the Help documentation.
4. To connect to SQLite, set the following connection properties:
   • Connection Name: Enter a connection name of your choice.
   • Data Source: Enter the path to the database. You can replicate to an existing database or to a new one. The application must have permission to access the database.
👁 Enter the connection details.

5. Once connected, click Create & Test to create, test and save the connection.

You are now connected to SQLite and can use it as both a source and a destination.

NOTE: You can use the Label feature to add a label for a source or a destination.

👁 Add a label.

Configure the REST Connection

You can configure a connection to REST from the Connections tab. To add a connection to your REST account, navigate to the Connections tab.

1. Click Add Connection.
2. Select a source (REST).
3. Configure the connection properties.
   
   

   See the Getting Started chapter in the data provider documentation to authenticate to your data source: The data provider models REST APIs as bidirectional database tables and XML/JSON files as read-only views (local files, files stored on popular cloud services, and FTP servers). The major authentication schemes are supported, including HTTP Basic, Digest, NTLM, OAuth, and FTP. See the Getting Started chapter in the data provider documentation for authentication guides.

   After setting the and providing any authentication values, set to "XML" or "JSON" and set to more closely match the data representation to the structure of your data.

   The property is the controlling property over how your data is represented into tables and toggles the following basic configurations.

   • Document (default): Model a top-level, document view of your REST data. The data provider returns nested elements as aggregates of data.
   • FlattenedDocuments: Implicitly join nested documents and their parents into a single table.
   • Relational: Return individual, related tables from hierarchical data. The tables contain a primary key and a foreign key that links to the parent document.

   See the Modeling REST Data chapter for more information on configuring the relational representation. You will also find the sample data used in the following examples. The data includes entries for people, the cars they own, and various maintenance services performed on those cars.

   👁 Configuring a Source connection (Salesforce is shown).
   
4. Click Connect to REST to ensure that the connection is configured properly.
5. Click Save & Test to save the changes.

Configure Replication Queries

CData Sync enables you to control replication with a point-and-click interface and with SQL queries. For each replication you wish to configure, navigate to the Jobs tab and click Add Job. Select the Source and Destination for your replication.

👁 Select Source and Destination connections for the replication.

Replicate Entire Tables

To replicate an entire table, navigate to the Task tab in the Job, click Add Tasks, choose the table(s) from the list of REST tables you wish to replicate into SQLite, and click Add Tasks again.

👁 Choose the account table to replicate (Salesforce is shown).

Customize Your Replication

You can use the Columns and Query tabs of a task to customize your replication. The Columns tab allows you to specify which columns to replicate, rename the columns at the destination, and even perform operations on the source data before replicating. The Query tab allows you to add filters, grouping, and sorting to the replication with the help of SQL queries. 👁 Configure a replication Transform.

The statement below caches and incrementally updates a table of REST data:

REPLICATE people;

You can specify a file containing the replication queries you want to use to update a particular database. Separate the replication statements with semicolons. The following options are useful when replicating multiple REST accounts into the same database:

• Use a different table prefix in the REPLICATE SELECT statement:

  REPLICATE PROD_people SELECT * FROM people;
  

• Alternatively, use a different schema:

  REPLICATE PROD.people SELECT * FROM people;
  

Schedule Your Replication

Select the Overview tab in the Job, and click Configure under Schedule. You can schedule a job to run automatically by configuring it to run at specified intervals, ranging from once every 10 minutes to once every month.

👁 Schedule your job to run automatically.

Once you have configured the replication job, click Save Changes. You can configure any number of jobs to manage the replication of your REST data to disparate on-premises, cloud-based, and other databases.

Run the Replication Job

Once all the required configurations are made for the job, select the REST table you wish to replicate and click Run. After the replication completes successfully, a notification appears, showing the time taken to run the job and the number of rows replicated.

👁 Run the job.

Free Trial & More Information

Now that you've seen how to replicate and configure multiple jobs to manage the replication of your REST data to various on-premises, cloud-based, and other databases, visit our CData Sync page to learn more and download a free 30-day trial. Start consolidating your enterprise data today!

As always, our world-class Support Team is ready to answer any questions you may have.