Xero WorkflowMax Connection Details¶

Introduction¶

Connector Version

This documentation is based on version 23.0.8804 of the connector.

Get Started¶

Xero WorkflowMax Version Support

The connector leverages the XeroWorkflowMax API to enable bidirectional access to XeroWorkflowMax.

Establish a Connection¶

Connect to Xero WorkflowMax¶

Use the OAuth authentication standard to connect to Xero WorkflowMax API and authenticate with a user account from the Web, a Desktop, or a

Headless Server. This requires you to set AuthScheme to OAuth, and to create and register a custom OAuth application.

The following subsections describe how to authenticate to Xero WorkflowMax from the three common authentication flows. For information about how to create a custom OAuth application, see Creating a Custom OAuth Application. For a complete list of connection string properties available in Xero WorkflowMax, see Connection.

Desktop Applications¶

To authenticate with the credentials for a custom OAuth application, you must get and refresh the OAuth access token. After you do that, you are ready to connect.

Get and refresh the OAuth access token:

• InitiateOAuth = GETANDREFRESH. Used to automatically get and refresh the OAuthAccessToken.
• OAuthClientId = the client ID assigned when you registered your application.
• OAuthClientSecret = the client secret that was assigned when you registered your application.
• CallbackURL = the redirect URI that was defined when you registered your application.

When you connect, the connector opens Xero WorkflowMax's OAuth endpoint in your default browser. Log in and grant permissions to the application.

After you grant permissions to the application, the connector then completes the OAuth process:

1. The connector obtains an access token from Xero WorkflowMax and uses it to request data.
2. The OAuth values are saved in the path specified in OAuthSettingsLocation. These values persist across connections.

When the access token expires, the connector refreshes it automatically.

Automatic refresh of the OAuth access token:

To have the connector automatically refresh the OAuth access token, do the following:

1. Before connecting to data for the first time, set the following connection parameters:
   • InitiateOAuth = REFRESH.
   • OAuthClientId = the client ID in your application settings.
   • OAuthClientSecret = the client secret in your application settings.
   • OAuthAccessToken = the access token returned by GetOAuthAccessToken.
   • OAuthSettingsLocation = the path where you want the connector to save the OAuth values, which persist across connections.
2. On subsequent data connections, set the following:
   • InitiateOAuth
   • OAuthSettingsLocation

Manual refresh of the OAuth access token:

The only value needed to manually refresh the OAuth access token is the OAuth refresh token.

1. To manually refresh the OAuthAccessToken after the ExpiresIn period (returned by GetOAuthAccessToken) has elapsed, call the RefreshOAuthAccessToken stored procedure.
2. Set the following connection properties:
   • OAuthClientId = the Client ID in your application settings.
   • OAuthClientSecret = the Client Secret in your application settings.
3. Call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken.
4. After the new tokens have been retrieved, set the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken. This opens a new connection.

Store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

Create a Custom OAuth Application¶

Create a Custom OAuth Application¶

Creating a custom OAuth application entails setting up and registering the application in the Xero WorkflowMax App Manager, and assigning Staff Privilege permissions to appropriate co-workers.

Create the Custom OAuth Application¶

This procedure obtains the OAuth client credentials, the Client ID, and Client Secret:

1. Go to Xero WorkflowMax App Manager.

2. At the top right corner of the page, click New App.

3. Select Web App.

4. Add the redirect URL to OAuth 2.0 redirect URI field. Enter http://localhost:33333 (the callback URL), or

   choose a different port number if desired.

5. Fill the other form fields as desired.

6. Click Create App.

7. Click Save. Xero WorkflowMax directs you to the new web page for your custom OAuth application.

8. Scroll to the bottom of the page to find the Client ID.

9. To create your Client Secret, click Generate a secret.

Assign "Authorise 3rd Party Access" Permissions¶

A new privilege, "Authorise 3rdc Party Access", helps control the proliferation of access by third-party software, to the Xero WorkflowMax server. Any employee with Administrator privileges (who can probably already connect such software to your server) can assign this new privilege to

themselves or other Administrators.

privileges.

For each employee who should have the ability to authorize access to third party addons, do the following:

1. Go to Xero WorkflowMax Staff Settings

2. Search for the employee whose permissions should be edited.

3. Click the employee's name.

4. If the employee does not already have Administrator privileges, navigate to Admin Privileges and assign them

   now. Xero WorkflowMax redirects you to the Staff Settings page, where you must choose this employee again.

5. Scroll to the bottom of the page and find API Access Privileges.

6. Select Authorise 3rd Party Full Access.

7. Click Save.

Important Notes¶

Configuration Files and Their Paths¶

• All references to adding configuration files and their paths refer to files and locations on the Harmony Agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.

Advanced Features¶

This section details a selection of advanced features of the Xero WorkflowMax connector.

User Defined Views

The connector allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Proxy

To configure the connector using Private Agent proxy settings, select the Use Proxy Settings checkbox on the connection configuration screen.

Query Processing

The connector offloads as much of the SELECT statement processing as possible to Xero WorkflowMax and then processes the rest of the query in memory (client-side).

User Defined Views¶

The Xero WorkflowMax connector allows you to define a virtual table whose contents are decided by a pre-configured query. These are called User Defined Views, which are useful in situations where you cannot directly control the query being issued to the driver, e.g. when using the driver from Jitterbit. The User Defined Views can be used to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.

There are two ways to create user defined views:

• Create a JSON-formatted configuration file defining the views you want.
• DDL statements.

Define Views Using a Configuration File¶

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.

This User Defined View configuration file is formatted as follows:

• Each root element defines the name of a view.
• Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
    "MyView": {
        "query": "SELECT * FROM Clients WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

Define Views Using DDL Statements¶

The connector is also capable of creating and altering the schema via DDL Statements such as CREATE LOCAL VIEW, ALTER LOCAL VIEW, and DROP LOCAL VIEW.

Create a View¶

To create a new view using DDL statements, provide the view name and query as follows:

CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;

If no JSON file exists, the above code creates one. The view is then created in the JSON configuration file and is now discoverable. The JSON file location is specified by the UserDefinedViews connection property.

Alter a View¶

To alter an existing view, provide the name of an existing view alongside the new query you would like to use instead:

ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';

The view is then updated in the JSON configuration file.

Drop a View¶

To drop an existing view, provide the name of an existing schema alongside the new query you would like to use instead.

DROP LOCAL VIEW [MyViewName]

This removes the view from the JSON configuration file. It can no longer be queried.

Schema for User Defined Views¶

User Defined Views are exposed in the UserViews schema by default. This is done to avoid the view's name clashing with an actual entity in the data model. You can change the name of the schema used for UserViews by setting the UserViewsSchemaName property.

Work with User Defined Views¶

For example, a SQL statement with a User Defined View called UserViews.RCustomers only lists customers in Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

An example of a query to the driver:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Resulting in the effective query to the source:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

That is a very simple example of a query to a User Defined View that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.

SSL Configuration¶

Customize the SSL Configuration¶

By default, the connector attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Data Model¶

Overview

This section shows the available API objects and provides more information on executing SQL to Xero WorkflowMax APIs.

Key Features

• The connector models Xero WorkflowMax entities like Clients, Suppliers, and Jobs as relational views, allowing you to write SQL to query Xero WorkflowMax data.
• Stored procedures allow you to execute operations to Xero WorkflowMax.
• Live connectivity to these objects means any changes to your Xero WorkflowMax account are immediately reflected when using the connector.

Custom Fields

The XeroWOrkflowMax driver supports custom fields. To be able to retrieve and update custom fields IncludeCustomFields must be set as a connection property. Remember that the driver will be slow when getting custom fields as it fetches them one by one. To improve performance try to specify the ID of the resource you are trying to query.

Tables¶

The connector models the data in Xero WorkflowMax as a list of tables in a relational database that can be queried using standard SQL statements.

Xero WorkflowMax Connector Tables¶

ClientContacts¶

Return a list of all contacts of clients.

Select¶

The connector will use the Xero WorkflowMax API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the driver. Specifically, the following are processed server-side:

• UUID supports the = operator.

All filterable columns allow multiple values to be specified by using the IN operator. Response time from the server can be improved by identifying only the rows you want to retrieve.

SELECT * FROM ClientContacts WHERE UUID = '3cfb9bd0-dac7-40d0-8fb7-db8e23d14bd9'
SELECT * FROM ClientContacts WHERE UUID IN ('3cfb9bd0-dac7-40d0-8fb7-db8e23d14bd9', 'd807cf4c-a2b9-428a-82e7-124b4f3ddab4')

Insert¶

ClientUUID and Name are required to insert. The following query creates a new ClientContact:

INSERT INTO ClientContacts (ClientUUID, Name) VALUES ('c6ec5c2c-2657-4ce3-b035-022c02b9f19e', 'Rambo')

Update¶

You can update a ClientContact by specifying the ClientContact UUID:

UPDATE ClientContacts SET Name = 'Arnold' WHERE UUID = '3cfb9bd0-dac7-40d0-8fb7-db8e23d14bd9'

Delete¶

Delete a ClientContact by specifying the ClientContact UUID:

DELETE FROM ClientContacts WHERE UUID = '3cfb9bd0-dac7-40d0-8fb7-db8e23d14bd9'

Columns¶

ClientGroups¶

Return a list of all client groups

Select¶

The connector will use the Xero WorkflowMax API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the driver. Specifically, the following are processed server-side:

• UUID supports the = operator.

All filterable columns allow multiple values to be specified by using the IN operator. Response time from the server can be improved by identifying only the rows you want to retrieve.

SELECT * FROM ClientGroups WHERE UUID = '3cfb9bd0-dac7-40d0-8fb7-db8e23d14bd9'
SELECT * FROM ClientGroups WHERE UUID IN ('c6ec5c2c-2657-4ce3-b035-022c02b9f19e', '5a92d62b-089f-4d28-a4d2-c69692edc41a')

Insert¶

ClientUUID and Name are required to insert. The following query creates a new ClientGroup:

INSERT INTO ClientGroups (Name, ClientUUID, Taxable) VALUES ('Clients', '446ddb14-4084-48fc-83bd-76b89125450a', true)

Delete¶

Delete a ClientGroup by specifying the ClientGroup UUID:

DELETE FROM ClientGroups WHERE UUID = 'c6ec5c2c-2657-4ce3-b035-022c02b9f19e'

Columns¶

Clients¶

Return a list of all clients.

Select¶

The connector will use the Xero WorkflowMax API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the driver. Specifically, the following are processed server-side:

• UUID supports the = operator.
• Name supports 'CONTAINS'.

UUID column allow multiple values to be specified by using the IN operator. Response time from the server can be improved by identifying only the rows you want to retrieve.

SELECT * FROM Clients WHERE UUID = '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
SELECT * FROM Clients WHERE UUID IN ('9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '446ddb14-4084-48fc-83bd-76b89125450a')
SELECT * FROM Clients WHERE CONTAINS (Name, 'Brian')
SELECT * FROM Clients WHERE ModifiedSince = '2012-06-05T06:00:00'

Insert¶

Name is required to insert. The following query creates a new Clients:

INSERT INTO Clients (Name) VALUES ('some name')

Update¶

You can update by specifying the Clients UUID:

UPDATE Clients SET Name = 'Arnold' WHERE UUID = '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'

Delete¶

Delete a Client by specifying the Client UUID:

DELETE FROM Clients WHERE UUID = '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'

Archive a Client by specifying the Client UUID and setting Archive=true:

DELETE FROM Clients WHERE UUID = '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2' AND Archive = true

Columns¶

Pseudo-Columns¶

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Costs¶

Return a list of all costs

Select¶

The connector will use the Xero WorkflowMax API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the driver. Specifically, the following are processed server-side:

• UUID supports the = operator.

All filterable columns allow multiple values to be specified by using the IN operator. Response time from the server can be improved by identifying only the rows you want to retrieve.

SELECT * FROM Costs WHERE UUID = '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
SELECT * FROM Costs WHERE UUID IN ('9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '9d382fcf-7013-4d97-8dd8-c08e8b26av43')

Insert¶

Description, UnitPrice, UnitCost are required to insert. The following query creates a new Cost:

INSERT INTO Costs (Description, UnitPrice, UnitCost) VALUES ('decr', 100, 200)

Update¶

You can update a Cost by specifying the Cost UUID:

UPDATE Costs SET UnitPrice = '101' WHERE UUID = '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'

Delete¶

Delete a Cost by specifying the Cost UUID:

DELETE FROM Costs WHERE UUID = '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'

Columns¶

JobCosts¶

Return a list of all costs of jobs.

Select¶

Note: Because of Xero WorkflowMax API restrictions the Job ID filters will not work properly while using custom Job numbers which have punctuation in them. This is a known issue that Xero refuses to fix. Please change the Job number so there is no punctuation and try again.

In case you are using custom Job numbers with punctuation in them you may encounter 404 Not Found error in Jobs and JobCosts tables.

The connector will use the Xero WorkflowMax API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the driver. Specifically, the following are processed server-side:

• JobID supports the = operator.

All filterable columns allow multiple values to be specified by using the IN operator. Response time from the server can be improved by identifying only the rows you want to retrieve.

SELECT * FROM JobCosts WHERE JobID = 'J000002'
SELECT * FROM JobCosts WHERE JobID IN ('J000001', 'J000002')

Insert¶

JobID, Date, Description, Quantity, UnitCost, UnitPrice are required to insert. The following query creates a new JobCost:

INSERT INTO JobCosts (JobID, Date, Description, Quantity, UnitCost, UnitPrice) VALUES ('J000002', '2019-07-17T00:00:00', 'Maybach', '123', 30, 50)

Columns¶

JobNotes¶

Return a list of all notes of a job

Select¶

The connector will process all filters client side.

Insert¶

JobID, Title, Text are required to insert. The following query creates a new JobNote:

INSERT INTO JobNotes (JobID, Title, Text) VALUES ('J000001', '133193699', 'some notes')

Columns¶

Jobs¶

Return a list of all jobs.

Select¶

Note: Because of Xero WorkflowMax API restrictions the Job ID filters will not work properly while using custom Job numbers which have punctuation in them. This is a known issue that Xero refuses to fix. Please change the Job number so there is no punctuation and try again.

In case you are using custom Job numbers with punctuation in them you may encounter 404 Not Found error in Jobs and JobCosts tables.

The connector will use the Xero WorkflowMax API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the driver. Specifically, the following are processed server-side:

• Id supports the = operator.
• AssignedStaffUUID supports the = operator.
• ClientUUID supports the = operator.
• CreatedDate supports the '<=,<,=,>,>=' operators.

All filterable columns allow multiple values to be specified by using the IN operator. Response time from the server can be improved by identifying only the rows you want to retrieve.

SELECT * FROM Jobs WHERE CreatedDate >= '2020-12-12' AND CreatedDate <= '2020-12-12'
SELECT * FROM Jobs WHERE CreatedDate = '2020-12-12'
SELECT * FROM Jobs WHERE CreatedDate >= '2020-12-12'
SELECT * FROM Jobs WHERE ID = 'J000001'
SELECT * FROM Jobs WHERE AssignedStaffUUID = '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
SELECT * FROM Jobs WHERE ClientUUID = '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
SELECT * FROM Jobs WHERE ID IN ('23423', '34534')
SELECT * FROM Jobs WHERE AssignedStaffUUID IN ('9d382fcf-7013-4d97-8dd8-c08e8b26a8f6', '9d382fcf-7013-4d97-8dd8-c08e8b26a4d2')
SELECT * FROM Jobs WHERE ClientUUID IN ('9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '9d382fcf-7013-4d97-8dd8-c08e8b26a6i1')

Notes:

-When executing a simple SELECT * query the connector will retrieve only your current Invoices.
-When specifying CreatedDate the connector will retrieve the current and archived Jobs.

Insert¶

Name, ClientUUID, StartDate, DueDate are required to insert. The following query creates a new Job:

INSERT INTO Jobs (Name, ClientUUID, StartDate, DueDate) VALUES ('Job Name', '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '2019-07-17T00:00:00', '2019-07-17T00:00:00')

Update¶

You can update by specifying the Job ID:

UPDATE Jobs SET StartDate = '2007-07-16T00:00:00' WHERE ID = 'J000003'

Delete¶

Delete a Job by specifying the Job ID:

DELETE FROM Jobs WHERE ID = 'J000003'

Columns¶

Pseudo-Columns¶

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

JobTasks¶

Return a list of all tasks of jobs.

Select¶

The connector will use the Xero WorkflowMax API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the driver. Specifically, the following are processed server-side:

• Complete supports the = operator.
• CreatedDate supports the '<=,<,=,>,>=' operators.

SELECT * FROM JobTasks WHERE Complete = False
SELECT * FROM JobTasks WHERE CreatedDate >= '2000-11-11' AND CreatedDate <= '2020-11-11'
SELECT * FROM JobTasks WHERE CreatedDate = '2000-11-11'
SELECT * FROM JobTasks WHERE CreatedDate >= '2000-11-11'
SELECT * FROM JobTasks WHERE CreatedDate >= '2000-11-11' AND CreatedDate <= '2020-11-11' AND Complete = true

Insert¶

EstimatedMinutes, TaskID, JobID, Name, StartDate, DueDate are required to insert. The following query creates a new JobTask:

INSERT INTO JobTasks (EstimatedMinutes, TaskUUID, JobID, Name, StartDate, DueDate) VALUES ('100', '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', 'J000002', '21910642', '2019-07-17T00:00:00', '2019-07-17T00:00:00')

Columns¶

Leads¶

Return a list of all leads.

Select¶

The connector will use the Xero WorkflowMax API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the driver. Specifically, the following are processed server-side:

• UUID supports the = operator.
• CreatedDate supports the '<=,<,=,>,>=' operators.

All filterable columns allow multiple values to be specified by using the IN operator. Response time from the server can be improved by identifying only the rows you want to retrieve.

SELECT * FROM Leads WHERE UUID = '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
SELECT * FROM Leads WHERE CreatedDate >= '2000-12-12' AND CreatedDate <= '2020-12-12'
SELECT * FROM Leads WHERE CreatedDate = '2000-12-12'
SELECT * FROM Leads WHERE CreatedDate >= '2000-12-12'
SELECT * FROM Leads WHERE UUID IN ('9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '9d382fcf-7013-4d97-8dd8-c08e8b26a5k9')

Notes:

-When executing a simple SELECT * query the connector will retrieve only your current Leads.
-When specifying CreatedDate the connector will retrieve all Leads.

Insert¶

Name, ClientUUID, OwnerID are required to insert. The following query creates a new Lead:

INSERT INTO Leads (Name, ClientUUID, OwnerUUID) VALUES ('hey', '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '9d382fcf-7013-4d97-8dd8-c08e8b26a3f7')

Columns¶

PurchaseOrderDrafts¶

Return a list of all draft purchase orders

Select¶

The connector will process all filters client side.

Insert¶

To insert into PurchaseOrderDrafts you will need to insert temporary at least one PurchaseOrderCost which will serve as items for the PurchaseOrder. You can do that by denoting the table name as PurchaseOrderCosts#TEMP. After inserting to the temporary table you can execute an insert to PurchaseOrders by setting PurchaseOrderCosts = PurchaseOrderCosts#TEMP as in the query below. JobID, SupplierUUID, Date, PurchaseOrderCosts are required to insert. The following queries are needed to create a new PurchaseOrder with 2 PurchaseOrderCost items:

INSERT INTO PurchaseOrderCosts#TEMP (Description, Quantity, UnitCost, Code, Note) VALUES ('first', 4, 50, '123', 'note')
INSERT INTO PurchaseOrderCosts#TEMP (Description, Quantity, UnitCost, Code, Note) VALUES ('second', 42, 502, '1234', 'note2')
INSERT INTO PurchaseOrderDrafts (JobID, SupplierUUID, Date, PurchaseOrderCosts) VALUES ('J000002', '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '2019-07-17T00:00:00', 'PurchaseOrderCosts#TEMP')

Alternatively you can execute an INSERT operation on PurchaseOrder by setting the value for PurchaseOrderCosts as a xml string of items in the following structure:

<Item>
<UnitCost>50</UnitCost>
<Description>first</Description>
<Quantity>4</Quantity>
<Code>123</Code>
<Note>note</Note>
</Item>
<Item>
<UnitCost>502</UnitCost>
<Description>second</Description>
<Quantity>42</Quantity>
<Code>1234</Code>
<Note>note2</Note>
</Item>

Columns¶

PurchaseOrders¶

Return a list of all purchase orders

Select¶

The connector will use the Xero WorkflowMax API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the driver. Specifically, the following are processed server-side:

• Id supports the = operator.
• JobID supports the = operator.
• CreatedDate supports the '<=,<,=,>,>=' operators.

All filterable columns allow multiple values to be specified by using the IN operator. Response time from the server can be improved by identifying only the rows you want to retrieve.

SELECT * FROM PurchaseOrders WHERE ID = '2512811'
SELECT * FROM PurchaseOrders WHERE CreatedDate >= '2000-12-12' AND CreatedDate <= '2020-12-12'
SELECT * FROM PurchaseOrders WHERE CreatedDate = '2000-12-12'
SELECT * FROM PurchaseOrders WHERE CreatedDate >= '2000-12-12'
SELECT * FROM PurchaseOrders WHERE ID IN ('23423', '34534')
SELECT * FROM PurchaseOrders WHERE JobID IN ('23423', '34534')

Notes:

-When executing a simple SELECT * query the connector will retrieve only your current PurchaseOrders.
-When specifying CreatedDate the connector will retrieve the current and archived PurchaseOrders.

Insert¶

To insert into PurchaseOrders you will need to insert temporary at least one PurchaseOrderCost which will serve as items for the PurchaseOrder. You can do that by denoting the table name as PurchaseOrderCosts#TEMP. After inserting to the temporary table you can execute an insert to PurchaseOrders by setting PurchaseOrderCosts = PurchaseOrderCosts#TEMP as in the query below. JobID, SupplierUUID, Date, PurchaseOrderCosts are required to insert. The following queries are needed to create a new PurchaseOrder with 2 PurchaseOrderCost items:

INSERT INTO PurchaseOrderCosts#TEMP (Description, Quantity, UnitCost, Code, Note) VALUES ('first', 4, 50, '123', 'note')
INSERT INTO PurchaseOrderCosts#TEMP (Description, Quantity, UnitCost, Code, Note) VALUES ('second', 42, 502, '1234', 'note2')
INSERT INTO PurchaseOrders (JobID, SupplierUUID, Date, PurchaseOrderCosts) VALUES ('J000002', '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '2019-07-17T00:00:00', 'PurchaseOrderCosts#TEMP')

Alternatively you can execute an INSERT operation on PurchaseOrder by setting the value for PurchaseOrderCosts as a xml string of items in the following structure:

<Item>
<UnitCost>50</UnitCost>
<Description>first</Description>
<Quantity>4</Quantity>
<Code>123</Code>
<Note>note</Note>
</Item>
<Item>
<UnitCost>502</UnitCost>
<Description>second</Description>
<Quantity>42</Quantity>
<Code>1234</Code>
<Note>note2</Note>
</Item>

Columns¶

StaffList¶

Return a list of all staff members

Select¶

The connector will use the Xero WorkflowMax API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the driver. Specifically, the following are processed server-side:

• UUID supports the = operator.

All filterable columns allow multiple values to be specified by using the IN operator. Response time from the server can be improved by identifying only the rows you want to retrieve.

SELECT * FROM StaffList WHERE UUID = '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
SELECT * FROM StaffList WHERE UUID IN ('9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '9d382fcf-7013-4d97-8dd8-c08e8b26a9f6')

Insert¶

Name is required to insert. The following query creates a new StaffList member:

INSERT INTO StaffList (Name) VALUES ('J000002')

Update¶

You can update a Staff member by specifying the Staff member UUID:

UPDATE StaffList SET Email = 'hey@gmail.com', Phone = '23489235' WHERE UUID = '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'

Delete¶

Delete a Staff member by specifying the Staff member UUID:

DELETE FROM StaffList WHERE UUID = '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'

Columns¶

SupplierContacts¶

Return a list of all suppliers.

Select¶

The connector will use the Xero WorkflowMax API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the driver. Specifically, the following are processed server-side:

• UUID supports the = operator.

All filterable columns allow multiple values to be specified by using the IN operator. Response time from the server can be improved by identifying only the rows you want to retrieve.

SELECT * FROM SupplierContacts WHERE UUID IN ('9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '9d382fcf-7013-4d97-8dd8-c08e8b26a5hj')
SELECT * FROM SupplierContacts WHERE UUID = '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'

Insert¶

SupplierUUID, Name are required to insert. The following query creates a new SupplierContact:

INSERT INTO SupplierContacts (SupplierUUID, Name) VALUES ('9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', 'ckemi')

Update¶

You can update a SupplierContact by specifying the SupplierContact UUID:

UPDATE SupplierContacts SET Name = 'hey@gmail.com', Mobile = '23489235' WHERE UUID = '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'

Columns¶

Suppliers¶

Return a list of all suppliers.

Select¶

The connector will use the Xero WorkflowMax API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the driver. Specifically, the following are processed server-side:

• UUID supports the = operator.

All filterable columns allow multiple values to be specified by using the IN operator. Response time from the server can be improved by identifying only the rows you want to retrieve.

SELECT * FROM Suppliers WHERE UUID = '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
SELECT * FROM Suppliers WHERE UUID IN ('9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '9d382fcf-7013-4d97-8dd8-c08e8b26a3f7')

Insert¶

Name is required to insert. The following query creates a new Supplier:

INSERT INTO Suppliers (Name) VALUES ('Arnold')

Update¶

You can update by specifying the UUID:

UPDATE Suppliers SET Address = 'hey@hey.com', City = '23489235' WHERE UUID = '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'

Delete¶

Delete a Supplier by specifying the Supplier UUID:

DELETE FROM Suppliers WHERE UUID = '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'

Archive a Supplier by specifying the Supplier UUID and setting Archive=true in the query:

DELETE FROM Suppliers WHERE UUID = '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2' AND Archive = true

Columns¶

Pseudo-Columns¶

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Times¶

Return a list of all time sheets.

Select¶

The connector will use the Xero WorkflowMax API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the driver. Specifically, the following are processed server-side:

The connector will use the Xero WorkflowMax API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the driver. Specifically, the following are processed server-side:

• UUID supports the = operator.
• JobID supports the = operator.
• StaffID supports the = operator.
• CreatedDate supports the '<=,<,=,>,>=' operators.

All filterable columns allow multiple values to be specified by using the IN operator. Response time from the server can be improved by identifying only the rows you want to retrieve.

SELECT * FROM Times WHERE JobID = 'J000001'
SELECT * FROM Times WHERE UUID = '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
SELECT * FROM Times WHERE CreatedDate >= '2018-12-12' AND CreatedDate <= '2020-12-12'
SELECT * FROM Times WHERE StaffUUID = '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2' AND CreatedDate >= '2018-12-12' AND CreatedDate <= '2020-12-12'
SELECT * FROM Times WHERE UUID IN ('9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '9d382fcf-7013-4d97-8dd8-c08e8b26g3h2')
SELECT * FROM Times WHERE StaffUUID IN ('9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '9d382fcf-7013-4d97-8dd8-c08e8b26g3h2')
SELECT * FROM Times WHERE JobID IN ('J000001', 'J000002')

Insert¶

JobID, TaskID, StaffID, Date, Minutes are required to insert. The following query creates a new Time entry:

INSERT INTO Times (JobID, TaskUUID, StaffUUID, Date, Minutes) VALUES ('J000001', '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '9d382fcf-7013-4d97-8dd8-c08e8b26a5e8', '2019-06-27T00:00:00', '240')

Update¶

You can update by specifying the UUID:

UPDATE Times SET Date = '2019-06-27T00:00:00', Minutes = '240' WHERE UUID = '250193564'

Delete¶

Delete a Time entry by specifying the UUID:

DELETE FROM Times WHERE UUID = '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'

Columns¶

Views¶

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

Xero WorkflowMax Connector Views¶

Categories¶

Return a list of all categories

Select¶

The connector will process all filters client side.

Columns¶

ClientDocuments¶

Return a list of all documents of the clients.

Select¶

The connector will use the Xero WorkflowMax API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the driver. Specifically, the following are processed server-side:

• ClientUUID supports the = operator.

To execute a SELECT query to ClientDocuments you must provide the ClientUUID as a WHERE condition. Specifically, the following are processed server-side:

SELECT * FROM ClientDocuments WHERE ClientUUID = '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'

All filterable columns allow multiple values to be specified by using the IN operator. Response time from the server can be improved by identifying only the rows you want to retrieve.

SELECT * FROM ClientDocuments WHERE ClientUUID IN ('9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '446ddb14-4084-48fc-83bd-76b89125450a')

Columns¶

ClientNotes¶

Return all notes of clients

Select¶

The connector will process all filters client side.

Columns¶

InvoiceDrafts¶

Return a list of draft invoices

Select¶

The connector will process all filters client side.

Columns¶

InvoicePayments¶

Return a list of invoice payments

Select¶

The connector will process all filters client side.

Columns¶

Invoices¶

Return a list of invoices

Select¶

The connector will use the Xero WorkflowMax API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the driver. Specifically, the following are processed server-side:

• CreatedDate supports the '<=,<,=,>,>=' operators.

All filterable columns allow multiple values to be specified by using the IN operator. Response time from the server can be improved by identifying only the rows you want to retrieve.

SELECT * FROM Invoices WHERE CreatedDate >= '2019-08-07' AND CreatedDate <= '2019-08-07'
SELECT * FROM Invoices WHERE CreatedDate >= '2019-08-07'
SELECT * FROM Invoices WHERE CreatedDate = '2019-08-07'

Notes:

-When executing a simple SELECT * query the connector will retrieve only your current Invoices.
-When specifying CreatedFrom and CreatedTo the connector will retrieve the current and archived Invoices.

Columns¶

InvoicesJobTask¶

Return a list of invoices related to Tasks.

Select¶

The connector will process all filters client side except InvoiceID.

SELECT * FROM InvoicesJobTask WHERE InvoiceID = 'I000123'
SELECT * FROM InvoicesJobTask WHERE InvoiceID IN ('I000124', 'I000123')

Columns¶

JobDocuments¶

Return a list of all documents of a job

Select¶

The connector will use the Xero WorkflowMax API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the driver. Specifically, the following are processed server-side:

• JobID supports the = operator.

All filterable columns allow multiple values to be specified by using the IN operator. Response time from the server can be improved by identifying only the rows you want to retrieve.

SELECT * FROM JobDocuments WHERE JobID = 'J000001'
SELECT * FROM JobDocuments WHERE JobID IN ('23423', '34534')

Columns¶

JobMilestones¶

Return all milestones of jobs

Select¶

The connector will process all filters client side.

Columns¶

LeadCategories¶

Return a list of lead categories

Select¶

The connector will process all filters client side.

Columns¶

PurchaseOrderCosts¶

Return all purchase order costs

Select¶

The connector will process all filters client side.

Insert¶

Description, Quantity, UnitCost, Code, Note are required to insert into the temporary table. The following query creates a new PurchaseOrderCost entry in memory:

INSERT INTO PurchaseOrderCosts#TEMP (Description, Quantity, UnitCost, Code, Note) VALUES ('hey descr', 4, 50, '123', 'note')

After inserting to PurchaseOrderCosts#TEMP, you have all the items you need to insert the PurchaseOrder. See PurchaseOrders for more details on inserting to Purchase Orders.

Columns¶

QuoteDrafts¶

Return a list of all draft quotes

Select¶

The connector will process all filters client side.

Columns¶

Quotes¶

Return a list of all quotes

Select¶

The connector will use the Xero WorkflowMax API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the driver. Specifically, the following are processed server-side:

• Id supports the = operator.
• CreatedDate supports the '<=,<,=,>,>=' operators.

All filterable columns except CreatedDate allow multiple values to be specified by using the IN operator. Response time from the server can be improved by identifying only the rows you want to retrieve.

SELECT * FROM Quotes WHERE ID = 'Q000001'
SELECT * FROM Quotes WHERE CreatedDate >= '2000-12-12' AND CreatedDate <= '2020-12-12'
SELECT * FROM Quotes WHERE CreatedDate = '2000-12-12'
SELECT * FROM Quotes WHERE CreatedDate >= '2000-12-12'
SELECT * FROM Quotes WHERE ID IN ('Q000001', 'Q000002')

Notes:

-When executing a simple SELECT * query the connector will retrieve only your current Quotes.
-When specifying CreatedDate the connector will retrieve the current and archived Quotes.

Columns¶

QuotesCost¶

Return a list of quotes related to costs.

Select¶

The connector will process all filters client side except QuoteID.

SELECT * FROM QuotesCost WHERE QuoteID = 'Q000123'
SELECT * FROM QuotesCost WHERE QuoteID IN ('Q000124', 'Q000123')

Columns¶

QuotesOption¶

Return a list of quotes related to options.

Select¶

The connector will process all filters client side except QuoteID.

SELECT * FROM QuotesOption WHERE QuoteID = 'Q000123'
SELECT * FROM QuotesOption WHERE QuoteID IN ('Q000124', 'Q000123')

Columns¶

QuotesTask¶

Return a list of quotes related to Tasks.

Select¶

The connector will process all filters client side except QuoteID.

SELECT * FROM QuotesTask WHERE QuoteID = 'Q000123'
SELECT * FROM QuotesTask WHERE QuoteID IN ('Q000124', 'Q000123')

Columns¶

Tasks¶

Return a list of all tasks

Select¶

The connector will use the Xero WorkflowMax API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the driver. Specifically, the following are processed server-side:

• UUID supports the = operator.

All filterable columns allow multiple values to be specified by using the IN operator. Response time from the server can be improved by identifying only the rows you want to retrieve.

SELECT * FROM Tasks WHERE UUID = '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
SELECT * FROM Tasks WHERE UUID IN ('9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '9d382fcf-7013-4d97-8dd8-c08e8b26a6g9')

Columns¶

Templates¶

Return a list of all templates

Select¶

The connector will process all filters client side.

Columns¶

Stored Procedures¶

Stored procedures are function-like interfaces that extend the functionality of the connector beyond simple SELECT/INSERT/UPDATE/DELETE operations with Xero WorkflowMax.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Xero WorkflowMax, along with an indication of whether the procedure succeeded or failed.

Xero WorkflowMax Connector Stored Procedures¶

ApplyJobTemplate¶

Apply an additional template to a job

Input¶

Result Set Columns¶

ChangeJobStatus¶

Used to change job status

Input¶

Result Set Columns¶

ChangeTaskStatus¶

Used to change task status completed or opened

Input¶

Result Set Columns¶

CreateJobEstimate¶

Used to create a job estimate

Input¶

Result Set Columns¶

CreateJobQuote¶

Used to create a job quote.

Input¶

Result Set Columns¶

DeleteAllCosts¶

Used to delete all costs.

Result Set Columns¶

GetOAuthAccessToken¶

Gets an authentication token from Xero WorkflowMax.

Input¶

Result Set Columns¶

GetOAuthAuthorizationURL¶

Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps. You will request the OAuthAccessToken from this URL.

Input¶

Result Set Columns¶

ManageClientGroupMembers¶

Manage the members of a client group

Input¶

Result Set Columns¶

ManageJobMembers¶

Manage the members of a job.

Input¶

Result Set Columns¶

ManageStaffLogin¶

Enable or disable staff members login.

Input¶

Result Set Columns¶

ManageTaskStaff¶

Manage the staff members of a task

Input¶

Result Set Columns¶

RefreshOAuthAccessToken¶

Refreshes the OAuth access token used for authentication with various Basecamp services.

Input¶

Result Set Columns¶

UploadClientDocument¶

Upload a document to a Client

Input¶

Result Set Columns¶

UploadJobDocument¶

Upload a document to a Job

Input¶

Result Set Columns¶

System Tables¶

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables¶

The following tables return database metadata for Xero WorkflowMax:

• sys_catalogs: Lists the available databases.
• sys_schemas: Lists the available schemas.
• sys_tables: Lists the available tables and views.
• sys_tablecolumns: Describes the columns of the available tables and views.
• sys_procedures: Describes the available stored procedures.
• sys_procedureparameters: Describes stored procedure parameters.
• sys_keycolumns: Describes the primary and foreign keys.
• sys_indexes: Describes the available indexes.

Data Source Tables¶

The following tables return information about how to connect to and query the data source:

• sys_connection_props: Returns information on the available connection properties.
• sys_sqlinfo: Describes the SELECT queries that the connector can offload to the data source.

Query Information Tables¶

The following table returns query statistics for data modification queries:

• sys_identity: Returns information about batch operations or single updates.

sys_catalogs¶

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns¶

sys_schemas¶

Lists the available schemas.

The following query retrieves all available schemas:

SELECT * FROM sys_schemas

Columns¶

sys_tables¶

Lists the available tables.

The following query retrieves the available tables and views:

SELECT * FROM sys_tables

Columns¶

sys_tablecolumns¶

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Clients table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Clients'

Columns¶

sys_procedures¶

Lists the available stored procedures.

The following query retrieves the available stored procedures:

SELECT * FROM sys_procedures

Columns¶

sys_procedureparameters¶

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the CreateJobEstimate stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='CreateJobEstimate' AND Direction=1 OR Direction=2

Columns¶

sys_keycolumns¶

Describes the primary and foreign keys.

The following query retrieves the primary key for the Clients table:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Clients'

Columns¶

sys_foreignkeys¶

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

Columns¶

sys_primarykeys¶

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

SELECT * FROM sys_primarykeys

Columns¶

sys_indexes¶

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

SELECT * FROM sys_indexes WHERE IsPrimary='false'

Columns¶

sys_connection_props¶

Returns information on the available connection properties and those set in the connection string.

When querying this table, the config connection string should be used:

jdbc:cdata:xeroworkflowmax:config:

This connection string enables you to query this table without a valid connection.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns¶

sys_sqlinfo¶

Describes the SELECT query processing that the connector can offload to the data source.

Discovering the Data Source's SELECT Capabilities¶

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns¶

sys_identity¶

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

SELECT * FROM sys_identity

Columns¶

Advanced Configurations Properties¶

The advanced configurations properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure. Click the links for further details.

OAuth

SSL

Schema

Miscellaneous

OAuth¶

This section provides a complete list of OAuth properties you can configure.

InitiateOAuth¶

Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.

Possible Values¶

OFF, GETANDREFRESH, REFRESH

Data Type¶

string

Default Value¶

OFF

Remarks¶

The following options are available:

1. OFF: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.
2. GETANDREFRESH: Indicates that the entire OAuth Flow will be handled by the connector. If no token currently exists, it will be obtained by prompting the user via the browser. If a token exists, it will be refreshed when applicable.
3. REFRESH: Indicates that the connector will only handle refreshing the OAuthAccessToken. The user will never be prompted by the connector to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.

OAuthClientId¶

The client ID assigned when you register your application with an OAuth authorization server.

Data Type¶

string

Default Value¶

""

Remarks¶

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

OAuthClientSecret¶

The client secret assigned when you register your application with an OAuth authorization server.

Data Type¶

string

Default Value¶

""

Remarks¶

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

OAuthAccessToken¶

The access token for connecting using OAuth.

Data Type¶

string

Default Value¶

""

Remarks¶

The OAuthAccessToken property is used to connect using OAuth. The OAuthAccessToken is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.

The access token is used in place of your user name and password. The access token protects your credentials by keeping them on the server.

TenantId¶

Xero Workflow Max Tenant ID.

Data Type¶

string

Default Value¶

""

Remarks¶

If for any reason you are trying to use an AccessToken to authenticate you should note that the Xero authentication requires a tenant ID to be passed as a header for each API Request.

Retrieve the TenantId using the GetOAuthAccessToken stored procedure.

Alternatively, you may retrieve the TenantId as follows:

1. Create a new request in an API Development tool like Postman.
2. Set the URL to https://api.xero.com/connections
3. Set Authorization header to "Bearer " + access_token and finally execute the request.
4. The response will show 1 or more connection informations to Xero.
5. Find the connection which has "tenantType": "WORKFLOWMAX" and get its TenantId.
6. Set this connection property to the newly acquired TenantId.

OAuthSettingsLocation¶

The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'.

Data Type¶

string

Default Value¶

%APPDATA%\CData\Acumatica Data Provider\OAuthSettings.txt

Remarks¶

When InitiateOAuth is set to GETANDREFRESH or REFRESH, the driver saves OAuth values to avoid requiring the user to manually enter OAuth connection properties and to allow the credentials to be shared across connections or processes.

Instead of specifying a file path, you can use memory storage. Memory locations are specified by using a value starting with 'memory://' followed by a unique identifier for that set of credentials (for example, memory://user1). The identifier can be anything you choose but should be unique to the user. Unlike file-based storage, where credentials persist across connections, memory storage loads the credentials into static memory, and the credentials are shared between connections using the same identifier for the life of the process. To persist credentials outside the current process, you must manually store the credentials prior to closing the connection. This enables you to set them in the connection when the process is started again. You can retrieve OAuth property values with a query to the sys_connection_props system table. If there are multiple connections using the same credentials, the properties are read from the previously closed connection.

The default location is "%APPDATA%\CData\Acumatica Data Provider\OAuthSettings.txt" with %APPDATA% set to the user's configuration directory. The default values are

• Windows: "register://%DSN"
• Unix: "%AppData%..."

where DSN is the name of the current DSN used in the open connection.

The following table lists the value of %APPDATA% by OS:

CallbackURL¶

The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.

Data Type¶

string

Default Value¶

""

Remarks¶

During the authentication process, the OAuth authorization server redirects the user to this URL. This value must match the callback URL you specify in your app settings.

OAuthVerifier¶

The verifier code returned from the OAuth authorization URL.

Data Type¶

string

Default Value¶

""

Remarks¶

The verifier code returned from the OAuth authorization URL. This can be used on systems where a browser cannot be launched such as headless systems.

Authentication on Headless Machines¶

See to obtain the OAuthVerifier value.

Set OAuthSettingsLocation along with OAuthVerifier. When you connect, the connector exchanges the OAuthVerifier for the OAuth authentication tokens and saves them, encrypted, to the specified location. Set InitiateOAuth to GETANDREFRESH to automate the exchange.

Once the OAuth settings file has been generated, you can remove OAuthVerifier from the connection properties and connect with OAuthSettingsLocation set.

To automatically refresh the OAuth token values, set OAuthSettingsLocation and additionally set InitiateOAuth to REFRESH.

OAuthRefreshToken¶

The OAuth refresh token for the corresponding OAuth access token.

Data Type¶

string

Default Value¶

""

Remarks¶

The OAuthRefreshToken property is used to refresh the OAuthAccessToken when using OAuth authentication.

OAuthExpiresIn¶

The lifetime in seconds of the OAuth AccessToken.

Data Type¶

string

Default Value¶

""

Remarks¶

Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.

OAuthTokenTimestamp¶

The Unix epoch timestamp in milliseconds when the current Access Token was created.

Data Type¶

string

Default Value¶

""

Remarks¶

Pair with OAuthExpiresIn to determine when the AccessToken will expire.

SSL¶

This section provides a complete list of SSL properties you can configure.

SSLServerCert¶

The certificate to be accepted from the server when connecting using TLS/SSL.

Data Type¶

string

Default Value¶

""

Remarks¶

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

If not specified, any certificate trusted by the machine is accepted.

Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

Schema¶

This section provides a complete list of schema properties you can configure.

Location¶

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Data Type¶

string

Default Value¶

%APPDATA%\XeroWorkflowMax Data Provider\Schema

Remarks¶

The path to a directory which contains the schema files for the connector (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is "%APPDATA%\XeroWorkflowMax Data Provider\Schema" with %APPDATA% being set to the user's configuration directory:

BrowsableSchemas¶

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Data Type¶

string

Default Value¶

""

Remarks¶

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

Tables¶

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Data Type¶

string

Default Value¶

""

Remarks¶

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the connector.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Views¶

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Data Type¶

string

Default Value¶

""

Remarks¶

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the connector.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Miscellaneous¶

This section provides a complete list of miscellaneous properties you can configure.

IncludeCustomFields¶

Determines if Custom Fields should be included as table columns or not. Including CustomFields will impact the performance.

Data Type¶

bool

Default Value¶

false

Remarks¶

It is possible to create custom fields in Xero WorkflowMax. To retrieve their values you can set IncludeCustomFields=true as a connection property. Doing so will list the custom fields created as table columns. These custom fields can also be updated for ex.

UPDATE Costs SET CF_1='new CF value' WHERE ID='CostID'

Note: You can still update custom fields even when a specific table doesn't support UPDATE operation.

Custom Fields are very expensive. They require one request per record to retrieve. For this reason, they are disabled by default.

MaxRows¶

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Data Type¶

int

Default Value¶

-1

Remarks¶

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Other¶

These hidden properties are used only in specific use cases.

Data Type¶

string

Default Value¶

""

Remarks¶

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting¶

PseudoColumns¶

This property indicates whether or not to include pseudo columns as columns to the table.

Data Type¶

string

Default Value¶

""

Remarks¶

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

Timeout¶

The value in seconds until the timeout error is thrown, canceling the operation.

Data Type¶

int

Default Value¶

60

Remarks¶

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the connector throws an exception.

UserDefinedViews¶

A filepath pointing to the JSON configuration file containing your custom views.

Data Type¶

string

Default Value¶

""

Remarks¶

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.

This User Defined View configuration file is formatted as follows:

• Each root element defines the name of a view.
• Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
    "MyView": {
        "query": "SELECT * FROM Clients WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json

Note that the specified path is not embedded in quotation marks.