Ready to get started?

Download a free trial of the Xero WorkflowMax Data Provider to get started:

 Download Now

Learn more:

Xero WorkflowMax Icon Xero WorkflowMax ADO.NET Provider

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

Back Up Xero WorkflowMax data to SQL Server through SSIS



Effortlessly backup data to SQL Server by utilizing the CData ADO.NET Provider for Xero WorkflowMax. In this article, we will employ an SSIS workflow to populate a database with Xero WorkflowMax data data.

This article illustrates using the Xero WorkflowMax ADO.NET Data Provider within a SQL Server SSIS workflow for the direct transfer of Xero WorkflowMax data to a Microsoft SQL Server database. It's worth noting that the identical process detailed below is applicable to any CData ADO.NET Data Providers, enabling the direct connection of SQL Server with remote data through SSIS.

  1. Open Visual Studio and create a new Integration Services project.
  2. Add a new Data Flow task from the toolbox onto the Control Flow screen.
  3. In the Data Flow screen, add an ADO.NET Source and an OLE DB Destination from the toolbox.

  4. Add a new connection and select .NET Providers\CData ADO.NET Provider for Xero WorkflowMax.
  5. In the connection manager, enter the connection details for Xero WorkflowMax data.

    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.

  6. Open the DataReader editor and set the following information:

    • ADO.NET connection manager: In the Connection Managers menu, select the Data Connection you just created.
    • Data access mode: Select 'SQL command'.
    • SQL command text: In the DataReader Source editor, open the Component Properties tab and enter a SELECT command, such as the one below:

      SELECT Id, Name FROM Clients WHERE Name = 'Cynthia'

  7. Close the DataReader editor and drag the arrow below the DataReader Source to connect it to the OLE DB Destination.
  8. Open the OLE DB Destination and enter the following information in the Destination Component Editor.

    • Connection manager: Add a new connection. Enter your server and database information here. In this example, SQLExpress is running on a separate machine.
    • Data access mode: Set your data access mode to "table or view" and select the table or view to populate in your database.
  9. Configure any properties you wish on the Mappings screen.

  10. Close the OLE DB Destination Editor and run the project. After the SSIS task has finished executing, your database will be populated with data obtained from Xero WorkflowMax data.