接続の確立

Sync App アプリケーションの接続ページに移動し、接続の追加 パネルで対応するアイコンを選択して、Wave Financial への接続を作成します。Wave Financial アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからWave Financial コネクタをダウンロードおよびインストールします。

必須プロパティは［設定］タブにリストされています。［Advanced］タブには、通常は必要ない接続プロパティが表示されます。

Wave Financial への接続

APIToken を指定することでSync App に接続できます。API Token は次の手順で取得できます。

Wave Financial アカウントにログインして、左ペインにある［Manage Applications］に移動します。
トークンを作成するアプリケーションを選択します。最初にアプリケーションを作成する必要があります。
［Create token］ボタンをクリックしてAPIToken を生成します。

OAuth

または、OAuth 認証の使用で接続を確立することもできます。

高度な機能

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

ユーザー定義ビュー

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

SSL の設定

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

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

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

クエリ処理

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

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

ログ

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

SSL の設定

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 に設定します。

データモデル

概要

CData Sync App はWave Financial オブジェクトをリレーショナルテーブルおよびビューとしてモデル化します。

Wave Financial オブジェクトは他のオブジェクトとリレーションを持ちます。テーブルでは、これらのリレーションは外部キーを使用して表されます。次のセクションでは、利用可能なAPI オブジェクトを示し、Wave Financial API へのSQL の実行について詳しく説明します。

ほとんどのデータベースオブジェクトのスキーマは、シンプルなテキストベースのコンフィギュレーションファイルで定義されます。

ビュー

ビューでは、利用可能なビューを説明します。ビューは、Accounts、Customers、Products などを静的にモデル化するように定義されています。

ビュー

ビューは、カラムと疑似カラムで構成されます。ビューは、データを示すという点でテーブルに似ていますが、ビューでは更新はサポートされません。通常、ビューとして表されるエンティティは、読み取り専用のエンティティです。多くの場合、これらのデータはストアドプロシージャを使用することで更新できます（その機能がデータソースに適用できる場合）。

ビューに対しては、通常のテーブルと同じようにクエリを実行でき、このときに返されるデータも同様です。

ビューとして公開されるクエリなどの動的ビューや、project_team ワークアイテムの特定の組み合わせを検索するためのビューがサポートされています。

Wave Financial Connector for CData Sync ビュー


Name	Description
Accounts	Chart of Accounts for the business.
AccountSubtypes	List subtypes of accounts.
AccountTypes	List types of accounts.
Businesses	List businesses.
Countries	List countries.
Currencies	List currencies.
Customers	List of customers for the business.
InvoiceItems	The line items (product, unit and price) that make up the invoiced sale.
InvoiceItemTaxes	List of taxes applied to an invoice item.
Invoices	List of invoices for the business.
ProductDefaultSalesTaxes	Default sales taxes to apply on product.
ProductDefaultSalesTaxRates	Tax rates with their effective dates of application.
Products	List of products (and services) for the business.
Provinces	List of principal subdivisions.
SalesTaxes	List of sales taxes for the business.
SalesTaxRates	Tax rates with their effective dates of application
Vendors	List of vendors for the business.

Accounts

Chart of Accounts for the business.

Table Specific Information

The Sync App uses the Wave Financial API to process some of the filters. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

SELECT

SELECT * FROM Accounts WHERE Id = 'QWNjb3VudDo4MDEyMDg4OD3MWUwYWYtZDZiZS00OGI3LWE1ZTAtNmYyNzU4N2IwNGNi'
SELECT * FROM Accounts WHERE BusinessId = 'QnVzaW5lc3M6MDU3MWUwYWYtZDZiZS00OGI3LWE1ZTAtNmYyNzU4N2IwNGNi'
SELECT * FROM Accounts WHERE Name = 'Accounting Fees'
SELECT * FROM Accounts WHERE TypeValue = 'EXPENSE'
SELECT * FROM Accounts WHERE SubtypeValue = 'CASH_AND_BANK'
SELECT * FROM Accounts WHERE IsArchived = true
SELECT * FROM Accounts WHERE TypeValue IN ('EXPENSE','LIABILITY')
SELECT * FROM Accounts WHERE SubtypeValue IN ('COST_OF_GOODS_SOLD','EXPENSE')

Columns


Name	Type	References	SupportedOperators	Description
Id [KEY]	String			Unique identifier for the account.
BusinessId	String	Businesses.id		The unique identifier for the business.
Name	String			Name of the account.
Description	String			User defined description for the account.
DisplayId	String			User defined id for the account.
CurrencyCode	String	Currencies.Code		Currency code.
TypeValue	String			Account type value.
SubtypeValue	String			Account subtype value.
NormalBalanceType	String			Credit or Debit.
IsArchived	Bool			Indicates whether the account is hidden from view by default.
Sequence	Int			Numerically increasing version, each representing a revision of account data. As soon as something modifies an account, its sequence is incremented.
Balance	Decimal			The balance of the account as of the current date.
BalanceInBusinessCurrency	Decimal			The balance of the account as of the current date in the business currency.

AccountSubtypes

List subtypes of accounts.

Columns


Name	Type	References	SupportedOperators	Description
Value [KEY]	String			Account subtype value.
Name	String			Account subtype name.
AccountTypeName	String			Account type name for the subtype.
Archivable	Bool			Indicates if accounts of this subtype can be archived.
SystemCreated	Bool			Indicates if accounts of this subtype is system created accounts.

AccountTypes

List types of accounts.

SELECT

SELECT * FROM AccountTypes

Columns


Name	Type	References	SupportedOperators	Description
Value [KEY]	String			Account type value.
Name	String			Account type name.
NormalBalanceType	String			Normal balance type of the account type.

Businesses

List businesses.

Table Specific Information

The Sync App uses the Wave Financial API to process some of the filters. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

SELECT

SELECT name FROM Businesses WHERE Id = 'QnVzaW5lc3M6MDU3MWUwYWYtGI3LWE1ZTAtNmYyNzU4N2IwNGNi'

Columns


Name	Type	References	SupportedOperators	Description
Id [KEY]	String			The unique identifier for the business.
Name	String			The name of the business.
IsPersonal	Bool			Is the business a personal one with limited functionality compared to regular businesses.
OrganizationalType	String			The organization type of the business.
TypeName	String			The description of the business type in human-friendly form.
TypeValue	String			The enum value of the business type.
SubtypeName	String			The description of the business subtype in human-friendly form.
SubtypeValue	String			The enum value of the business subtype.
CurrencyCode	String	Currencies.Code		Currency code.
Timezone	String			The timezone of the business.
AddressLine1	String			Address line 1 (Street address/PO Box/Company name).
AddressLine2	String			Address line 2 (Apartment/Suite/Unit/Building).
AddressCity	String			City/District/Suburb/Town/Village.
AddressProvinceCode	String	Provinces.Code		[ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) identifier.
AddressCountryCode	String	Countries.Code		Country code.
AddressPostalCode	String			Zip/Postal Code.
Phone	String			The phone number of the business.
Fax	String			The fax number of the business.
Mobile	String			The mobile/cell number of the business.
TollFree	String			The toll free number of the business.
Website	String			The website of the business.
IsClassicAccounting	Bool			Does business use classic accounting system.
IsClassicInvoicing	Bool			Does business use classic invoicing system.
IsArchived	Bool			Is the business hidden from view by default.
CreatedAt	Datetime			When the business was created.
ModifiedAt	Datetime			When the business was last modified.

Countries

List countries.

Table Specific Information

The Sync App uses the Wave Financial API to process some of the filters. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

SELECT

SELECT * FROM Countries WHERE Code = 'US'

Columns


Name	Type	References	SupportedOperators	Description
Code [KEY]	String			Country code.
Name	String			Plain-language representation.
CurrencyCode	String	Currencies.Code		Currency code.
NameWithArticle	String			Name of the country with the appropriate article.

Currencies

List currencies.

Table Specific Information

The Sync App uses the Wave Financial API to process some of the filters. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

SELECT

SELECT * FROM Currencies WHERE Code = 'USD'

Columns


Name	Type	References	SupportedOperators	Description
Code [KEY]	String			Currency code.
Symbol	String			Symbol used to denote that a number is a monetary value.
Name	String			Plain-language representation.
Plural	String			Plural version of currency name.
Exponent	Int			Expresses the relationship between a major currency unit and its minor currency unit. The number of digits found to the right of the decimal place to represent the fractional part of this currency (assumes a base of 10).

Customers

List of customers for the business.

Table Specific Information

The Sync App uses the Wave Financial API to process some of the filters. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

SELECT

SELECT * FROM Customers WHERE Id = 'QnVzaW5lc3M6NjE2MtYzVlMS00YzkyLTg0Y2EtNzA0ZDM4MTcyNTdlO0N1c3RvbWVyOjMyNzkyMTY1'
SELECT * FROM Customers WHERE BusinessId = 'QnVYtYzVlMS00YzkyLTg0Y2EtNzA0ZDM4MTcyNTdl'
SELECT * FROM Customers WHERE ModifiedAt > '2019-10-30 07:14:55.0' AND ModifiedAt<'2019-10-30 07:18:03.0'

Columns


Name	Type	References	SupportedOperators	Description
Id [KEY]	String			Unique identifier for the customer.
BusinessId	String	Businesses.id		The unique identifier for the business.
Name	String			Name or business name of the customer.
FirstName	String			First name of the principal contact.
LastName	String			Last name of the principal contact.
Email	String			Email of the principal contact.
AddressAddressLine1	String			Address line 1 (Street address/PO Box/Company name).
AddressAddressLine2	String			Address line 2 (Apartment/Suite/Unit/Building).
AddressCity	String			City/District/Suburb/Town/Village.
AddressProvinceCode	String	Provinces.Code		[ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) identifier.
AddressCountryCode	String	Countries.Code		Country code.
AddressPostalCode	String			Zip/Postal Code.
DisplayId	String			User defined id for the customer. Commonly referred to as Account Number.
Mobile	String			Mobile telephone number of the principal contact.
Phone	String			Telephone number of the customer.
Fax	String			Fax number of the customer.
TollFree	String			Toll-free number of the customer.
Website	String			Website address of the customer.
InternalNotes	String			Internal notes about the customer.
CurrencyCode	String	Currencies.Code		Currency code.
ShippingName	String			Name or business name of the customer.
ShippingAddressLine1	String			Address line 1 (Street address/PO Box/Company name).
ShippingAddressLine2	String			Address line 2 (Apartment/Suite/Unit/Building).
ShippingAddressCity	String			City/District/Suburb/Town/Village.
ShippingAddressProvinceCode	String	Provinces.Code		[ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) identifier.
ShippingAddressCountryCode	String	Countries.Code		Country code.
ShippingAddressPostalCode	String			Zip/Postal Code.
ShippingPhone	String			Telephone number of the customer.
ShippingInstructions	String			Delivery instructions for handling.
CreatedAt	Datetime			When the customer was created.
ModifiedAt	Datetime			When the customer was last modified.
IsArchived	Bool			Whether or not the customer is archived.

InvoiceItems

The line items (product, unit and price) that make up the invoiced sale.

Table Specific Information

The Sync App uses the Wave Financial API to process some of the filters. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

SELECT

SELECT * FROM InvoiceItems WHERE InvoiceId = 'QnVzaW5lc3M6MTY4NTYtYzVlMS00YzkyLTg0Y2EtNzA0ZDM4MTcyNTdl'

Columns


Name	Type	References	SupportedOperators	Description
ProductId [KEY]	String	Products.Id		Unique identifier for the associated product.
InvoiceId [KEY]	String	Invoices.Id		Unique identifier for the invoice.
Quantity	Decimal			Number of units.
Price	Decimal			Price per unit.
SubtotalValue	Decimal			Amount represented as a combination of the major and minor currency unit (uses a decimal separator).
SubtotalCurrencyCode	String	Currencies.Code		Currency code.
TotalValue	Decimal			Amount represented as a combination of the major and minor currency unit (uses a decimal separator).
TotalCurrencyCode	String	Currencies.Code		Currency code.
AccountId	String			Unique identifier for the account.

InvoiceItemTaxes

List of taxes applied to an invoice item.

SELECT

SELECT * FROM InvoiceItemTaxes

Columns


Name	Type	References	SupportedOperators	Description
SalesTaxId [KEY]	String			The unique identifier for the sales tax.
ProductId [KEY]	String	Products.Id		Associated product Id.
AmountValue	Decimal			Amount represented as a combination of the major and minor currency unit (uses a decimal separator).
AmountCurrencyCode	String	Currencies.Code		Currency code.

Invoices

List of invoices for the business.

Table Specific Information

The Sync App uses the Wave Financial API to process some of the filters. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

SELECT

SELECT * FROM Invoices WHERE BusinessId = 'QnVzaW5lc3M6NjE2MTYtYzVlMS00YzkyLTg0Y2EtNzA0ZDM4MTcyNTdl'
SELECT * FROM Invoices WHERE CustomerID = 'QnVzaW5lc3M6NjE2MTY4NzVlMS00YzkyLTg0Y2EtNzA0ZDM4MTcyNTdlO0N1c3RvbWVyOjMyNzkyMTEz'
SELECT * FROM Invoices WHERE ModifiedAt < '2020-02-26 18:02:06.171'
SELECT * FROM Invoices WHERE InvoiceDate> = '2020-07-03'
SELECT * FROM Invoices WHERE Status = 'SENT'
SELECT * FROM Invoices WHERE CurrencyCode = 'USD'

Columns


Name	Type	References	SupportedOperators	Description
Id [KEY]	String			Unique identifier for the invoice.
BusinessId	String	Businesses.id		The unique identifier for the business.
CreatedAt	Datetime			When the invoice was created.
ModifiedAt	Datetime			When the invoice was last modified.
PdfUrl	String			URL to access PDF representation of the invoice.
ViewUrl	String			URL to view the invoice online as seen by a customer.
CustomerId	String	Customers.id		Unique identifier for the customer.
CustomerName	String			The customer's name.
Status	String			Status of the Invoice. 使用できる値は次のとおりです。DRAFT, OVERDUE, PAID, PARTIAL, SAVED, SENT, UNPAID, VIEWED
Title	String			Invoice title at the top of the document.
Subhead	String			Invoice subheading text.
InvoiceNumber	String			Unique number assigned to the invoice.
PoNumber	String			Purchase order or sales order number for the invoice.
InvoiceDate	Date			Date when invoice is issued.
DueDate	Date			Date when payment is due.
AmountDueValue	Decimal			Amount represented as a combination of the major and minor currency unit (uses a decimal separator).
AmountDueCurrencyCode	String	Currencies.Code		Currency code.
AmountPaidValue	Decimal			Amount represented as a combination of the major and minor currency unit (uses a decimal separator).
AmountPaidCurrencyCode	String	Currencies.Code		Currency code.
TaxTotalValue	Decimal			Amount represented as a combination of the major and minor currency unit (uses a decimal separator).
TaxTotalCurrencyCode	String	Currencies.Code		Currency code.
TotalValue	Decimal			Amount represented as a combination of the major and minor currency unit (uses a decimal separator).
TotalCurrencyCode	String	Currencies.Code		Currency code.
CurrencyCode	String	Currencies.Code		Currency code.
ExchangeRate	Decimal			Exchange rate to business's currency from the invoice's currency. Used to value the invoice income within Wave's accounting transactions.
Memo	String			Invoice memo (notes) text.
Footer	String			Invoice footer text.
DisableCreditCardPayments	Bool			Within a business that is enabled to accept credit card payments, indicates if this individual invoice has been marked to not be payable by card.
DisableBankPayments	Bool			Within a business that is enabled to accept bank payments, indicates if this individual invoice has been marked to not be payable by bank payment.
ItemTitle	String			The label for the 'Item' column in the line items listing.
UnitTitle	String			The label for the 'Unit' column in the listing of line items on the invoice.
PriceTitle	String			The label for the 'Price' column in the listing of line items on the invoice.
AmountTitle	String			The label for the 'Amount' (= unit x price) column in the listing of line items on the invoice.
HideName	Bool			Indicates whether item's product name in item column is hidden in the line items listing.
HideDescription	Bool			Indicates whether item's description in item column is hidden in the line items listing.
HideUnit	Bool			Indicates whether item's unit is hidden in the line items listing.
HidePrice	Bool			Indicates whether item's price is hidden in the line items listing.
HideAmount	Bool			Indicates whether item's amount is hidden in the line items listing.
LastSentAt	Datetime			When the invoice was last sent.
LastSentVia	String			How the invoice was last sent.
LastViewedAt	Datetime			When the invoice was last viewed by the customer.
DisableAmexPayments	Bool			Within a business that is enabled to accept credit card payments, indicates if this individual invoice has been marked to not be payable by American Express.

ProductDefaultSalesTaxes

Default sales taxes to apply on product.

Table Specific Information

The Sync App uses the Wave Financial API to process some of the filters. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

SELECT

SELECT * FROM ProductDefaultSalesTaxes WHERE ProductId = 'QnVzaW5lc3M6NjE2MTYtYzVlMS00YzkyLTg0Y'
SELECT * FROM ProductDefaultSalesTaxes WHERE BusinessId = 'QnVzaW5lc3M6NjE2MTY4NzVlMSyOjMyNzkyMTEz'

Columns


Name	Type	References	SupportedOperators	Description
Id [KEY]	String			The unique identifier for the sales tax.
ProductId [KEY]	String	Products.Id		Unique identifier for the product.
BusinessId	String	Businesses.Id		The unique identifier for the business.
Name	String			Name of the tax.
Abbreviation	String			A short form or code representing the sales tax.
Description	String			User defined description for the sales tax.
TaxNumber	String			The tax's issued identification number from a taxing authority.
ShowTaxNumberOnInvoices	Bool			Display tax number beside the tax name on an invoice.
Rate	Decimal			Tax rate effective on 'for' date, or current date if no parameter, as a decimal (e.g. 0.15 represents 15%).
IsCompound	Bool			Is a compound tax, or stacked tax. This tax is calculated on top of the subtotal and other tax amounts.
IsRecoverable	Bool			Is a recoverable tax. It is recoverable if you can deduct the tax that you as a business paid from the tax that you have collected.
IsArchived	Bool			Is the sales tax hidden from view by default.
CreatedAt	Datetime			When the sales tax was created.
ModifiedAt	Datetime			When the sales tax was last modified.

ProductDefaultSalesTaxRates

Tax rates with their effective dates of application.

Table Specific Information

The Sync App uses the Wave Financial API to process some of the filters. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

SELECT

SELECT * FROM ProductDefaultSalesTaxRates WHERE ProductId = 'QnVzaW5lc3M6NjE2MTYtYzVlMS00YzkyLTg0Y'
SELECT * FROM ProductDefaultSalesTaxRates WHERE BusinessId = 'QnVzaW5lc3M6NjE2MTY4NzVlMSyOjMyNzkyMTEz'

Columns


Name	Type	References	SupportedOperators	Description
SalesTaxId [KEY]	String	ProductDefaultSalesTaxes.Id		The unique identifier for the sales tax.
ProductId [KEY]	String	Products.Id		Unique identifier for the product.
BusinessId	String	Businesses.Id		The unique identifier for the business.
Effective	Date			Date from which the sales tax rate applies.
Rate	Decimal			Tax rate applying from the effective date as a decimal (e.g. 0.15 represents 15%).

Products

List of products (and services) for the business.

Table Specific Information

The Sync App uses the Wave Financial API to process some of the filters. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

SELECT

SELECT * FROM Products WHERE BusinessId = 'QnVzaW5lc3M6NjE2MTYtYzVlMS00YzkyLTg0Y2EtNzA0ZDM4MTcyNTdl'
SELECT * FROM Products WHERE Id = 'QzVlMS00YzkyLTg0Y2EtNzA0ZDM4MTcyNTdlO0N1c3RvbWVyOjMyNzkyMTEz'
SELECT * FROM Products WHERE IsSold = true
SELECT * FROM Products WHERE IsBought = true
SELECT * FROM Products WHERE IsArchived = true
SELECT * FROM Products WHERE ModifiedAt < '2020-07-03 08:28:56.0'

Columns


Name	Type	References	SupportedOperators	Description
Id [KEY]	String			Unique identifier for the product.
BusinessId	String	Businesses.id		The unique identifier for the business.
Name	String			Name of the product.
Description	String			Description of the product.
UnitPrice	Decimal			Price per unit in the major currency unit.
IsSold	Bool			Is product sold by the business. Allow this product or service to be added to Invoices.
IsBought	Bool			Is product bought by the business. Allow this product or service to be added to Bills.
IncomeAccountId	String	Accounts.Id		Unique identifier for the account.
ExpenseAccountId	String	Accounts.Id		Unique identifier for the account.
IsArchived	Bool			Is the product hidden from view by default.
CreatedAt	Datetime			When the product was created.
ModifiedAt	Datetime			When the product was last modified.

Provinces

List of principal subdivisions.

Table Specific Information

The Sync App uses the Wave Financial API to process some of the filters. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

SELECT

SELECT * FROM Provinces WHERE CountryCode = 'US'

Columns


Name	Type	References	SupportedOperators	Description
Code [KEY]	String			[ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) identifier.
CountryCode	String	Countries.Code		Country code.
Slug	String			Informal name for identification.
Name	String			Plain-language representation.

SalesTaxes

List of sales taxes for the business.

Table Specific Information

The Sync App uses the Wave Financial API to process some of the filters. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

SELECT

SELECT * FROM SalesTaxes WHERE Id = 'QnVzaW5lc3M6NjE2MTYtYzVlMS00YzkyLTg0Y2EtNzA0ZDM4MTcyNTdl'
SELECT * FROM SalesTaxes WHERE BusinessId = 'QnVzaW5lc3M6NjE2MTY4NzVlMS00YzkyLTg0Y2EtNzA0ZDM4MTcyNTdlO0N1c3RvbWVyOjMyNzkyMTEz'
SELECT * FROM SalesTaxes WHERE ModifiedAt < '2020-02-26 18:02:06.171'
SELECT * FROM SalesTaxes WHERE IsArchived = true

Columns


Name	Type	References	SupportedOperators	Description
Id [KEY]	String			The unique identifier for the sales tax.
BusinessId	String	Businesses.id		The unique identifier for the business.
Name	String			Name of the tax.
Abbreviation	String			A short form or code representing the sales tax.
Description	String			User defined description for the sales tax.
TaxNumber	String			The tax's issued identification number from a taxing authority.
ShowTaxNumberOnInvoices	Bool			Display tax number beside the tax name on an invoice.
Rate	Decimal			Tax rate effective on 'for' date, or current date if no parameter, as a decimal (e.g. 0.15 represents 15%).
IsCompound	Bool			Is a compound tax, or stacked tax. This tax is calculated on top of the subtotal and other tax amounts.
IsRecoverable	Bool			Is a recoverable tax. It is recoverable if you can deduct the tax that you as a business paid from the tax that you have collected.
IsArchived	Bool			Is the sales tax hidden from view by default.
CreatedAt	Datetime			When the sales tax was created.
ModifiedAt	Datetime			When the sales tax was last modified.

SalesTaxRates

Tax rates with their effective dates of application

Columns


Name	Type	References	SupportedOperators	Description
SalesTaxId [KEY]	String	SalesTaxes.Id		The unique identifier for the sales tax.
BusinessId	String	Businesses.Id		The unique identifier for the business.
Effective	Date			Date from which the sales tax rate applies.
Rate	Decimal			Tax rate applying from the effective date as a decimal (e.g. 0.15 represents 15%).

Vendors

List of vendors for the business.

Table Specific Information

The Sync App uses the Wave Financial API to process some of the filters. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

SELECT

SELECT * FROM Vendors WHERE Id = 'QnVzaW5lc3M6NjE2MTYtYzVlMS00YzkyLTg0Y2DM4MTcyNTdl'
SELECT * FROM Vendors WHERE ModifiedAt < '2020-02-26 18:02:06.171'

Columns


Name	Type	References	SupportedOperators	Description
Id [KEY]	String			Unique identifier for the customer.
BusinessId	String	Businesses.id		The unique identifier for the business.
Name	String			Name or business name of the vendor.
AddressLine1	String			Address line 1 (Street address/PO Box/Company name).
AddressLine2	String			Address line 2 (Apartment/Suite/Unit/Building).
AddressCity	String			City/District/Suburb/Town/Village.
AddressProvinceCode	String	Provinces.Code		[ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) identifier.
AddressCountryCode	String	Countries.Code		Country code.
AddressPostalCode	String			Zip/Postal Code.
FirstName	String			The first name of the principal contact.
LastName	String			The last name of the principal contact.
DisplayId	String			User defined id for the vendor. Commonly referred to as Account Number.
Email	String			Email of the principal vendor.
Mobile	String			The mobile number of the vendor.
Phone	String			The phone number of the vendor.
Fax	String			Fax number of the vendor.
TollFree	String			Toll-free number of the vendor.
Website	String			Website address of the vendor.
InternalNotes	String			Internal notes about the vendor.
CurrencyCode	String	Currencies.Code		Currency code.
ShippingName	String			Name or business name of the customer.
ShippingAddressLine1	String			Address line 1 (Street address/PO Box/Company name).
ShippingAddressLine2	String			Address line 2 (Apartment/Suite/Unit/Building).
ShippingAddressCity	String			City/District/Suburb/Town/Village.
ShippingAddressProvinceCode	String	Provinces.Code		[ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) identifier.
ShippingAddressCountryCode	String	Countries.Code		Country code.
ShippingAddressPostalCode	String			Zip/Postal Code.
ShippingPhone	String			Telephone number of the customer.
ShippingInstructions	String			Delivery instructions for handling.
CreatedAt	Datetime			When the vendor was created.
ModifiedAt	Datetime			When the vendor was last modified.
IsArchived	Bool			Whether or not the vendor is archived.

接続文字列オプション

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

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

Authentication

プロパティ	説明
AuthScheme	The type of authentication to use when connecting to Wave Financial.
APIToken	The API token obtained when you register a Wave Financial application.

OAuth

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

SSL

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

Firewall

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

Proxy

プロパティ	説明
ProxyAutoDetect	これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
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

プロパティ	説明
MaxRows	クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
Other	これらの隠しプロパティは特定のユースケースでのみ使用されます。
PseudoColumns	このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UserDefinedViews	カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

Authentication

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

プロパティ	説明
AuthScheme	The type of authentication to use when connecting to Wave Financial.
APIToken	The API token obtained when you register a Wave Financial application.

AuthScheme

The type of authentication to use when connecting to Wave Financial.

解説

Token: Set this to perform Wave Financial token authentication.
OAuth: Set this to perform Wave Financial OAuth authentication.

APIToken

The API token obtained when you register a Wave Financial application.

解説

You can obtain an API Token using the following steps:

Log in to your Wave Financial account and navigate to Manage Applications in the left pane.
Select the application that you would like to create a token for. You may need to create an application first.
Click the Create token button to generate an APIToken

OAuth

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

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

OAuthClientId

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

解説

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

OAuthClientSecret

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

解説

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

SSL

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

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

SSLServerCert

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

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

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

FirewallType

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

解説

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


タイプ	デフォルトポート	説明
TUNNEL	80	これが設定されている場合、Sync App はWave Financial への接続を開き、プロキシを経由して通信が行われます。
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 を使ってください。

FirewallServer

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

解説

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

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

FirewallPort

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

解説

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

FirewallUser

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

解説

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

FirewallPassword

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

解説

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

Proxy

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

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

ProxyAutoDetect

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

解説

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

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

ProxyServer

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

解説

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

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

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

ProxyPort

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

解説

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

ProxyAuthScheme

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 もしくはKereros トークンを取得します。
PROPRIETARY： Sync App はNTLM もしくはKerberos トークンを発行しません。このトークンを、HTTP リクエストのAuthorization ヘッダーに含める必要があります。

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

ProxyUser

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

解説

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

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

user@domain
domain\user

ProxyPassword

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 に設定します。

ProxySSLType

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	接続は、トンネリングプロキシを経由します。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。

ProxyExceptions

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

解説

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

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

Logging

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

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

LogModules

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

解説

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

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

Schema

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

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

Location

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

解説

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

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

BrowsableSchemas

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

解説

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

Tables

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

解説

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

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

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

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

Views

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

解説

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

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

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

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

Miscellaneous

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

プロパティ	説明
MaxRows	クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
Other	これらの隠しプロパティは特定のユースケースでのみ使用されます。
PseudoColumns	このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UserDefinedViews	カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

MaxRows

クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。

解説

クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。

Other

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

解説

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

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

統合およびフォーマット


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

PseudoColumns

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

解説

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

Timeout

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

解説

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

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

UserDefinedViews

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

解説

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

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

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

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

次に例を示します。

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

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

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