Ready to get started?

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

Download Now

Connect to Xero Data from PowerBuilder

This article demonstrates how to use the CData ODBC Driver for Xero to connect to Xero data and execute queries in PowerBuilder.

The CData ODBC Driver for Xero can be used from any platform or development technology that supports ODBC, including PowerBuilder. This article shows how to connect to Xero data and execute queries from the Database Painter and controls such as the DataWindow.

Connect to Xero as an ODBC Data Source

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, set the Schema connection property in addition to any authentication values. Xero offers authentication for private applications, public applications, and partner applications. You will need to set the XeroAppAuthentication property to PUBLIC, PRIVATE, or PARTNER, depending on the type of application configured. To connect from a private application, you will additionally need to set the OAuthAccessToken, OAuthClientId, OAuthClientSecret, CertificateStoreType, CertificateStore, and CertificateStorePassword.

To connect from a public or partner application, you can use the embedded OAuthClientId, OAuthClientSecret, and CallbackURL, or you can register an app to obtain your own OAuth values.

See the "Getting Started" chapter of the help documentation for a guide to authenticating to Xero.

Create a Profile for the ODBC Driver for Xero

Follow the steps below to use the Database Painter tool to create a database profile based on an ODBC DSN (data source name) for Xero. In the Database Painter, you can use wizards and the UI to work with Xero data.

  1. In PowerBuilder, click Tools -> Database Painter.
  2. In the Objects window in the Database Painter, right-click the ODBC node and click New Profile.
  3. On the Connection tab, enter a name for the profile and select the Xero DSN in the Data Source menu.
  4. To view and modify a table, right-click a table and then click Edit Data -> Grid.

Using Xero Data with PowerBuilder Controls

You can use standard PowerBuilder objects to connect to ODBC data sources and execute queries. The following example shows how to retrieve Xero data into a DataWindow. You can add the following code to the open method:

SQLCA.DBMS = "ODBC" SQLCA.DBParm = "ConnectString='DSN=CData Xero Source'" CONNECT USING SQLCA; dw_items.SetTransObject(SQLCA); dw_items.Retrieve();