Access Xero WorkflowMax Data as a Remote Oracle Database

Ready to get started?

Download for a free trial:

Download Now

Learn more:

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.



Use the Oracle ODBC Gateway and Heterogeneous Services technology to access Xero WorkflowMax data from your Oracle system.

The Oracle Database Gateway for ODBC and Heterogeneous Services technology enable you to connect to ODBC data sources as remote Oracle databases. This article shows how to use the CData ODBC Driver for Xero WorkflowMax to create a database link from Xero WorkflowMax to Oracle and to query Xero WorkflowMax data through the SQL*Plus tool. You can also create the database link and execute queries from SQL Developer.

Connect to Xero WorkflowMax as an ODBC Data Source

Information for connecting to Xero WorkflowMax follows, along with different instructions for configuring a DSN in Windows and Linux environments.

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.

Windows

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.

Note: If you need to modify the DSN or create other Xero WorkflowMax DSNs, you must use a system DSN and the bitness of the DSN must match your Oracle system. You can access and create 32-bit DSNs on a 64-bit system by opening the 32-bit ODBC Data Source Administrator from C:\Windows\SysWOW64\odbcad32.exe.

Linux

If you are installing the CData ODBC Driver for Xero WorkflowMax in a Linux environment, the driver installation predefines a system DSN. You can modify the DSN by editing the system data sources file (/etc/odbc.ini) and defining the required connection properties.

/etc/odbc.ini

[CData XeroWorkflowMax Source] Driver = CData ODBC Driver for Xero WorkflowMax Description = My Description APIKey = myApiKey AccountKey = myAccountKey

For specific information on using these configuration files, please refer to the help documentation (installed and found online).

Set Connection Properties for Compatibility with Oracle

The driver provides several connection properties that streamline accessing Xero WorkflowMax data just as you would an Oracle database. Set the following properties when working with Xero WorkflowMax data in SQL*Plus and SQL Developer. For compatibility with Oracle, you will need to set the following connection properties, in addition to authentication and other required connection properties.

  • MapToWVarchar=False

    Set this property to map string data types to SQL_VARCHAR instead of SQL_WVARCHAR. By default, the driver uses SQL_WVARCHAR to accommodate various international character sets. You can use this property to avoid the ORA-28528 Heterogeneous Services data type conversion error when the Unicode type is returned.

  • MaximumColumnSize=4000

    Set this property to restrict the maximum column size to 4000 characters.

  • IncludeDualTable=True

    Set this property to mock the Oracle DUAL table. SQL Developer uses this table to test the connection.

Linux Configuration

In Linux environments, Oracle uses UTF-8 to communicate with the unixODBC Driver manager, whereas the default driver encoding is UTF-16. To resolve this, open the file /opt/cdata/cdata-driver-for-xeroworkflowmax/lib/cdata.odbc.xeroworkflowmax.ini in a text editor and set the encoding.

cdata.odbc.xeroworkflowmax.ini

[Driver] DriverManagerEncoding = UTF-8

Configure the ODBC Gateway, Oracle Net, and Oracle Database

Follow the procedure below to set up an ODBC gateway to Xero WorkflowMax data that enables you to query live Xero WorkflowMax data as an Oracle database.

  1. Create the file initmyworkflowmaxdb.ora in the folder oracle-home-directory/hs/admin and add the following setting:

    initmyworkflowmaxdb.ora

    HS_FDS_CONNECT_INFO = "CData XeroWorkflowMax Sys"
  2. Add an entry to the listener.ora file. This file is located in oracle-home-directory/NETWORK/admin.

    If you are using the Database Gateway for ODBC, your listener.ora needs to have a SID_LIST_LISTENER entry that resembles the following:

    listener.ora

    SID_LIST_LISTENER = (SID_LIST = (SID_DESC = (SID_NAME = myworkflowmaxdb) (ORACLE_HOME = your-oracle-home) (PROGRAM = dg4odbc) ) )

    If you are using Heterogeneous Services, your listener.ora needs to have a SID_LIST_LISTENER entry that resembles the following:

    listener.ora

    SID_LIST_LISTENER = (SID_LIST = (SID_DESC = (SID_NAME = myworkflowmaxdb) (ORACLE_HOME = your-oracle-home) (PROGRAM = hsodbc) ) )
  3. Add the connect descriptor below in tnsnames.ora, located in oracle-home-directory/NETWORK/admin:

    tnsnames.ora

    myworkflowmaxdb = (DESCRIPTION= (ADDRESS=(PROTOCOL=tcp)(HOST=localhost)(PORT=1521)) (CONNECT_DATA=(SID=myworkflowmaxdb)) (HS=OK) )
  4. Restart the listener.
  5. Test the configuration with the following command:

    tnsping myworkflowmaxdb
  6. Open SQL*Plus and create the database link with the command below:

    CREATE DATABASE LINK myworkflowmaxdb CONNECT TO "user" IDENTIFIED BY "password" USING 'myworkflowmaxdb';

You can now execute queries in SQL*Plus like the one below (note the double quotation marks around the table name):

SELECT * from "Clients"@myworkflowmaxdb WHERE Name = 'Cynthia';