Ready to get started?

Learn more about the CData JDBC Driver for Xero WorkflowMax or download a free trial:

Download Now

Analyze Xero WorkflowMax Data in R

Use standard R functions and the development environment of your choice to analyze Xero WorkflowMax data with the CData JDBC Driver for Xero WorkflowMax.

Access Xero WorkflowMax data with pure R script and standard SQL on any machine where R and Java can be installed. You can use the CData JDBC Driver for Xero WorkflowMax and the RJDBC package to work with remote Xero WorkflowMax data in R. By using the CData Driver, you are leveraging a driver written for industry-proven standards to access your data in the popular, open-source R language. This article shows how to use the driver to execute SQL queries to Xero WorkflowMax and visualize Xero WorkflowMax data by calling standard R functions.

Install R

You can match the driver's performance gains from multi-threading and managed code by running the multithreaded Microsoft R Open or by running open R linked with the BLAS/LAPACK libraries. This article uses Microsoft R Open 3.2.3, which is preconfigured to install packages from the Jan. 1, 2016 snapshot of the CRAN repository. This snapshot ensures reproducibility.

Load the RJDBC Package

To use the driver, download the RJDBC package. After installing the RJDBC package, the following line loads the package:

library(RJDBC)

Connect to Xero WorkflowMax as a JDBC Data Source

You will need the following information to connect to Xero WorkflowMax as a JDBC data source:

  • Driver Class: Set this to cdata.jdbc.xeroworkflowmax.XeroWorkflowMaxDriver
  • Classpath: Set this to the location of the driver JAR. By default this is the lib subfolder of the installation folder.

The DBI functions, such as dbConnect and dbSendQuery, provide a unified interface for writing data access code in R. Use the following line to initialize a DBI driver that can make JDBC requests to the CData JDBC Driver for Xero WorkflowMax:

driver <- JDBC(driverClass = "cdata.jdbc.xeroworkflowmax.XeroWorkflowMaxDriver", classPath = "MyInstallationDir\lib\cdata.jdbc.xeroworkflowmax.jar", identifier.quote = "'")

You can now use DBI functions to connect to Xero WorkflowMax and execute SQL queries. Initialize the JDBC connection with the dbConnect function.

To connect to the WorkflowMax API, obtain an APIKey and AccountKey from Xero. This can only be done by contacting Xero support (https://www.workflowmax.com/contact-us).

After obtaining an API Key and Account Key, set the values in the APIKey and AccountKey connection properties. Once these are set, you are ready to connect.

Built-in Connection String Designer

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

java -jar cdata.jdbc.xeroworkflowmax.jar

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

Below is a sample dbConnect call, including a typical JDBC connection string:

conn <- dbConnect(driver,"jdbc:xeroworkflowmax:APIKey=myApiKey;AccountKey=myAccountKey;")

Schema Discovery

The driver models Xero WorkflowMax APIs as relational tables, views, and stored procedures. Use the following line to retrieve the list of tables:

dbListTables(conn)

Execute SQL Queries

You can use the dbGetQuery function to execute any SQL query supported by the Xero WorkflowMax API:

clients <- dbGetQuery(conn,"SELECT Id, Name FROM Clients WHERE Name = 'Cynthia'")

You can view the results in a data viewer window with the following command:

View(clients)

Plot Xero WorkflowMax Data

You can now analyze Xero WorkflowMax data with any of the data visualization packages available in the CRAN repository. You can create simple bar plots with the built-in bar plot function:

par(las=2,ps=10,mar=c(5,15,4,2)) barplot(clients$Name, main="Xero WorkflowMax Clients", names.arg = clients$Id, horiz=TRUE)