Manage Xero Data in DBArtisan as a JDBC Source

The CData JDBC Driver for Xero seamlessly integrates Xero data into database management tools like DBArtisan by enabling you to access Xero data as a database. This article shows how to create a JDBC source for Xero in DBArtisan. You can then edit data visually and execute standard SQL.

Getting Started

---

Integrate Xero Data into DBArtisan Projects

Follow the steps below to register Xero data as a database instance in your project:

1. In DBArtisan, click Data Source -> Register Datasource.
2. Select Generic JDBC.
3. Click Manage.
4. In the resulting dialog, click New. Enter a name for the driver and click Add. In the resulting dialog, navigate to the driver JAR. The driver JAR is located in the lib subfolder of the installation directory. 👁 The JDBC driver definition in the Register Datasource wizard. (Salesforce is shown.)
   
5. In the Connection URL box, enter credentials and other required connection properties in the JDBC URL.

   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.

   👁 Required JDBC connection properties in the Register Datasource wizard. (Salesforce is shown.)
   

   Below is a typical connection string:

   jdbc:xero:InitiateOAuth=GETANDREFRESH;

6. Finish the wizard to connect to Xero data. Xero entities are displayed in the Datasource Explorer.

You can now work with Xero data as you work with any other database. See the driver help documentation for more information on the queries supported by the Xero API.