DataBind Charts to Xero WorkflowMax Data

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Xero WorkflowMax ADO.NET Provider

Rapidly create and deploy powerful .NET applications that integrate with Xero WorkflowMax.



Use the standard ADO.NET procedures for databinding to provide bidirectional access to Xero WorkflowMax data from controls in the Visual Studio toolbox. This article demonstrates a graphical approach using wizards in Visual Studio, as well as how to databind with only a few lines of code.

DataBinding enables bidirectional access to data from UI controls. You can use the CData ADO.NET Provider for Xero WorkflowMax to easily databind Xero WorkflowMax data to Windows Forms and Web controls in Visual Studio. This article shows how to use wizards to databind Xero WorkflowMax data to a chart that reflects any changes. The code walk-through section shows how to create a chart in 10 lines of code.

DataBind to a Chart

DataBinding consists of three steps: Instantiate the control, configure the data source, and databind.

Configure the Connection and Select Database Objects

Follow the procedure below to use the Data Source Configuration Wizard to create a chart control and the connection to Xero WorkflowMax. In the wizard, you can select the Xero WorkflowMax entities you want to databind.

  1. In a Windows Forms project, drag and drop a Chart control from the toolbox to the form. In the Data section of the Chart properties, select DataSource and then select Add Project Data Source from the menu.
  2. In the Data Source Configuration Wizard that appears, select Database -> Dataset.
  3. In the Choose Your Data Connection step, click New Connection.
  4. In the Add Connection dialog, click Change to select the CData Xero WorkflowMax Data Source.

    Below is a typical connection string:

    APIKey=myApiKey;AccountKey=myAccountKey;

    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.

    When you configure the connection, 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.

  5. Choose the database objects you want to work with. This example uses the Clients table.

DataBind

After adding the data source and selecting database objects, you can bind the objects to the chart. This example assigns the x-axis to Id and the y-axis to Name.

  1. In the Chart properties, click the button in the Series property to open the Series Collection Editor.
  2. In the Series properties, select the columns you want for the x- and y-axes: Select columns from the menu in the XValueMember and YValueMember properties.

The chart is now databound to the Xero WorkflowMax data. Run the chart to display the current data.

Code Walk-through

DataBinding to Xero WorkflowMax data requires only a few lines of code and can be completed in three easy steps.

  1. Connect to Xero WorkflowMax.
  2. Create the XeroWorkflowMaxDataAdapter to execute the query and create a DataSet to be filled with its results.
  3. DataBind the result set to the chart.

Below is the complete code:

XeroWorkflowMaxConnection conn = new XeroWorkflowMaxConnection("APIKey=myApiKey;AccountKey=myAccountKey;"); XeroWorkflowMaxCommand comm = new XeroWorkflowMaxCommand("SELECT Id, Name FROM Clients WHERE Name = 'Cynthia'", conn); XeroWorkflowMaxDataAdapter da = new XeroWorkflowMaxDataAdapter(comm); DataSet dataset = new DataSet(); da.Fill(dataset); chart1.DataSource = dataset; chart1.Series[0].XValueMember = "Id"; chart1.Series[0].YValueMembers = "Name"; // Insert code for additional chart formatting here. chart1.DataBind();