Connect to Xero Data in Aqua Data Studio

The CData JDBC Driver for Xero integrates Xero data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to Xero data through the connection manager and execute queries.

Getting Started

---

Create a JDBC Data Source

You can use the connection manager to define connection properties and save them in a new JDBC data source. The Xero data source can then be accessed from Aqua Data Studio tools.

1. In Aqua Data Studio, select Register Server from the Servers menu.
2. In the Register Server form, select the 'Generic - JDBC' connection.
3. Enter the following JDBC connection properties:
   • Name: Enter a name for the data source; for example, Xero.
   • Driver Location: Click the Browse button and select the cdata.jdbc.xero.jar file, located in the lib subfolder of the installation directory.
   • Driver: Enter the Driver's class name, cdata.jdbc.xero.XeroDriver.

   • URL: Enter the JDBC URL, which starts with jdbc:xero: and is followed by a semicolon-separated list of 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.

     Built-in Connection String Designer

     For assistance in constructing the JDBC URL, use the connection string designer built into the Xero JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

     java -jar cdata.jdbc.xero.jar
     

     Fill in the connection properties and copy the connection string to the clipboard.

     👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
     A typical JDBC URL is below:

     jdbc:xero:InitiateOAuth=GETANDREFRESH;

   👁 The JDBC data source, defined by the JAR path, driver class, and JDBC URL. (QuickBooks is shown.)
   

Query Xero Data

You can now query the tables exposed.