Use Dash to Build to Web Apps on Xero WorkflowMax Data

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Xero WorkflowMax Python Connector

Python Connector Libraries for Xero WorkflowMax Data Connectivity. Integrate Xero WorkflowMax with popular Python tools like Pandas, SQLAlchemy, Dash & petl.



The CData Python Connector for Xero WorkflowMax enables you to create Python applications that use pandas and Dash to build Xero WorkflowMax-connected web apps.

The rich ecosystem of Python modules lets you get to work quickly and integrate your systems more effectively. With the CData Python Connector for Xero WorkflowMax, the pandas module, and the Dash framework, you can build Xero WorkflowMax-connected web applications for Xero WorkflowMax data. This article shows how to connect to Xero WorkflowMax with the CData Connector and use pandas and Dash to build a simple web app for visualizing Xero WorkflowMax data.

With built-in, optimized data processing, the CData Python Connector offers unmatched performance for interacting with live Xero WorkflowMax data in Python. When you issue complex SQL queries from Xero WorkflowMax, the driver pushes supported SQL operations, like filters and aggregations, directly to Xero WorkflowMax and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations).

Connecting to Xero WorkflowMax Data

Connecting to Xero WorkflowMax data looks just like connecting to any relational data source. Create a connection string using the required connection properties. For this article, you will pass the connection string as a parameter to the create_engine 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.

After installing the CData Xero WorkflowMax Connector, follow the procedure below to install the other required modules and start accessing Xero WorkflowMax through Python objects.

Install Required Modules

Use the pip utility to install the required modules and frameworks:

pip install pandas
pip install dash
pip install dash-daq

Visualize Xero WorkflowMax Data in Python

Once the required modules and frameworks are installed, we are ready to build our web app. Code snippets follow, but the full source code is available at the end of the article.

First, be sure to import the modules (including the CData Connector) with the following:

import os
import dash
import dash_core_components as dcc
import dash_html_components as html
import pandas as pd
import cdata.xeroworkflowmax as mod
import plotly.graph_objs as go

You can now connect with a connection string. Use the connect function for the CData Xero WorkflowMax Connector to create a connection for working with Xero WorkflowMax data.

cnxn = mod.connect("APIKey=myApiKey;AccountKey=myAccountKey;")

Execute SQL to Xero WorkflowMax

Use the read_sql function from pandas to execute any SQL statement and store the result set in a DataFrame.

df = pd.read_sql("SELECT Id, Name FROM Clients WHERE Name = 'Cynthia'", cnxn)

Configure the Web App

With the query results stored in a DataFrame, we can begin configuring the web app, assigning a name, stylesheet, and title.

app_name = 'dash-xeroworkflowmaxedataplot'

external_stylesheets = ['https://codepen.io/chriddyp/pen/bWLwgP.css']

app = dash.Dash(__name__, external_stylesheets=external_stylesheets)
app.title = 'CData + Dash'

Configure the Layout

The next step is to create a bar graph based on our Xero WorkflowMax data and configure the app layout.

trace = go.Bar(x=df.Id, y=df.Name, name='Id')

app.layout = html.Div(children=[html.H1("CData Extension + Dash", style={'textAlign': 'center'}),
	dcc.Graph(
		id='example-graph',
		figure={
			'data': [trace],
			'layout':
			go.Layout(title='Xero WorkflowMax Clients Data', barmode='stack')
		})
], className="container")

Set the App to Run

With the connection, app, and layout configured, we are ready to run the app. The last lines of Python code follow.

if __name__ == '__main__':
    app.run_server(debug=True)

Now, use Python to run the web app and a browser to view the Xero WorkflowMax data.

python xeroworkflowmax-dash.py

Free Trial & More Information

Download a free, 30-day trial of the Xero WorkflowMax Python Connector to start building Python apps with connectivity to Xero WorkflowMax data. Reach out to our Support Team if you have any questions.



Full Source Code

import os
import dash
import dash_core_components as dcc
import dash_html_components as html
import pandas as pd
import cdata.xeroworkflowmax as mod
import plotly.graph_objs as go

cnxn = mod.connect("APIKey=myApiKey;AccountKey=myAccountKey;")

df = pd.read_sql("SELECT Id, Name FROM Clients WHERE Name = 'Cynthia'", cnxn)
app_name = 'dash-xeroworkflowmaxdataplot'

external_stylesheets = ['https://codepen.io/chriddyp/pen/bWLwgP.css']

app = dash.Dash(__name__, external_stylesheets=external_stylesheets)
app.title = 'CData + Dash'
trace = go.Bar(x=df.Id, y=df.Name, name='Id')

app.layout = html.Div(children=[html.H1("CData Extension + Dash", style={'textAlign': 'center'}),
	dcc.Graph(
		id='example-graph',
		figure={
			'data': [trace],
			'layout':
			go.Layout(title='Xero WorkflowMax Clients Data', barmode='stack')
		})
], className="container")

if __name__ == '__main__':
    app.run_server(debug=True)