JDBC Driver for Xero WorkflowMax

Build 22.0.8462

Establishing a Connection

Creating a JDBC Data Source

You can create a JDBC data source to connect from your Java application. Creating a JDBC data source based on the CData JDBC Driver for Xero WorkflowMax consists of three basic steps:

  • Add the driver JAR file to the classpath. The JAR file is located in the lib subfolder of the installation directory. Note that the .lic file must be located in the same folder as the JAR file.
  • Provide the driver class. For example:
    cdata.jdbc.xeroworkflowmax.XeroWorkflowMaxDriver
  • Provide the JDBC URL. For example:
    jdbc:xeroworkflowmax:OAuthClientID=myClientID;OAuthClientSecret=myClientSecret
    
    or
    
    jdbc:cdata:xeroworkflowmax:OAuthClientID=myClientID;OAuthClientSecret=myClientSecret

    The second format above can be used whenever there is a conflict in your application between drivers using the same URL format to ensure you are using the CData driver. The URL must start with either "jdbc:xeroworkflowmax:" or "jdbc:cdata:xeroworkflowmax:" and can include any of the connection properties in name-value pairs separated with semicolons.

Connecting to Xero WorkflowMax

OAuth

Use the OAuth authentication standard to connect to Xero WorkflowMax API. You can authenticate with a user account. The driver facilitates this as described below. See Using OAuth Authentication for an authentication guide.

User Accounts

The user account flow requires the authenticating user to interact with Xero WorkflowMax via the browser.

Custom Credentials

Since connecting with embedded credentials is deprecated, you must register an app to obtain the OAuthClientId and OAuthClientSecret.

Creating a Custom OAuth App

See Creating a Custom OAuth App for a procedure.

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8462