Ready to get started?

Learn more or sign up for a free trial:

CData Sync

Automated Continuous Xero Replication to MongoDB



Use CData Sync for automated, continuous, customizable Xero replication to MongoDB.

Always-on applications rely on automatic failover capabilities and real-time data access. CData Sync integrates live Xero data into your MongoDB instance, allowing you to consolidate all of your data into a single location for archiving, reporting, analytics, machine learning, artificial intelligence and more.

Configure MongoDB as a Replication Destination

Using CData Sync, you can replicate Xero data to MongoDB. To add a replication destination, navigate to the Connections tab.

  1. Click Add Connection.
  2. Select MongoDB as a destination.
  3. Enter the necessary connection properties. To connect to MongoDB, set the following:
    • Server: Set this to the name or address of the server where your MongoDB instance is running. You can specify the port here or in Port.
    • Database: Set this to the database you want to read from and write to.

    Connecting to CosmosDB with the MongoDB API

    To obtain the connection string needed to connect to a Cosmos DB account using the MongoDB API, log in to the Azure Portal, select Azure Cosmos DB, and select your account. In the Settings section, click Connection String and set the following values.

    • Server: Set this to the Host value, the FQDN of the server provisioned for your account. You can also specify the port here or in Port.
    • Port: Set this to the port.
    • Database: Set this to the database you want to read from and write to.
    • User: Set this to the database user.
    • Password: Set this to the user's password.

  4. Click Test Connection to ensure that the connection is configured properly.
  5. Click Save Changes.

Configure the Xero Connection

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

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

    To connect, set the Schema connection property in addition to any authentication values. Xero offers authentication for private applications, public applications, and partner applications. You will need to set the XeroAppAuthentication property to PUBLIC, PRIVATE, or PARTNER, depending on the type of application configured. To connect from a private application, you will additionally need to set the OAuthAccessToken, OAuthClientId, OAuthClientSecret, CertificateStoreType, CertificateStore, and CertificateStorePassword.

    To connect from a public or partner application, you can use the embedded OAuthClientId, OAuthClientSecret, and CallbackURL, or you can register an app to obtain your own OAuth values.

    See the "Getting Started" chapter of the help documentation for a guide to authenticating to Xero.

  4. Click Connect to ensure that the connection is configured properly.
  5. Click Save 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.

Replicate Entire Tables

To replicate an entire table, click Add Tables in the Tables section, choose the table(s) you wish to replicate, and click Add Selected Tables.

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.

Schedule Your Replication

In the Schedule section, you can schedule a job to run automatically, configuring the job to run after specified intervals ranging from once every 10 minutes to once every month.

Once you have configured the replication job, click Save Changes. You can configure any number of jobs to manage the replication of your Xero data to MongoDB.