Ready to get started?

Download a free trial of the Xero ODBC Driver to get started:

 Download Now

Learn more:

Xero Icon Xero ODBC Driver

The Xero ODBC Driver is a powerful tool that allows you to connect with live data from Xero accounting software , directly from any applications that support ODBC connectivity.

Access Xero data like you would a database - read, write, and update Xero Customers, Transactions, Invoices, Sales Receipts, etc. through a standard ODBC Driver interface.

Establish a Live Connection with Xero Data using Tableau Bridge



The CData ODBC Driver for Xero enables you to integrate live Xero data into Tableau Cloud dashboards using the Tableau Bridge.

The Tableau Bridge enables you to publish dashboards to Tableau Cloud while maintaining live connectivity with any data source. In this article, you will use the Tableau Bridge to maintain data freshness in a published workbook by listening for changes in the underlying Xero data.

The CData ODBC drivers offer unmatched performance for interacting with live Xero data in Tableau Cloud due to optimized data processing built into the driver. When you issue complex SQL queries from Tableau Cloud to Xero, the driver pushes supported SQL operations, like filters and aggregations, directly to Xero and utilizes the embedded SQL engine to process unsupported operations (often SQL functions and JOIN operations) client-side. With built-in dynamic metadata querying, you can visualize and analyze Xero data using native Tableau data types.

Connect to Xero as an ODBC Data Source

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

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.

When you configure the DSN, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

Add Xero Data to a Dashboard

  1. From a new workbook, click Data -> New Data Source -> Other Databases (ODBC).
    Select the CData Data Source Name (for example: CData Xero Source).
  2. In the Database menu, select CData.
  3. In the Table box, enter a table name or click New Custom SQL to enter an SQL query. This article retrieves the Items table.
  4. Drag the table onto the join area. At this point, you can include multiple tables, leveraging the built-in SQL engine to process complex data requests.
  5. Click the tab for your worksheet. Columns are listed as Dimensions and Measures, which you can drag and drop onto the dashboard to create visualizations.

Set Up Tableau Bridge as a Service

  1. In the Server menu, select Start Tableau Bridge Client.
  2. Sign in to the Tableau Bridge using a site admin level account.
  3. If prompted, select the Tableau Cloud site where you want to publish live data. The bridge client will open and is accessible from the system tray.
  4. By default, the Tableau Bridge client is set to Application mode. Select 'Switch to service' to enable Tableau Bridge to handle live connections.
  5. Log in to your Tableau Cloud site as an administrator.
  6. From your site, click Settings, then Bridge.
  7. In the Bridge settings, under Enable Clients to Maintain Live Connections, check the box labeled 'Enable Tableau Bridge clients to maintain live connections to on-premises data.'

Publish a Dashboard Containing the Live Data Source

Having configured both the Tableau Bridge and Tableau Cloud to enable live data connections, you can now publish your workbook to Tableau Cloud. From the Server menu, select Publish Workbook.

After choosing the workbook name and project that you wish to publish to, configure the deployment so that the CData ODBC driver for Xero is embedded in your workbook as a separate, live data source.

  1. Under Data Sources, select the option to Edit the embedded data sources in the workbook.
  2. Change Publish Type to 'Published separately,' then select a desired means of authentication.
  3. Last, select 'Maintain connection to a live data source' and click the green Publish Workbook button.

The published workbook now updates alongside the underlying Xero data. From a published dashboard, simply click the Refresh button to reflect the most recent changes.