Xero WorkflowMax への接続を追加

Xero WorkflowMax への接続を追加するには：

1. アプリケーションコンソールで、接続ページに移動します。
2. 接続の追加パネルで、追加したい接続のアイコンを選択します。
3. Xero WorkflowMax アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからXero WorkflowMax コネクタをダウンロードおよびインストールします。

必須プロパティについては、設定タブを参照してください。

通常必須ではない接続プロパティについては、高度な設定タブを参照してください。

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 カスタムOAuth アプリケーションの作成. 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.

このセクションでは、Xero WorkflowMax Sync App の高度な機能を厳選して説明します。

ユーザー定義ビュー

Sync App を使用すると、事前設定されたクエリによって内容が決定されるユーザー定義ビューと呼ばれる仮想テーブルを定義できます。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。

SSL の設定

SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。 詳しくは、接続文字列オプションにあるSSLServerCert プロパティを参照してください。

ファイアウォールとプロキシ

Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。

クエリ処理

Sync App は、Xero WorkflowMax にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。

詳しくはクエリ処理 を参照してください。

ログ

CData ログを調整するために使用可能な設定の概要については、ログ を参照してください。基本的なロギングでは、 次の2つの接続プロパティを設定するだけです。LogModules 接続プロパティを使用してログに記録する情報のサブセットを選択できる、 より洗練されたロギングをサポートする多数の機能があります。

SSL 設定のカスタマイズ

デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。

別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。

Firewall またはProxy 経由の接続

HTTP プロキシ

Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。

さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。

その他のプロキシ

次のプロパティを設定します。

• プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
• 接続をトンネルするには、FirewallType をTUNNEL に設定します。
• 認証するには、FirewallUser とFirewallPassword を設定します。
• SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

概要

このセクションでは、利用可能なAPI オブジェクトを示し、Xero WorkflowMax API へのSQL の実行について詳しく説明します。

主要機能

• Sync App はClients、Suppliers、およびJobs などのXero WorkflowMax エンティティをリレーショナルビューとしてモデル化し、SQL を記述してXero WorkflowMax データをクエリできるようにします。
• ストアドプロシージャを使用するとXero WorkflowMax の操作を実行できます。
• これらのオブジェクトへのライブ接続により、Sync App を使用するとXero WorkflowMax アカウントへのあらゆる変更が即座に反映されます。

カスタムフィールド

XeroWOrkflowMax ドライバーはカスタムフィールドをサポートします。カスタムフィールドを取得および更新可能にするには、IncludeCustomFields を接続プロパティとして設定する必要があります。 カスタムフィールドを1つずつフェッチするため、ドライバーが遅くなることに注意してください。パフォーマンスを改善するには、クエリするリソースのID を指定してください。

Sync App はXero WorkflowMax のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。

Xero WorkflowMax Connector for CData Sync テーブル

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

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

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

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

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

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

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.

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

Xero WorkflowMax Connector for CData Sync ビュー

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.

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

接続を確立する方法について詳しくは、接続の確立を参照してください。

OAuth

---

プロパティ	説明
OAuthClientId	OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecret	OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
TenantId	Xero Workflow Max Tenant ID

SSL

---

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

Firewall

---

プロパティ	説明
FirewallType	プロキシベースのファイアウォールで使われるプロトコル。
FirewallServer	プロキシベースのファイアウォールの名前もしくはIP アドレス。
FirewallPort	プロキシベースのファイアウォールのTCP ポート。
FirewallUser	プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallPassword	プロキシベースのファイアウォールへの認証に使われるパスワード。

Proxy

---

プロパティ	説明
ProxyAutoDetect	これは、システムプロキシ設定を使用するかどうかを示します。
ProxyServer	HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
ProxyPort	ProxyServer プロキシが起動しているTCP ポート。
ProxyAuthScheme	ProxyServer プロキシへの認証で使われる認証タイプ。
ProxyUser	ProxyServer プロキシへの認証に使われるユーザー名。
ProxyPassword	ProxyServer プロキシへの認証に使われるパスワード。
ProxySSLType	ProxyServer プロキシへの接続時に使用するSSL タイプ。
ProxyExceptions	ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

Logging

---

プロパティ	説明
LogModules	ログファイルに含めるコアモジュール。

Schema

---

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
BrowsableSchemas	このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
Views	使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

Miscellaneous

---

プロパティ	説明
IncludeCustomFields	Determines if Custom Fields should be included as table columns or not. Including CustomFields will impact the performance.
MaxRows	クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
Other	これらの隠しプロパティは特定のユースケースでのみ使用されます。
PseudoColumns	このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UserDefinedViews	カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。

---

プロパティ	説明
OAuthClientId	OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecret	OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
TenantId	Xero Workflow Max Tenant ID

OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。

解説

OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。

OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。

解説

OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。

Xero Workflow Max Tenant ID

解説

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.

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。

---

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

解説

TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。

このプロパティは、次のフォームを取ります：

説明	例
フルPEM 証明書（例では省略されています）	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
証明書を保有するローカルファイルへのパス。	C:\cert.cer
公開鍵（例では省略されています）	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
MD5 Thumbprint （hex 値はスペースおよびコロン区切り）	ecadbdda5a1529c58a1e9e09828d70e4
SHA1 Thumbprint （hex 値はスペースおよびコロン区切り）	34a929226ae0819f2ec14b4a3d904f801cbb150d

これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。

すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。

このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。

---

プロパティ	説明
FirewallType	プロキシベースのファイアウォールで使われるプロトコル。
FirewallServer	プロキシベースのファイアウォールの名前もしくはIP アドレス。
FirewallPort	プロキシベースのファイアウォールのTCP ポート。
FirewallUser	プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallPassword	プロキシベースのファイアウォールへの認証に使われるパスワード。

プロキシベースのファイアウォールで使われるプロトコル。

解説

このプロパティは、Sync App がFirewallServer プロキシ経由でトンネルトラフィックを使うためのプロトコルを指定します。デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し次のプロキシタイプのどれかで接続するには、ProxyAutoDetect をfalse に設定します。

タイプ	デフォルトポート	説明
TUNNEL	80	これが設定されている場合、Sync App はXero WorkflowMax への接続を開き、プロキシを経由して通信が行われます。
SOCKS4	1080	これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 4 プロキシ経由で送信し、接続リクエストが許容されるかどうかを決定します。
SOCKS5	1080	これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 5 プロキシ経由で送信します。プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。

HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。

プロキシベースのファイアウォールの名前もしくはIP アドレス。

解説

ファイアウォールトラバーサルを許容するために設定するIP アドレス、DNS 名、もしくはプロキシホスト名を指定するプロパティです。プロトコルはFirewallType で指定されます。このプロパティとFirewallServer を使って、SOCKS 経由での接続、もしくはトンネリングが可能です。HTTP プロキシへの接続には、ProxyServer を使用します。

Sync App はデフォルトでシステムプロキシを使うので注意してください。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定してください。

プロキシベースのファイアウォールのTCP ポート。

解説

ファイアウォールトラバーサルを許容するために設定するプロキシベースのファイアウォールのTCP ポート。名前もしくはIP アドレスを指定するには、FirewallServer を使います。FirewallType でプロトコルを指定します。

プロキシベースのファイアウォールに認証するために使うユーザー名。

解説

FirewallUser およびFirewallPassword プロパティは、FirewallType により指定された認証方式に則り、FirewallServer、およびFirewallPort で指定されたプロキシに対しての認証に使われます。

プロキシベースのファイアウォールへの認証に使われるパスワード。

解説

このプロパティは、FirewallType により指定された認証メソッドに則り、FirewallServer およびFirewallPort で指定されたプロキシに渡されます。

このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。

---

プロパティ	説明
ProxyAutoDetect	これは、システムプロキシ設定を使用するかどうかを示します。
ProxyServer	HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
ProxyPort	ProxyServer プロキシが起動しているTCP ポート。
ProxyAuthScheme	ProxyServer プロキシへの認証で使われる認証タイプ。
ProxyUser	ProxyServer プロキシへの認証に使われるユーザー名。
ProxyPassword	ProxyServer プロキシへの認証に使われるパスワード。
ProxySSLType	ProxyServer プロキシへの接続時に使用するSSL タイプ。
ProxyExceptions	ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

これは、システムプロキシ設定を使用するかどうかを示します。

解説

これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。

HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。

HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。

解説

HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。HTTP プロキシへの認証には、Sync App はHTTP、Windows(NTLM)、もしくはKerberos 認証タイプを使用することができます。

SOCKS プロキシを経由して接続する、もしくは接続をトンネルするには、FirewallType を参照してください。

デフォルトで、Sync App はsystem プロキシを使います。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定します。

ProxyServer プロキシが起動しているTCP ポート。

解説

HTTP トラフィックをリダイレクトするHTTP プロキシが実行されているポート。ProxyServer でHTTP プロキシを指定します。その他のプロキシタイプについては、FirewallType を参照してください。

ProxyServer プロキシへの認証で使われる認証タイプ。

解説

この値は、ProxyServer およびProxyPort で指定されるHTTP プロキシに認証するために使われる認証タイプを指定します。

Sync App は、デフォルトでsystem proxy settings を使い、追加での設定が不要です。他のプロキシへの接続をする場合には、ProxyServer およびProxyPort に加え、ProxyAutoDetect をfalse に設定します。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。

認証タイプは、次のどれかになります。

• BASIC： Sync App はHTTP BASIC 認証を行います。
• DIGEST： Sync App はHTTP DIGEST 認証を行います。
• NEGOTIATE： Sync App は認証において有効なプロトコルに応じて、NTLM もしくはKerberos トークンを取得します。
• PROPRIETARY： Sync App はNTLM もしくはKerberos トークンを発行しません。このトークンを、HTTP リクエストのAuthorization ヘッダーに含める必要があります。

SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。

ProxyServer プロキシへの認証に使われるユーザー名。

解説

ProxyUser および ProxyPassword オプションは、ProxyServer で指定されたHTTP プロキシに対して接続および認証するために使用されます。

ProxyAuthScheme で使用可能な認証タイプを選択することができます。HTTP 認証を使う場合、これをHTTP プロキシで識別可能なユーザーのユーザー名に設定します。Windows もしくはKerberos 認証を使用する場合、このプロパティを次の形式のどれかでユーザー名に設定します。

user@domain
domain\user

ProxyServer プロキシへの認証に使われるパスワード。

解説

このプロパティは、NTLM(Windows)、Kerberos、もしくはHTTP 認証をサポートするHTTP プロキシサーバーに認証するために使われます。HTTP プロキシを指定するためには、ProxyServer およびProxyPort を設定します。認証タイプを指定するためにはProxyAuthScheme を設定します。

HTTP 認証を使う場合、さらにHTTP プロキシにProxyUser およびProxyPassword を設定します。

NTLM 認証を使う場合、Windows パスワードにProxyUser およびProxyPassword を設定します。Kerberos 認証には、これらを入力する必要があります。

SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。

デフォルトで、Sync App はsystem プロキシを使います。他のプロキシに接続する場合には、これをfalse に設定します。

ProxyServer プロキシへの接続時に使用するSSL タイプ。

解説

このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この値は、AUTO、ALWAYS、NEVER、TUNNEL のいずれかです。有効な値は次のとおりです。

AUTO	デフォルト設定。URL がHTTPS URL の場合、Sync App は、TUNNEL オプションを使います。URL がHTTP URL の場合、コンポーネントはNEVER オプションを使います。
ALWAYS	接続は、常にSSL 有効となります。
NEVER	接続は、SSL 有効になりません。
TUNNEL	接続は、トンネリングプロキシを経由します。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。

ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

解説

ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。

Sync App は、追加設定なしにデフォルトでシステムのプロキシ設定を使います。この接続のプロキシ例外を明示的に構成するには、ProxyAutoDetect をfalse に設定して、ProxyServer およびProxyPort を設定する必要があります。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。

---

プロパティ	説明
LogModules	ログファイルに含めるコアモジュール。

ログファイルに含めるコアモジュール。

解説

指定された（';' で区切られた）モジュールのみがログファイルに含まれます。デフォルトではすべてのモジュールが含まれます。

概要はログ ページを参照してください。

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。

---

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
BrowsableSchemas	このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
Views	使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。

解説

Sync App のスキーマファイル（テーブルとビューの場合は.rsd ファイル、ストアドプロシージャの場合は.rsb ファイル）を含むディレクトリへのパス。このフォルダの場所は、実行ファイルの場所からの相対パスにすることができます。Location プロパティは、定義をカスタマイズしたり（例えば、カラム名を変更する、カラムを無視するなど）、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。

指定しない場合、デフォルトの場所は"%APPDATA%\\CData\\XeroWorkflowMax Data Provider\\Schema" となり、%APPDATA% はユーザーのコンフィギュレーションディレクトリに設定されます：

Platform	%APPDATA%
Windows	APPDATA 環境変数の値
Linux	~/.config

このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

解説

スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、 パフォーマンスが向上します。

このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。

解説

テーブルを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でテーブルのリストを提供すると、Sync App のパフォーマンスが向上します。

このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。

カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。

複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。

使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

解説

ビューを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でビューのリストを提供すると、Sync App のパフォーマンスが向上します。

このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。

カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。

複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。

---

プロパティ	説明
IncludeCustomFields	Determines if Custom Fields should be included as table columns or not. Including CustomFields will impact the performance.
MaxRows	クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
Other	これらの隠しプロパティは特定のユースケースでのみ使用されます。
PseudoColumns	このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UserDefinedViews	カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

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

解説

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.

クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。

解説

クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。

これらの隠しプロパティは特定のユースケースでのみ使用されます。

解説

以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。

複数のプロパティをセミコロン区切りリストで指定します。

統合およびフォーマット

DefaultColumnSize	データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。
ConvertDateTimeToGMT	日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。
RecordToFile=filename	基底のソケットデータ転送を指定のファイルに記録します。

このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。

解説

Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。

タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。

解説

Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。

Timeout の有効期限が切れても処理が完了していない場合は、Sync App は例外をスローします。

カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

解説

ユーザー定義ビューは、UserDefinedViews.json というJSON 形式のコンフィギュレーションファイルで定義されています。Sync App は、このファイルで指定されたビューを自動的に検出します。

また、複数のビュー定義を持ち、UserDefinedViews 接続プロパティを使用して制御することも可能です。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。

このユーザー定義ビューのコンフィギュレーションファイルは、次のようにフォーマットされています。

• 各ルートエレメントはビューの名前を定義します。
• 各ルートエレメントには、query と呼ばれる子エレメントが含まれており、この子エレメントにはビューのカスタムSQL クエリが含まれています。

次に例を示します。

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

UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。

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

指定されたパスは引用符で囲まれていないことに注意してください。