VOOZH about

URL: https://www.cdata.com/kb/tech/xero-sync-csv.rst

⇱ Automated Continuous Xero Replication to Local Delimited Files

Automated Continuous Xero Replication to Local Delimited Files

👁 Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Use CData Sync for automated, continuous, customizable Xero replication to delimited files (CSV/TSV).

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

About Xero Data Integration

Accessing and integrating live data from Xero has never been easier with CData. Customers rely on CData connectivity to:

  • Connect to Xero Accounts and both US and Australian Payroll APIs.
  • Read, write, update, and delete Xero objects like Customers, Transactions, Invoices, Sales Receipts and more.
  • Use SQL stored procedures for actions like adding items to a cart, submitting orders, and downloading attachments.
  • Work with accounting, payroll, file, fixed asset, and project data.

Customers regularly integrate their Xero data with preferred tools, like Tableau, Qlik Sense, or Excel, and integrate Xero data into their database or data warehouse.


Getting Started


Configure CSV/TSV as a Replication Destination

Using CData Sync, you can replicate Xero data to delimited files, like CSV or TSV. To add a replication destination, navigate to the Connections tab.

  1. Click Add Connection.
  2. Select CSV as a destination. 👁 Configure a Destination connection to CSV.
  3. Enter the necessary connection properties. To connect to a directory for storing delimited files, set the following:
    • Destination Folder: Set this location on the disk for the delimited files.
    • Include Column Headers: Set this to True for the first row in each file to represent the column names.
  4. Click Test Connection to ensure that the connection is configured properly. 👁 Configure a Destination connection.
  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. 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.

    👁 Configuring a Source connection (Salesforce is shown).
  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.

👁 Select Source and Destination connections for the 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.

👁 Choose entire tables 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. 👁 Configure a replication Transform.

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.

👁 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 Xero data to delimited files.