Adding a Connection to Xero WorkflowMax

To add a connection to Xero WorkflowMax:

1. In the application console, navigate to the Connections page.
2. At the Add Connections panel, select the icon for the connection you want to add.
3. If the Xero WorkflowMax icon is not available, click the Add More icon to download and install the Xero WorkflowMax connector from the CData site.

For required properties, see the Settings tab.

For connection properties that are not typically required, see the Advanced tab.

Connecting 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.

Automatic refresh of the OAuth access token:

To have the Sync App 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 Sync App 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.

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

User Defined Views

The Sync App 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 Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

The Sync App 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).

See Query Processing for more information.

Logging

See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.

Customizing the SSL Configuration

By default, the Sync App 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.

Connecting Through a Firewall or Proxy

HTTP Proxies

To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.

In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.

Other Proxies

Set the following properties:

• To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
• To tunnel the connection, set FirewallType to TUNNEL.
• To authenticate, specify FirewallUser and FirewallPassword.
• To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

Overview

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

Key Features

• The Sync App 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 Sync App.

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.

The Sync App 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 for CData Sync Tables

Name	Description
ClientContacts	Return a list of all contacts of clients.
ClientGroups	Return a list of all client groups
Clients	Return a list of all clients.
Costs	Return a list of all costs
JobCosts	Return a list of all costs of jobs.
JobNotes	Return a list of all notes of a job
Jobs	Return a list of all jobs.
JobTasks	Return a list of all tasks of jobs.
Leads	Return a list of all leads.
PurchaseOrderDrafts	Return a list of all draft purchase orders
PurchaseOrders	Return a list of all purchase orders
StaffList	Return a list of all staff members
SupplierContacts	Return a list of all suppliers.
Suppliers	Return a list of all suppliers.
Times	Return a list of all time sheets.

Return a list of all contacts of clients.

Select

The Sync App 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

Name	Type	ReadOnly	Description
ClientUUID	String	False	The ID of the client
UUID [KEY]	String	True	The id of the contact which belongs to the client
Name	String	False	The name of the contact
Mobile	String	False	Mobile number of the contact
Email	String	False	Email of the contact
Phone	String	False	Phone number of the contact
Position	String	False	The position of the contact
Salutation	String	False	Salutation is used following 'Dear...
Addressee	String	False	The addresse of the contact
IsPrimary	String	False	Determines if this contact is the main contact used by client Yes | No

Return a list of all client groups

Select

The Sync App 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

Name	Type	ReadOnly	Description
UUID [KEY]	String	True	The Id of the client group
Name	String	False	The name of the client group
Taxable	String	False	Optional taxable group setting for Practice Manager users
ClientUUID	String	False	Used for creating a ClientGroup as it is required to put at least one client denoted by their Client ID.

Return a list of all clients.

Select

The Sync App 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

Name	Type	ReadOnly	Description
UUID [KEY]	String	True	The Id of the client.
Name	String	False	The name of the client.
Email	String	False	The email of the client.
Address	String	False	The address of the client.
City	String	False	The city where the client is located.
Region	String	False	The region where the client is located.
PostCode	String	False	The postal code of where the client is located.
Country	String	False	The country where the client is located.
PostalAddress	String	False	The address of the postal office.
PostalCity	String	False	The city where the postal office is located.
PostalRegion	String	False	The region where the postal office is located.
PostalPostCode	String	False	The postal code of the postal office.
PostalCountry	String	False	The country where the postal office is located.
Phone	String	False	The phone number of the client.
Fax	String	False	The fax number of the client.
Website	String	False	The website associated with the client.
ReferralSource	String	False	Source the client was referred by.
ExportCode	String	False	The export code (such as an account code / tax code) associated with the client.
IsProspect	String	False	Determines if the client is a potential customer
AccountManagerUUID	String	False	Optional - ID of staff member.
AccountManagerName	String	True	Name of staff member.
TypeName	String	True	The type of client
TypeCostMarkup	String	True	The markup % of the type of client
TypePaymentTerm	String	True	The payment terms of the type of client
TypePaymentDay	String	True	The payment day / number of days of the type of client
FirstName	String	False	Optional for individuals, firstname of the individual
LastName	String	False	Optional for individuals, LastName of the individual
OtherName	String	False	Optional for individuals, OtherName of the individual
DateOfBirth	Datetime	False	Optional for individuals, date of birth of the individual
BillingClientUUID	String	False	Used in cases where the client is different than the billing client.
BillingClientName	String	False	Billing client name.
JobManagerUUID	String	False	optional - ID of staff member
JobManagerName	String	True	Name of staff member.
TaxNumber	String	False	Identifying number used for tax purposes
CompanyNumber	String	False	The company registration number.
BusinessNumber	String	False	Name of Business Structure (as per Admin)
BalanceMonth	String	False	e.g. Jan, 1, Feb, 2, Mar, 3 etc
PrepareGST	String	False	Yes or No
GSTRegistered	String	False	Yes or No
GSTPeriod	String	False	1, 2, 6
GSTBasis	String	False	Invoice, Payment, Hybrid
ProvisionalTaxBasis	String	False	Standard Option, Estimate Option, Ratio Option
ProvisionalTaxRatio	String	False	Tax ratio for the client when the Ratio option is selected for ProvisionalTaxBasis.
SignedTaxAuthority	String	False	Yes or No (NZ clients only)
TaxAgent	String	False	Name of Tax Agent (as per Admin) (NZ clients only)
AgencyStatus	String	False	With EOT, Without EOT, Unlinked (NZ clients only)
ReturnType	String	False	IR3, IR3NR, IR4, IR6, IR7, IR9, PTS (NZ clients only)
PrepareActivityStatement	String	False	Yes or No (AU clients only)
PrepareTaxReturn	String	False	Yes or No (AU clients only)

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.

Name	Type	Description
ModifiedSince	String	Used for filtering clients from their last time modified.
Archive	Boolean	Used for archiving a Client not deleting it completely

Return a list of all costs

Select

The Sync App 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

Name	Type	ReadOnly	Description
UUID [KEY]	String	True	The Id of the Cost.
Description	String	False	The description related to the cost.
Code	String	False	The code of the unit.
Note	String	False	The note related to the cost.
UnitCost	Float	False	Cost per unit.
UnitPrice	Float	False	Price per unit.
SupplierUUID	String	False	Determines the supplier identifier.
SupplierName	String	True	Determines the supplier name.

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 Sync App 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

Name	Type	ReadOnly	Description
JobID	String	False	Job Identifier related to the cost.
UUID [KEY]	String	True	Cost identifier.
Date	Datetime	False	The date when the cost was created.
Description	String	False	The description related to the cost.
Code	String	False	The code of the unit.
Note	String	False	The note related to the cost.
Quantity	Double	False	Product quantity.
UnitCost	Float	False	Cost per unit.
UnitPrice	Float	False	Price per unit.
SupplierUUID	String	False	Determines the supplier identifier.
SupplierName	String	True	Determines the supplier name.
Billable	String	True	Determines if the cost is billable or not true(default) | false.

Return a list of all notes of a job

Select

The Sync App 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

Name	Type	ReadOnly	Description
JobID	String	False	The ID of the job which has the note.
UUID [KEY]	String	True	The note identifier.
Title	String	False	The title of the note.
Text	String	False	The text of the note.
Folder	String	False	The folder where the note is.
Date	Datetime	True	The date on which the note was created.
CreatedBy	String	True	The name of the staff who created the note.
Comments	String	True	All comments in a note in xml format.
Public	String	False	Determines if the note is public to staff members. True | False

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 Sync App 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 Sync App will retrieve only your current Invoices.
-When specifying CreatedDate the Sync App 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

Name	Type	ReadOnly	Description
ID [KEY]	String	False	Job identifier.
Name	String	False	The name of the job.
Description	String	False	The description related to the job.
State	String	True	The state of the job.
ClientOrderNumber	String	False	Order number assoicated with this job.
StartDate	Datetime	False	The date when the job has started.
DueDate	Datetime	False	The date when the job should be completed.
CompletedDate	Datetime	False	The date when the job has been completed.
ClientUUID	String	False	The client identifier related to the job.
ClientName	String	False	The client name related to the job.
ContactUUID	String	False	The client identifier related to the job.
ContactName	String	False	The client name related to the job.
ManagerUUID	String	False	The manager identifier related to the job.
ManagerName	String	False	The manager name related to the job.
PartnerUUID	String	False	The partner identifier related to the job.
PartnerName	String	False	The partner name related to the job.
AssignedStaff	String	True	List of staff members assigned to the job in xml format.

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.

Name	Type	Description
TemplateUUID	String	Used while inserting a job to determine its initial template.
CategoryUUID	String	Used while inserting a job to determine its initial category.
AssignedStaffUUID	String	Used to filter jobs based on the staff member assigned.
CreatedDate	Date	Used to filter jobs from their date of creation.

Return a list of all tasks of jobs.

Select

The Sync App 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

Name	Type	ReadOnly	Description
JobID	String	True	The job identifier related to the task.
UUID [KEY]	String	True	The task identifier.
TaskUUID	String	True	The task identifier references Tasks.ID.
Name	String	True	The name of the task.
Description	String	True	The description related to the task.
EstimatedMinutes	Int	True	The estimated time for completing the task.
ActualMinutes	Int	True	Actual time passed.
Completed	Boolean	True	Determine if the task is completed or not.
Billable	Boolean	True	Determines if the task is billable or not true(default) | false.
CreatedDate	Date	True	Determines the datetime when the task has started.
DueDate	Date	True	Determines the datetime when the task should be finished.
AssignedStaffUUID	String	True	List of staff members assigned to the job in xml format
Label	String	False	Used while inserting to determine a label to the task.

Return a list of all leads.

Select

The Sync App 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 Sync App will retrieve only your current Leads.
-When specifying CreatedDate the Sync App 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

Name	Type	ReadOnly	Description
UUID [KEY]	String	True	Lead identifier.
Name	String	True	The name of the lead.
Description	String	True	The description of the lead.
State	String	True	The state of the lead.
CreatedDate	Datetime	True	The date when the lead was created.
DateWonLost	String	True	Date this lead was either won or lost.
Category	String	True	The category of the lead.
EstimatedValue	Int	True	Estimated value of the lead.
ClientUUID	String	True	The client identifier related to the lead.
ClientName	String	True	The client name related to the lead.
ContactUUID	String	True	The contact ID of the client related to the lead.
ContactName	String	True	The contact name of the client related to the lead.
OwnerUUID	String	True	The owner ID related to the lead.
OwnerName	String	True	The owner name related to the lead.
CategoryUUID	String	False	Used while inserting to determine a category for the lead.
TemplateUUID	String	False	Used while inserting to determine a template for the lead.

Return a list of all draft purchase orders

Select

The Sync App 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

Name	Type	ReadOnly	Description
ID [KEY]	String	False	The purchase order identifier.
Description	String	False	The description related to the purchase order.
State	String	False	The state of the purchase order.
CreatedDate	Datetime	True	The date when the purchase order was created.
DeliveryAddress	String	False	Delivery address for the purchase order.
Amount	Float	True	The amount to pay.
AmountTax	Float	True	The tax amount to pay.
AmountIncludingTax	Float	True	The total amount to pay including tax.
SupplierUUID	String	False	The supplier identifier related to the purchase order.
SupplierName	String	True	The supplier name related to the purchase order.
JobID	String	False	The job identifier related to the purchase order.
JobName	String	True	The job name related to the purchase order.
PurchaseOrderCosts	String	False	Lists all purchase orders costs, xml format.

Return a list of all purchase orders

Select

The Sync App 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 Sync App will retrieve only your current PurchaseOrders.
-When specifying CreatedDate the Sync App 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

Name	Type	ReadOnly	Description
ID [KEY]	String	False	The purchase order identifier.
Description	String	False	The description related to the purchase order.
State	String	False	The state of the purchase order.
CreatedDate	Datetime	True	The date when the purchase order was created.
DeliveryAddress	String	False	Delivery address for the purchase order.
Amount	Float	True	The amount to pay.
AmountTax	Float	True	The tax amount to pay.
AmountIncludingTax	Float	True	The total amount to pay including tax.
SupplierUUID	String	False	The supplier identifier related to the purchase order.
SupplierName	String	True	The supplier name related to the purchase order.
JobID	String	False	The job identifier related to the purchase order.
JobName	String	True	The job name related to the purchase order.
PurchaseOrderCosts	String	False	Lists all purchase orders costs, xml format.

Return a list of all staff members

Select

The Sync App 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 = '[email protected]', 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

Name	Type	ReadOnly	Description
UUID [KEY]	String	True	The staff member identifier.
Name	String	False	The staff member name.
Email	String	False	The staff member email.
Phone	String	False	The staff member phone number.
Mobile	String	False	The staff member mobile number.
Address	String	False	The staff member address.
PayrollCode	String	False	Payroll code for the staff member.

Return a list of all suppliers.

Select

The Sync App 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 = '[email protected]', Mobile = '23489235' WHERE UUID = '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'

Columns

Name	Type	ReadOnly	Description
SupplierUUID	String	False	The ID of the supplier.
UUID [KEY]	String	True	The id of the contact which belongs to the supplier.
Name	String	False	The name of the contact.
Mobile	String	False	The mobile number of the contact.
Email	String	False	The email of the contact.
Phone	String	False	The phone number of the contact.
Position	String	False	The position of the contact.

Return a list of all suppliers.

Select

The Sync App 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 = '[email protected]', 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

Name	Type	ReadOnly	Description
UUID [KEY]	String	True	The Id of the supplier.
Name	String	False	The name of the supplier.
Address	String	False	The address of the supplier.
City	String	False	The city where the supplier is located.
Region	String	False	The region where the client is located.
PostCode	String	False	The postal code of where the supplier is located.
Country	String	False	The country where the supplier is located.
PostalAddress	String	False	The address of the postal office.
PostalCity	String	False	The city where the postal office is located.
PostalRegion	String	False	The region where the postal office is located.
PostalPostCode	String	False	The postal code of the postal office.
PostalCountry	String	False	The country where the postal office is located.
Phone	String	False	The phone number of the supplier.
Fax	String	False	The fax number of the supplier.
Website	String	False	The website of the supplier.

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.

Name	Type	Description
Archive	String	Used for archiving a supplier not deleting it completely

Return a list of all time sheets.

Select

The Sync App 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 Sync App 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

Name	Type	ReadOnly	Description
UUID [KEY]	String	False	The Id of the timesheet entry.
JobID	String	False	The Id of the job related to the timesheet entry.
JobName	String	True	The name of the job related to the timesheet entry.
TaskUUID	String	False	The Id of the task related to the timesheet entry.
TaskName	String	True	The name of the task related to the timesheet entry.
StaffUUID	String	False	The Id of the staff related to the timesheet entry.
StaffName	String	True	The name of the staff related to the timesheet entry.
CreatedDate	Datetime	False	The date of the timesheet entry .
Minutes	Int	False	The minutes of how much the timesheet entry will last.
Note	String	False	The note related to the timesheet entry.
Billable	Boolean	False	Boolean indicating if this time is billable or not.
Start	Time	False	The start time of the timesheet entry.
End	Time	False	The time when the timesheet entry ended.

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 for CData Sync Views

Name	Description
Categories	Return a list of all categories
ClientDocuments	Return a list of all documents of the clients.
ClientNotes	Return all notes of clients
InvoiceDrafts	Return a list of draft invoices
InvoicePayments	Return a list of invoice payments
Invoices	Return a list of invoices
InvoicesJobTask	Return a list of invoices related to Tasks.
JobDocuments	Return a list of all documents of a job
JobMilestones	Return all milestones of jobs
LeadCategories	Return a list of lead categories
PurchaseOrderCosts	Return all purchase order costs
QuoteDrafts	Return a list of all draft quotes
Quotes	Return a list of all quotes
QuotesCost	Return a list of quotes related to costs.
QuotesOption	Return a list of quotes related to options.
QuotesTask	Return a list of quotes related to Tasks.
Tasks	Return a list of all tasks
Templates	Return a list of all templates

Return a list of all categories

Select

The Sync App will process all filters client side.

Columns

Name	Type	Description
UUID [KEY]	String	The Id of the category
Name	String	The name of the category

Return a list of all documents of the clients.

Select

The Sync App 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

Name	Type	Description
ClientUUID [KEY]	String	The ID of the client which has the document.
Title	String	The title of the document.
Text	String	The note relating to the document.
Folder	String	The folder where the document is.
Date	Datetime	The date on which the document was created.
CreatedBy	String	The name of the staff who created the document.
URL	String	The URL used to direct download the document.

Return all notes of clients

Select

The Sync App will process all filters client side.

Columns

Name	Type	Description
ClientUUID [KEY]	String	The ID of the Client which has the notes.
Title	String	The title of the note.
Text	String	The text on the note.
Folder	String	The folder where the note is.
Date	Date	The date on which the note was created.
CreatedBy	String	The name of the staff who created the document.

Return a list of draft invoices

Select

The Sync App will process all filters client side.

Columns

Name	Type	Description
UUID [KEY]	String	The name of the category
Type	String	Determines the type of the invoice.
Status	String	Status of the invoice Approved, Paid, Draft, Cancelled
JobID	String	Id of the job associated with this Invoice.
CreatedDate	Date	Determines the date when the invoice was created.
DueDate	Date	Determines the due date for the invoice.
Amount	Float	The amount to pay.
AmountTax	Float	The tax amount to pay.
AmountIncludingTax	Float	The total amount to pay including tax.
AmountPaid	Float	Determine the amount which has already been paid.
AmountOutstanding	Float	Determines the amount thats left to pay.
ClientUUID	String	Client identifier related to the invoice.
ClientName	String	Client name related to teh invoice.
ContactUUID	String	Contact identifier of the client related to the invoice.
ContactName	String	Contact name of the client related to the invoice.

Return a list of invoice payments

Select

The Sync App will process all filters client side.

Columns

Name	Type	Description
InvoiceID [KEY]	String	The identifier of the invoice
Date	Date	The date of the payment
Amount	Float	The amount that has been payed.
Reference	String	The reference of the payment

Return a list of invoices

Select

The Sync App 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 Sync App will retrieve only your current Invoices.
-When specifying CreatedFrom and CreatedTo the Sync App will retrieve the current and archived Invoices.

Columns

Name	Type	Description
ID [KEY]	String	The name of the category
Type	String	Determines the type of the invoice.
Status	String	Status of the invoice Approved, Paid, Draft, Cancelled
JobID	String	Id of the job associated with this Invoice.
CreatedDate	Date	Determines the date when the invoice was created.
DueDate	Date	Determines the due date for the invoice.
Amount	Float	The amount to pay.
AmountTax	Float	The tax amount to pay.
AmountIncludingTax	Float	The total amount to pay including tax.
AmountPaid	Float	Determine the amount which has already been paid.
AmountOutstanding	Float	Determines the amount thats left to pay.
ClientUUID	String	Client identifier related to the invoice.
ClientName	String	Client name related to teh invoice.
ContactUUID	String	Contact identifier of the client related to the invoice.
ContactName	String	Contact name of the client related to the invoice.

Return a list of invoices related to Tasks.

Select

The Sync App will process all filters client side except InvoiceID.

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

Columns

Name	Type	Description
InvoiceID [KEY]	String	The identifier of the invoice
Name	String	The Name of the task related to the invoice.
Description	String	The Description of the task related to the invoice.
Minutes	Int	The Minutes of the task related to the invoice.
BillableRate	Double	The BillableRate of the task related to the invoice.
Billable	String	The Billable of the task related to the invoice.
Amount	Double	The Amount of the task related to the invoice.
AmountTax	Double	The AmountTax of the task related to the invoice.
AmountIncludingTax	Double	The AmountIncludingTax of the task related to the invoice.

Return a list of all documents of a job

Select

The Sync App 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

Name	Type	Description
JobID [KEY]	String	The ID of the job which has the document.
Title	String	The title of the document.
Text	String	The note relating to the document.
Folder	String	The folder where the document is.
Date	Datetime	The date on which the document was created.
CreatedBy	String	The name of the staff who created the document.
URL	String	The URL used to direct download the document.

Return all milestones of jobs

Select

The Sync App will process all filters client side.

Columns

Name	Type	Description
JobID [KEY]	String	The ID of the job related to the milestone.
Date	Date	The date which the mileston refers.
Description	String	The description related to the milestone.
Completed	Boolean	Determines if the milestone has been completed or not.

Return a list of lead categories

Select

The Sync App will process all filters client side.

Columns

Name	Type	Description
UUID [KEY]	String	The UUID of the category
Name	String	The name of the category

Return all purchase order costs

Select

The Sync App 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

Name	Type	Description
PurchaseOrderID [KEY]	String	Since costs don't have an identifier this is the Purchase order identifier which references PurchaseOrders.ID
Description	String	The description related to teh cost
Code	String	The code of the unit.
Quantity	Int	Product quantity.
UnitCost	Float	Cost per unit.
Amount	Float	The amount to pay.
AmountTax	Float	The tax amount to pay.
AmountIncludingTax	Float	The total amount to pay including tax.
Note	String	The note related to the cost.

Return a list of all draft quotes

Select

The Sync App will process all filters client side.

Columns

Name	Type	Description
ID [KEY]	String	The quote identifier.
Type	String	The type of the quote.
State	String	The state of the quote.
CreatedDate	Datetime	The date when the quote was created.
ValidDate	Datetime	The date till the quote is valid.
Budget	String	The budget for the quote.
OptionExplanation	String	A description to explain the options related to the quote.
EstimatedCost	Float	Estimated cost amount.
EstimatedCostTax	Float	Estimated tax cost amount.
EstimatedCostIncludingTax	Float	Estimated total amount including tax.
AmountTax	Float	Amount to pay.
AmountIncludingTax	Float	Tax amount to pay.
Amount	Float	Total amount to pay including tax.
ClientUUID	String	The Client identifier which is related to the quote.
ClientName	String	The Client name which is related to the quote.
ContactUUID	String	The contact ID of the client which is related to the quote.
ContactName	String	The contact name of the client which is related to the quote.

Return a list of all quotes

Select

The Sync App 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 Sync App will retrieve only your current Quotes.
-When specifying CreatedDate the Sync App will retrieve the current and archived Quotes.

Columns

Name	Type	Description
ID [KEY]	String	The quote identifier.
Type	String	The type of the quote.
State	String	The state of the quote.
CreatedDate	Datetime	The date when the quote was created.
ValidDate	Datetime	The date till the quote is valid.
Budget	String	The budget for the quote.
OptionExplanation	String	A description to explain the options related to the quote.
EstimatedCost	Float	Estimated cost amount.
EstimatedCostTax	Float	Estimated tax cost amount.
EstimatedCostIncludingTax	Float	Estimated total amount including tax.
AmountTax	Float	Amount to pay.
AmountIncludingTax	Float	Tax amount to pay.
Amount	Float	Total amount to pay including tax.
ClientUUID	String	The Client identifier which is related to the quote.
ClientName	String	The Client name which is related to the quote.
ContactUUID	String	The contact ID of the client which is related to the quote.
ContactName	String	The contact name of the client which is related to the quote.

Return a list of quotes related to costs.

Select

The Sync App will process all filters client side except QuoteID.

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

Columns

Name	Type	Description
QuoteID [KEY]	String	The identifier of the Quote.
Description	String	The Description of the task related to the costs.
Note	String	The Note of the task related to the costs.
Code	String	The Code of the task related to the costs.
Billable	String	The Billable of the task related to the costs.
Quantity	Int	The Quantity of the task related to the costs.
UnitCost	Double	The UnitCost of the task related to the costs.
UnitPrice	Double	The UnitPrice of the task related to the costs.
Amount	Double	The Amount of the task related to the costs.
AmountTax	Double	The AmountTax of the task related to the costs.
AmountIncludingTax	Double	The AmountIncludingTax of the task related to the costs.

Return a list of quotes related to options.

Select

The Sync App will process all filters client side except QuoteID.

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

Columns

Name	Type	Description
QuoteID [KEY]	String	The identifier of the Quote.
Description	String	The Description of the task related to the options.
Note	String	The Note of the task related to the options.
Code	String	The Code of the task related to the options.
Quantity	Int	The Quantity of the task related to the options.
UnitCost	Double	The UnitCost of the task related to the options.
UnitPrice	Double	The UnitPrice of the task related to the options.
Amount	Double	The Amount of the task related to the options.
AmountTax	Double	The AmountTax of the task related to the options.
AmountIncludingTax	Double	The AmountIncludingTax of the task related to the options.

Return a list of quotes related to Tasks.

Select

The Sync App will process all filters client side except QuoteID.

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

Columns

Name	Type	Description
QuoteID [KEY]	String	The identifier of the Quote.
Name	String	The Name of the task related to the Quote.
Description	String	The Description of the task related to the Quote.
EstimatedMinutes	Int	The Minutes of the task related to the Quote.
BillableRate	Double	The BillableRate of the task related to the Quote.
Billable	String	The Billable of the task related to the Quote.
Amount	Double	The Amount of the task related to the Quote.
AmountTax	Double	The AmountTax of the task related to the Quote.
AmountIncludingTax	Double	The AmountIncludingTax of the task related to the Quote.

Return a list of all tasks

Select

The Sync App 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

Name	Type	Description
UUID [KEY]	String	Task identifier.
Name	String	The task name
Description	String	The task description.

Return a list of all templates

Select

The Sync App will process all filters client side.

Columns

Name	Type	Description
UUID [KEY]	String	The template identifier.
Name	String	The templates name.

The connection string 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 in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

OAuth

---

Property	Description
OAuthClientId	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.
TenantId	Xero Workflow Max Tenant ID.

SSL

---

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

Firewall

---

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

Proxy

---

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Logging

---

Property	Description
LogModules	Core modules to be included in the log file.

Schema

---

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Miscellaneous

---

Property	Description
IncludeCustomFields	Determines if Custom Fields should be included as table columns or not. Including CustomFields will impact the performance.
MaxRows	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.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.

---

Property	Description
OAuthClientId	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.
TenantId	Xero Workflow Max Tenant ID.

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

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.

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

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.

Xero Workflow Max Tenant ID.

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.

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

---

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

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

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:

Description	Example
A full PEM Certificate (example shortened for brevity)	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate	C:\cert.cer
The public key (example shortened for brevity)	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated)	ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated)	34a929226ae0819f2ec14b4a3d904f801cbb150d

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

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

This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.

---

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

The protocol used by a proxy-based firewall.

Remarks

This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that by default, the Sync App connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

Type	Default Port	Description
TUNNEL	80	When this is set, the Sync App opens a connection to Xero WorkflowMax and traffic flows back and forth through the proxy.
SOCKS4	1080	When this is set, the Sync App sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted.
SOCKS5	1080	When this is set, the Sync App sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

The name or IP address of a proxy-based firewall.

Remarks

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.

Note that the Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

The TCP port for a proxy-based firewall.

Remarks

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.

The user name to use to authenticate with a proxy-based firewall.

Remarks

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.

A password used to authenticate to a proxy-based firewall.

Remarks

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.

---

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

This indicates whether to use the system proxy settings or not.

Remarks

This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

The hostname or IP address of a proxy to route HTTP traffic through.

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The Sync App can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.

If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.

By default, the Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

The TCP port the ProxyServer proxy is running on.

Remarks

The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.

The authentication type to use to authenticate to the ProxyServer proxy.

Remarks

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

Note that the Sync App will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

The authentication type can be one of the following:

• BASIC: The Sync App performs HTTP BASIC authentication.
• DIGEST: The Sync App performs HTTP DIGEST authentication.
• NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
• PROPRIETARY: The Sync App does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

A user name to be used to authenticate to the ProxyServer proxy.

Remarks

The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:

user@domain
domain\user

A password to be used to authenticate to the ProxyServer proxy.

Remarks

This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.

If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.

If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.

For SOCKS 5 authentication or tunneling, see FirewallType.

By default, the Sync App uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

The SSL type to use when connecting to the ProxyServer proxy.

Remarks

This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:

AUTO	Default setting. If the URL is an HTTPS URL, the Sync App will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option.
ALWAYS	The connection is always SSL enabled.
NEVER	The connection is not SSL enabled.
TUNNEL	The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that the Sync App uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

---

Property	Description
LogModules	Core modules to be included in the log file.

Core modules to be included in the log file.

Remarks

Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.

See the Logging page for an overview.

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

---

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

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

Remarks

The path to a directory which contains the schema files for the Sync App (.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%\\CData\\XeroWorkflowMax Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:

Platform	%APPDATA%
Windows	The value of the APPDATA environment variable
Linux	~/.config

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

Remarks

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

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

Remarks

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

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.

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

Remarks

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

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.

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

---

Property	Description
IncludeCustomFields	Determines if Custom Fields should be included as table columns or not. Including CustomFields will impact the performance.
MaxRows	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.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

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

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.

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

Remarks

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

These hidden properties are used only in specific use cases.

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

DefaultColumnSize	Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT	Determines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filename	Records the underlying socket data transfer to the specified file.

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

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, "*=*".

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

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 Sync App throws an exception.

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

Remarks

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Sync App 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 Sync App.

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.