Learn more
 

Ready to get started?

Download a free trial of the Xero WorkflowMax ODBC Driver to get started:

 Download Now

Learn more:

Xero WorkflowMax Icon Xero WorkflowMax ODBC Driver

The Xero WorkflowMax ODBC Driver is a powerful tool that allows you to connect with live data from Xero WorkflowMax, directly from any applications that support ODBC connectivity.

Access Xero WorkflowMax data like you would a database - read, write, and update Xero WorkflowMax Clients, Jobs, Leads, Quotes, etc. through a standard ODBC Driver interface.

In this article

Related articles

DataBind Controls to Xero WorkflowMax Data in C++Builder


DataBind to Xero WorkflowMax data in C++Builder with standard components and controls.

The CData ODBC Driver for Xero WorkflowMax makes it easy to integrate connectivity to live Xero WorkflowMax data with standard data access components in C++Builder. This article shows how to create a simple visual component library (VCL) application in C++Builder that connects to Xero WorkflowMax data, executes queries, and displays the results in a grid. An additional section shows how to use FireDAC components to execute commands from code.

Create a Connection to Xero WorkflowMax Data

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

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.

You can then follow the steps below to use the Data Explorer to create a FireDAC connection to Xero WorkflowMax.

  1. In a new VCL Forms application, expand the FireDAC node in the Data Explorer.
  2. Right-click the ODBC Data Source node in the Data Explorer.
  3. Click Add New Connection.
  4. Enter a name for the connection.
  5. In the FireDAC Connection Editor that appears, set the DataSource property to the name of the ODBC DSN for Xero WorkflowMax.

Create VCL Applications with Connectivity to Xero WorkflowMax Data

Follow the procedure below to start querying Xero WorkflowMax data from a simple VCL application that displays the results of a query in a grid.

  1. Drop a TFDConnection component onto the form and set the following properties:

    • ConnectionDefName: Select the FireDAC connection to Xero WorkflowMax.
    • Connected: Select True from the menu and, in the dialog that appears, enter your credentials.

  2. Drop a TFDQuery component onto the form and set the properties below:

    • Connection: Set this property to the TFDConnection component, if this component is not already specified.

    • SQL: Click the button in the SQL property and enter a query. For example:

      SELECT Id, Name FROM Clients WHERE Name = 'Cynthia'
    • Active: Set this property to true.

  3. Drop a TDataSource component onto the form and set the following property:

    • DataSet: In the menu for this property, select the name of the TFDQuery component.

  4. Drop a TDBGrid control onto the form and set the following property:

    • DataSource: Select the name of the TDataSource.
  5. Drop a TFDGUIxWaitCursor onto the form — this is required to avoid a run-time error.

Execute Commands to Xero WorkflowMax with FireDAC Components

You can use the TFDConnection and TFQuery components to execute queries to Xero WorkflowMax data. This section provides Xero WorkflowMax-specific examples of executing queries with the TFQuery component.

Connect to Xero WorkflowMax Data

To connect to the data source, set the Connected property of the TFDConnection component to true. You can set the same properties from code:

FDConnection1->ConnectionDefName = "CData Xero WorkflowMax ODBC Source"; FDConnection1->Connected = true;

To connect the TFDQuery component to Xero WorkflowMax data, set the Connection property of the component. When a TFDQuery component is added at design time, its Connection property is automatically set to point to a TFDConnection on the form, as in the application above.

Create Parameterized Queries

To create a parameterized query, use the following syntax below:

FDQuery1->SQL->Text = "select * from Clients where name = :Name"; FDQuery1->ParamByName("name")->AsString = "Cynthia"; query->Open();

The example above binds a string-type input parameter by name and then opens the dataset that results.

Prepare the Statement

Preparing statements is costly in system resources and time. The connection must be active and open while a statement is prepared. By default, FireDAC prepares the query to avoid recompiling the same query over and over. To disable statement preparation, set ResourceOptions.DirectExecute to True; for example, when you need to execute a query only once.

Execute a Query

To execute a query that returns a result set, such as a select query, use the Open method. The Open method executes the query, returns the result set, and opens it. The Open method will return an error if the query does not produce a result set.

FDQuery1->SQL->Text := "select * from Clients where name = :Name"; FDQuery1.ParamByName("name")->AsString = "Cynthia"; FDQuery1->Open();

To execute a query that does not return a result set, use the ExecSQL method. The ExecSQL method will return an error if the query returns a result set. To retrieve the count of affected rows use the TFD.RowsAffected property.

FDQ.SQL.Text := "delete from Clients where Id = :Id"; FDQuery1->Params->Items[0]->AsString = "x12345"; FDQuery1->ExecSQL(); AnsiString i = FDQuery1->RowsAffected;