接続の確立

TaxJar への接続を追加

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

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

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

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

Authenticating a TaxJar Account

To authenticate to the TaxJar API, you will need to first obtain the API Key from the TaxJar UI. Remember that the API is available only for Professional and Premium TaxJar plans. If you already have a Professional or Premium plan you can find the APIKey by logging in the TaxJar UI and going to Account->TaxJar API. After obtaining the API Key you can set the APIKey connection property. That's all you need to do for a successful connection.

Extra Notes

By default the Sync App will retrieve data of the last 3 months in case the entity supports date range filtering. You can use the StartDate to set the minimum creation date of the data retrieved.
If the API Key has been created for a sandbox API account please set UseSandbox to true in order for a successful connection.
In case you are using a sandbox API account please remember that not everything will work as expected. This is also documented in the TaxJar developer docs here: Sandbox Environment and here: Unsupported endpoints
The TaxJar API rate limiting is really generous. (10000 requests per minute for TaxJar Professional plans and 25000 per minute for the TaxJar Premium plans).
Because of the TaxJar API limits we are restricted to make an http request for each row in order to collect as much data as we can. We suggest to increase the value of the MaxThreads connection property.
The default value of MaxThreads has been set to 20 which means it will make at most 20 concurrent requests. To improve the performance of the Sync App consider increasing this value based on the machines resources.

高度な機能

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

ユーザー定義ビュー

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

SSL の設定

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

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

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

クエリ処理

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

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

ログ

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

SSL の設定

SSL 設定のカスタマイズ

デフォルトでは、Sync App はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。

別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。

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

Firewall またはProxy 経由の接続

HTTP プロキシ

HTTP プロキシへの認証には、以下のように設定します。

ProxyServer：HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyPort：プロキシサーバーが起動しているTCP ポート。
ProxyAuthScheme：プロキシサーバーに対して認証する際にSync App が使用する認証方法。
ProxyUser：プロキシサーバーに登録されているユーザーアカウントのユーザー名。
ProxyPassword：ProxyUser に紐付けられたパスワード。

その他のプロキシ

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

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

データモデル

概要

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

主要機能

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

ビュー

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

テーブル

テーブルでは、利用可能なテーブルを説明します。テーブルは、Customers、Orders、Refunds を静的にモデル化するように定義されています。

ストアドプロシージャ

ストアドプロシージャは、TaxJar のファンクションライクなインターフェースです。ストアドプロシージャを使用すると、消費税の計算や住所の検証を含むTaxJar の操作を実行できます。

テーブル

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

TaxJar Connector for CData Sync テーブル


Name	Description
Customers	Lists existing customers.
Orders	Lists existing order transactions.
Refunds	Lists existing refund transactions.

Customers

Lists existing customers.

Select

The Sync App will use the TaxJar API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

CustomerID supports the following operators: =,IN

The following queries are processed server side:

    SELECT * FROM Customers WHERE CustomerID = '123'
    SELECT * FROM Customers WHERE CustomerID IN ('123', '1234')

Insert

To add a Order, at least the TransactionID, TransactionDate, ToCountry, ToZip, ToState, Amount, Shipping, SalesTax need to be specified. Also, the Sync App can execute an insert in 2 ways.
Using an aggregate to specify the exempt regions:

  INSERT INTO Customers (CustomerID, ExemptionType, Name, Country, State, ZIP, City, Street, ExemptRegionsAggregate)
    VALUES ('123', 'wholesale', 'Dunder Mifflin Paper Company', 'US', 'PA', '18504', 'Scranton', '1725 Slough Avenue', 
      '[
          {
            "country": "US",
            "state": "FL"
          },
          {
            "country": "US",
            "state": "PA"
          }
      ]')

Or using temporary tables to specify the exempt regions:

INSERT INTO CustomerExemptRegions#TEMP (State, Country) VALUES ('PA', 'US')
INSERT INTO CustomerExemptRegions#TEMP (State, Country) VALUES ('FL', 'US')

INSERT INTO Customers (CustomerID, ExemptionType, Name, Country, State, ZIP, City, Street, ExemptRegionsAggregate)
VALUES ('123', 'wholesale', 'Dunder Mifflin Paper Company', 'US', 'PA', '18504', 'Scranton', '1725 Slough Avenue', 'CustomerExemptRegions#TEMP')

Update

Similarly to the Insert operation, the Sync App can update an item in 2 ways.
Using an aggregate to specify the exempt regions:

UPDATE Customers SET CustomerID = '123', ExemptionType = 'non_exempt', Name = 'egi', Country = 'US', State = 'CA', ZIP = '90002', City = 'Los Angeles', Street = '123 Palm Grove Ln', ExemptRegionsAggregate = '[
      {
        "country": "US",
        "state": "FL"
      },
      {
        "country": "US",
        "state": "PA"
      }
    ]' WHERE CustomerID = 123

And using temporary tables to specify the exempt regions:

INSERT INTO CustomerExemptRegions#TEMP (State, Country) VALUES ('PA', 'US')
INSERT INTO CustomerExemptRegions#TEMP (State, Country) VALUES ('FL', 'US')
UPDATE Customers SET CustomerID = '1', ExemptionType = 'non_exempt', Name = 'egi', Country = 'US', State = 'CA', ZIP = '90002', City = 'Los Angeles', Street = '123 Palm Grove Ln', ExemptRegionsAggregate = 'CustomerExemptRegions#TEMP' WHERE CustomerID = 123

Delete

In order to delete a Customer the CustomerID needs to be specified, for ex.

DELETE FROM Customers WHERE CustomerID = '100'

Columns


Name	Type	ReadOnly	Description
CustomerID [KEY]	String	False	Unique identifier of the given customer.
ExemptionType	String	False	Type of customer exemption: wholesale, government, other, or non_exempt.
Name	String	False	Name of the customer.
Country	String	False	Two-letter ISO country code of the customers primary address.
State	String	False	Two-letter ISO state code of the customers primary address.
ZIP	String	False	Postal code of the customers primary address.
City	String	False	City of the customers primary address.
Street	String	False	Street address of the customers primary address.
ExemptRegionsAggregate	String	False	Places where the customer is exempt.

Orders

Lists existing order transactions.

Select

The Sync App will use the TaxJar API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

TransactionDate supports the following operators: <,<=,=,>,>=
TransactionID supports the following operators: =,IN
Provider supports the following operator: = (By default the Provider is set to "api" which means that only data that has been created from the API will be retrieved.)

For the following query:

SELECT * FROM TableName

We have these 2 cases:

StartDate connection property is not set. The Sync App will retrieve data of the last 3 months.
StartDate connection property is set. The Sync App will retrieve data from the StartDate specified, until today.

The following queries are processed server side:

    SELECT * FROM TableName WHERE TransactionID = '200'
    SELECT * FROM TableName WHERE Provider = 'ebay'
    SELECT * FROM TableName WHERE TransactionID IN ('123', '122')
    SELECT * FROM TableName WHERE TransactionDate <= '2020/05/15' AND TransactionDate >= '2014/05/15'
    SELECT * FROM TableName WHERE TransactionDate < '2015/05/15' AND TransactionDate > '2014/05/15'
    SELECT * FROM TableName WHERE TransactionDate < '2015/05/15'
    SELECT * FROM TableName WHERE TransactionDate > '2015/05/15'
    SELECT * FROM TableName WHERE TransactionDate >= '2015/05/15'
    SELECT * FROM TableName WHERE TransactionDate = '2015/05/15'

Insert

To add a Order, at least the TransactionID, TransactionDate, ToCountry, ToZip, ToState, Amount, Shipping, SalesTax need to be specified. Also we can execute an insert in 2 ways.
Using an aggregate to specify the line items:

INSERT INTO Orders (TransactionID, UserID, TransactionDate, Provider, ExemptionType, FromCountry, FromZip, FromState, FromCity, FromStreet, ToCountry, ToZip, ToState, ToCity, ToStreet, Amount, Shipping, SalesTax, LineItemsAggregate)
        VALUES ('123', '2', '2015/05/05', 'api', 'non_exempt', 'US', '', 'NC', '', '', 'US', '90002', 'CA', 'Los Angeles', '123 Palm Grove Ln', '15', '0', 1, 
     '[
        {
          "id": 2,
          "quantity": 2,
          "product_identifier": "22-22222-2",
          "description": "Fuzzy Widget",
          "unit_price": 5,
          "sales_tax": 0.0
        },
        {
          "id": 1,
          "quantity": 1,
          "product_identifier": "11-11111-1",
          "description": "Fuzzy Widget",
          "unit_price": 5,
          "sales_tax": 0.0
        }
      ]')

Or using temporary tables to specify the line items:

INSERT INTO [OrderLineItems#TEMP] (ID, Quantity, ProductIdentifier, Description, ProductTaxCode, UnitPrice, Discount, SalesTax) VALUES ('1', '1', '11-11111-1', 'description 1', '', '5', '', '0.0')
INSERT INTO [OrderLineItems#TEMP] (ID, Quantity, ProductIdentifier, Description, ProductTaxCode, UnitPrice, Discount, SalesTax) VALUES ('2', '2', '22-22222-2', 'description 2', '', '5', '', '0.0')
INSERT INTO Orders (TransactionID, UserID, TransactionDate, Provider, ExemptionType, FromCountry, FromZip, FromState, FromCity, FromStreet, ToCountry, ToZip, ToState, ToCity, ToStreet, Amount, Shipping, SalesTax, LineItemsAggregate) 
        "VALUES ('123', '2', '2015/05/05', 'api', 'non_exempt', 'US', '', 'NC', '', '', 'US', '90002', 'CA', 'Los Angeles', '123 Palm Grove Ln', '15', '0', 1, 'OrderLineItems#TEMP')

Update

Similarly to the Insert operation we can update an item in 2 ways.
Using an aggregate to specify the line items:

    UPDATE Orders SET TransactionID = '111', UserID = '2', TransactionDate = '2015/05/05', Provider = 'api', ExemptionType = 'non_exempt', FromCountry = 'US', FromZip = '', FromState = 'NC', 
    FromCity = '', FromStreet = '', ToCountry = 'US', ToZip = '90002', ToState = 'CA', ToCity = 'Los Angeles', ToStreet = '123 Palm Grove Ln', Amount = '15', Shipping = '0', SalesTax = 1, 
    LineItemsAggregate = '[
    {
      "id": 2,
      "quantity": 2,
      "product_identifier": "22-22222-2",
      "description": "Fuzzy Widget",
      "unit_price": 5,
      "sales_tax": 0.0
    },
    {
      "id": 1,
      "quantity": 1,
      "product_identifier": "11-11111-1",
      "description": "Fuzzy Widget",
      "unit_price": 5,
      "sales_tax": 0.0
    }
  ]'

And using temporary tables to specify the line items:

INSERT INTO [OrderLineItems#TEMP] (ID, Quantity, ProductIdentifier, Description, ProductTaxCode, UnitPrice, Discount, SalesTax) VALUES ('1', '1', '11-11111-1', 'description 1', '', '5', '', '0.0')
INSERT INTO [OrderLineItems#TEMP] (ID, Quantity, ProductIdentifier, Description, ProductTaxCode, UnitPrice, Discount, SalesTax) VALUES ('2', '2', '22-22222-2', 'description 2', '', '5', '', '0.0')
UPDATE Orders SET TransactionID = '123', UserID = '2', TransactionDate = '2015/05/05', Provider = 'api', ExemptionType = 'non_exempt', FromCountry = 'US', FromZip = '', FromState = 'NC', FromCity = '', FromStreet = '', ToCountry = 'US', ToZip = '90002', ToState = 'CA', ToCity = 'Los Angeles', ToStreet = '123 Palm Grove Ln', Amount = '15', Shipping = '0', SalesTax = 1, LineItemsAggregate = 'OrderLineItems#TEMP' WHERE TransactionID = '123'

Delete

In order to delete an Order the TransactionID needs to be specified, for ex.

DELETE FROM Orders WHERE TransactionID = '100'

Columns


Name	Type	ReadOnly	Description
TransactionID [KEY]	String	False	Unique identifier of the given order transaction.
UserID	Int	False	Unique identifier of the user who created the order transaction.
TransactionDate	Date	False	The date/time the transaction was originally recorded.
Provider	String	False	Source of where the transaction was originally recorded.
ExemptionType	String	False	Type of exemption for the order: wholesale, government, marketplace, other, non_exempt, or null.
FromCountry	String	False	Two-letter ISO country code of the country where the order shipped from.
FromZip	String	False	Postal code where the order shipped from (5-Digit ZIP or ZIP+4).
FromState	String	False	Two-letter ISO state code where the order shipped from.
FromCity	String	False	City where the order shipped from.
FromStreet	String	False	Street address where the order shipped from.
ToCountry	String	False	Two-letter ISO country code of the country where the order shipped to.
ToZip	String	False	Postal code where the order shipped to (5-Digit ZIP or ZIP+4).
ToState	String	False	Two-letter ISO state code where the order shipped to.
ToCity	String	False	City where the order shipped to.
ToStreet	String	False	Street address where the order shipped to.
Amount	Double	False	Total amount of the order with shipping, excluding sales tax.
Shipping	Double	False	Total amount of shipping for the order.
SalesTax	Double	False	Total amount of sales tax collected for the order.
LineItemsAggregate	String	False	Street address where the order shipped to.

Refunds

Lists existing refund transactions.

Select

The Sync App will use the TaxJar API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

TransactionDate supports the following operators: <,<=,=,>,>=
TransactionID supports the following operators: =,IN
Provider supports the following operator: = (By default the Provider is set to "api" which means that only data that has been created from the API will be retrieved.)

For the following query:

SELECT * FROM TableName

We have these 2 cases:

StartDate connection property is not set. The Sync App will retrieve data of the last 3 months.
StartDate connection property is set. The Sync App will retrieve data from the StartDate specified, until today.

The following queries are processed server side:

    SELECT * FROM TableName WHERE TransactionID = '200'
    SELECT * FROM TableName WHERE Provider = 'ebay'
    SELECT * FROM TableName WHERE TransactionID IN ('123', '122')
    SELECT * FROM TableName WHERE TransactionDate <= '2020/05/15' AND TransactionDate >= '2014/05/15'
    SELECT * FROM TableName WHERE TransactionDate < '2015/05/15' AND TransactionDate > '2014/05/15'
    SELECT * FROM TableName WHERE TransactionDate < '2015/05/15'
    SELECT * FROM TableName WHERE TransactionDate > '2015/05/15'
    SELECT * FROM TableName WHERE TransactionDate >= '2015/05/15'
    SELECT * FROM TableName WHERE TransactionDate = '2015/05/15'

Insert

To add a Order, at least the TransactionID, TransactionDate, ToCountry, ToZip, ToState, Amount, Shipping, SalesTax need to be specified. Also we can execute an insert in 2 ways.
Using an aggregate to specify the line items:

INSERT INTO Refunds (TransactionID, UserID, TransactionDate, Provider, ExemptionType, FromCountry, FromZip, FromState, FromCity, FromStreet, ToCountry, ToZip, ToState, ToCity, ToStreet, Amount, Shipping, SalesTax, LineItemsAggregate)
        VALUES ('123', '2', '2015/05/05', 'api', 'non_exempt', 'US', '', 'NC', '', '', 'US', '90002', 'CA', 'Los Angeles', '123 Palm Grove Ln', '15', '0', 1, 
     '[
        {
          "id": 2,
          "quantity": 2,
          "product_identifier": "22-22222-2",
          "description": "Fuzzy Widget",
          "unit_price": 5,
          "sales_tax": 0.0
        },
        {
          "id": 1,
          "quantity": 1,
          "product_identifier": "11-11111-1",
          "description": "Fuzzy Widget",
          "unit_price": 5,
          "sales_tax": 0.0
        }
      ]')

Or using temporary tables to specify the line items:

INSERT INTO [RefundLineItems#TEMP] (ID, Quantity, ProductIdentifier, Description, ProductTaxCode, UnitPrice, Discount, SalesTax) VALUES ('1', '1', '11-11111-1', 'description 1', '', '5', '', '0.0')
INSERT INTO [RefundLineItems#TEMP] (ID, Quantity, ProductIdentifier, Description, ProductTaxCode, UnitPrice, Discount, SalesTax) VALUES ('2', '2', '22-22222-2', 'description 2', '', '5', '', '0.0')
INSERT INTO Refunds (TransactionID, UserID, TransactionDate, Provider, ExemptionType, FromCountry, FromZip, FromState, FromCity, FromStreet, ToCountry, ToZip, ToState, ToCity, ToStreet, Amount, Shipping, SalesTax, LineItemsAggregate) 
        "VALUES ('123', '2', '2015/05/05', 'api', 'non_exempt', 'US', '', 'NC', '', '', 'US', '90002', 'CA', 'Los Angeles', '123 Palm Grove Ln', '15', '0', 1, 'RefundLineItems#TEMP')

Update

Similarly to the Insert operation we can update an item in 2 ways.
Using an aggregate to specify the line items:

    UPDATE Refunds SET TransactionID = '111', UserID = '2', TransactionDate = '2015/05/05', Provider = 'api', ExemptionType = 'non_exempt', FromCountry = 'US', FromZip = '', FromState = 'NC', 
    FromCity = '', FromStreet = '', ToCountry = 'US', ToZip = '90002', ToState = 'CA', ToCity = 'Los Angeles', ToStreet = '123 Palm Grove Ln', Amount = '15', Shipping = '0', SalesTax = 1, 
    LineItemsAggregate = '[
    {
      "id": 2,
      "quantity": 2,
      "product_identifier": "22-22222-2",
      "description": "Fuzzy Widget",
      "unit_price": 5,
      "sales_tax": 0.0
    },
    {
      "id": 1,
      "quantity": 1,
      "product_identifier": "11-11111-1",
      "description": "Fuzzy Widget",
      "unit_price": 5,
      "sales_tax": 0.0
    }
  ]'

And using temporary tables to specify the line items:

INSERT INTO [RefundLineItems#TEMP] (ID, Quantity, ProductIdentifier, Description, ProductTaxCode, UnitPrice, Discount, SalesTax) VALUES ('1', '1', '11-11111-1', 'description 1', '', '5', '', '0.0')
INSERT INTO [RefundLineItems#TEMP] (ID, Quantity, ProductIdentifier, Description, ProductTaxCode, UnitPrice, Discount, SalesTax) VALUES ('2', '2', '22-22222-2', 'description 2', '', '5', '', '0.0')
UPDATE Refunds SET TransactionID = '123', UserID = '2', TransactionDate = '2015/05/05', Provider = 'api', ExemptionType = 'non_exempt', FromCountry = 'US', FromZip = '', FromState = 'NC', FromCity = '', FromStreet = '', ToCountry = 'US', ToZip = '90002', ToState = 'CA', ToCity = 'Los Angeles', ToStreet = '123 Palm Grove Ln', Amount = '15', Shipping = '0', SalesTax = 1, LineItemsAggregate = 'RefundLineItems#TEMP' WHERE TransactionID = '123'

Delete

In order to delete an Refund the TransactionID needs to be specified, for ex.

DELETE FROM Refunds WHERE TransactionID = '100'

Columns


Name	Type	ReadOnly	Description
TransactionID [KEY]	String	False	Unique identifier of the given refund transaction.
TransactionReferenceID	String	False	Unique identifier of the corresponding order transaction for the refund.
UserID	Int	False	Unique identifier of the user who created the refund transaction.
TransactionDate	Date	False	The date/time the transaction was originally recorded.
Provider	String	False	Source of where the transaction was originally recorded.
ExemptionType	String	False	Type of exemption for the order: wholesale, government, marketplace, other, non_exempt, or null.
FromCountry	String	False	Two-letter ISO country code of the country where the order shipped from.
FromZip	String	False	Postal code where the order shipped from (5-Digit ZIP or ZIP+4).
FromState	String	False	Two-letter ISO state code where the order shipped from.
FromCity	String	False	City where the order shipped from.
FromStreet	String	False	Street address where the order shipped from.
ToCountry	String	False	Two-letter ISO country code of the country where the order shipped to.
ToZip	String	False	Postal code where the order shipped to (5-Digit ZIP or ZIP+4).
ToState	String	False	Two-letter ISO state code where the order shipped to.
ToCity	String	False	City where the order shipped to.
ToStreet	String	False	Street address where the order shipped to.
Amount	Double	False	Total amount of the refunded order with shipping, excluding sales tax.
Shipping	Double	False	Total amount of shipping for the refunded order.
SalesTax	Double	False	Total amount of sales tax collected for the refunded order.
LineItemsAggregate	String	False	Street address where the order shipped to.

ビュー

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

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

TaxJar Connector for CData Sync ビュー


Name	Description
Categories	Lists all tax categories.
CustomerExemptRegions	Lists exempt regions of a customer.
NexusRegions	Lists existing nexus locations for a TaxJar account.
OrderLineItems	Lists existing order transactions.
RefundLineItems	Lists line items of an order transactions.
SummarizedRates	Retrieve minimum and average sales tax rates by region.

CustomerExemptRegions

Lists exempt regions of a customer.

Columns


Name	Type	Description
CustomerID [KEY]	String	Unique identifier of the given customer.
State	String	Two-letter ISO country code where the customer is exempt.
Country	String	Two-letter ISO state code where the customer is exempt.

NexusRegions

Lists existing nexus locations for a TaxJar account.

Columns


Name	Type	Description
CountryCode	String	Two-letter ISO country code for nexus region.
Country	String	Country name for nexus region.
RegionCode	String	Two-letter ISO region code for nexus region.
Region	String	Region name for nexus region.

OrderLineItems

Lists existing order transactions.

Select

The Sync App will use the TaxJar API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

TransactionDate supports the following operators: <,<=,=,>,>=
TransactionID supports the following operators: =,IN
Provider supports the following operator: = (By default the Provider is set to "api" which means that only data that has been created from the API will be retrieved.)

For the following query:

SELECT * FROM TableName

We have these 2 cases:

StartDate connection property is not set. The Sync App will retrieve data of the last 3 months.
StartDate connection property is set. The Sync App will retrieve data from the StartDate specified, until today.

The following queries are processed server side:

    SELECT * FROM TableName WHERE TransactionID = '200'
    SELECT * FROM TableName WHERE Provider = 'ebay'
    SELECT * FROM TableName WHERE TransactionID IN ('123', '122')
    SELECT * FROM TableName WHERE TransactionDate <= '2020/05/15' AND TransactionDate >= '2014/05/15'
    SELECT * FROM TableName WHERE TransactionDate < '2015/05/15' AND TransactionDate > '2014/05/15'
    SELECT * FROM TableName WHERE TransactionDate < '2015/05/15'
    SELECT * FROM TableName WHERE TransactionDate > '2015/05/15'
    SELECT * FROM TableName WHERE TransactionDate >= '2015/05/15'
    SELECT * FROM TableName WHERE TransactionDate = '2015/05/15'

Columns


Name	Type	Description
TransactionID [KEY]	String	Unique identifier of the given order transaction.
TransactionDate	Date	The date/time the transaction was originally recorded.
Provider	String	Source of where the transaction was originally recorded.
ID [KEY]	String	Unique identifier of the given line item.
Quantity	Int	Quantity for the item.
ProductIdentifier	String	Product identifier for the item.
Description	String	Description of the line item (up to 255 characters).
ProductTaxCode	String	Product tax code for the item.
UnitPrice	Double	Unit price for the item in dollars.
Discount	Double	Total discount (non-unit) for the item in dollars.
SalesTax	Double	Total sales tax collected (non-unit) for the item in dollars.

RefundLineItems

Lists line items of an order transactions.

Select

The Sync App will use the TaxJar API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

TransactionDate supports the following operators: <,<=,=,>,>=
TransactionID supports the following operators: =,IN
Provider supports the following operator: = (By default the Provider is set to "api" which means that only data that has been created from the API will be retrieved.)

For the following query:

SELECT * FROM TableName

We have these 2 cases:

StartDate connection property is not set. The Sync App will retrieve data of the last 3 months.
StartDate connection property is set. The Sync App will retrieve data from the StartDate specified, until today.

The following queries are processed server side:

    SELECT * FROM TableName WHERE TransactionID = '200'
    SELECT * FROM TableName WHERE Provider = 'ebay'
    SELECT * FROM TableName WHERE TransactionID IN ('123', '122')
    SELECT * FROM TableName WHERE TransactionDate <= '2020/05/15' AND TransactionDate >= '2014/05/15'
    SELECT * FROM TableName WHERE TransactionDate < '2015/05/15' AND TransactionDate > '2014/05/15'
    SELECT * FROM TableName WHERE TransactionDate < '2015/05/15'
    SELECT * FROM TableName WHERE TransactionDate > '2015/05/15'
    SELECT * FROM TableName WHERE TransactionDate >= '2015/05/15'
    SELECT * FROM TableName WHERE TransactionDate = '2015/05/15'

Columns


Name	Type	Description
TransactionID [KEY]	String	Unique identifier of the given order transaction.
TransactionDate	Date	The date/time the transaction was originally recorded.
Provider	String	Source of where the transaction was originally recorded.
ID [KEY]	String	Unique identifier of the given line item.
Quantity	Int	Quantity for the item.
ProductIdentifier	String	Product identifier for the item.
Description	String	Description of the line item (up to 255 characters).
ProductTaxCode	String	Product tax code for the item.
UnitPrice	Double	Unit price for the item in dollars.
Discount	Double	Total discount (non-unit) for the item in dollars.
SalesTax	Double	Total sales tax collected (non-unit) for the item in dollars.

SummarizedRates

Retrieve minimum and average sales tax rates by region.

Columns


Name	Type	Description
CountryCode	String	Two-letter ISO country code for summarized region.
Country	String	Country name for summarized region.
RegionCode	String	Two-letter ISO region code for summarized region.
Region	String	Region name for summarized region.
MinimumRateLabel	String	Region/state-only sales tax label.
MinimumRate	String	Region/state-only sales tax rate.
AverageRateLabel	String	Average rate for region/state label.
AverageRate	String	Average rate for region/state and local sales tax across all postal codes in the summarized region.

接続文字列オプション

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

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

Authentication

プロパティ	説明
APIKey	The APIKey obtained from the TaxJar UI.
UseSandbox	Whether to connect to the sandbox environment or not.

SSL

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

Firewall

プロパティ	説明
FirewallType	provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
FirewallServer	ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
FirewallPort	プロキシベースのファイアウォールで使用するTCP ポートを指定します。
FirewallUser	プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
FirewallPassword	プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

Proxy

プロパティ	説明
ProxyAutoDetect	provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
ProxyServer	HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyPort	クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー（ProxyServer 接続プロパティで設定）のTCP ポート。
ProxyAuthScheme	ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
ProxyUser	ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。
ProxyPassword	ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。
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	集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
MaxThreads	Specifies the number of concurrent requests.
Other	特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
PseudoColumns	テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
UserDefinedViews	カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

Other

プロパティ	説明
StartDate	Determines the start date of the transaction orders/refunds.

Authentication

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

プロパティ	説明
APIKey	The APIKey obtained from the TaxJar UI.
UseSandbox	Whether to connect to the sandbox environment or not.

APIKey

The APIKey obtained from the TaxJar UI.

解説

If you already have a Professional or Premium plan you can find the API Key by logging in the TaxJar UI and navigating to Account -> TaxJar API.

UseSandbox

Whether to connect to the sandbox environment or not.

解説

Set this to true to connect to the TaxJar sandbox environment. Remember that the APIKey must also be generated for the sandbox environment.

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	provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
FirewallServer	ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
FirewallPort	プロキシベースのファイアウォールで使用するTCP ポートを指定します。
FirewallUser	プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
FirewallPassword	プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

FirewallType

provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

Note：デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し、次のプロキシタイプのいずれかに接続するには、ProxyAutoDetect をfalse に設定します。

次の表は、サポートされている各プロトコルのポート番号情報です。


プロトコル	デフォルトポート	説明
TUNNEL	80	Sync App がTaxJar への接続を開くポート。トラフィックはこの場所のプロキシを経由して行き来します。
SOCKS4	1080	Sync App がTaxJar への接続を開くポート。SOCKS 4 は次にFirewallUser 値をプロキシに渡し、接続リクエストが許容されるかどうかを決定します。
SOCKS5	1080	Sync App がTaxJar にデータを送信するポート。SOCKS 5 プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。

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

FirewallServer

ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

FirewallPort

プロキシベースのファイアウォールで使用するTCP ポートを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

FirewallUser

プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

FirewallPassword

プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

Proxy

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

プロパティ	説明
ProxyAutoDetect	provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
ProxyServer	HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyPort	クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー（ProxyServer 接続プロパティで設定）のTCP ポート。
ProxyAuthScheme	ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
ProxyUser	ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。
ProxyPassword	ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。
ProxySSLType	ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。
ProxyExceptions	ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

ProxyAutoDetect

provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。

解説

この接続プロパティをTrue に設定すると、Sync App は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします（プロキシサーバーの詳細を手動で入力する必要はありません）。

この接続プロパティは他のプロキシ設定より優先されます。特定のプロキシサーバーに接続するためにSync App を手動で構成する場合は、False に設定します。

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

ProxyServer

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

解説

ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーを介してHTTP トラフィックをルーティングします。

ProxyPort

クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー（ProxyServer 接続プロパティで設定）のTCP ポート。

解説

ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーポートを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーポートを介してHTTP トラフィックをルーティングします。

その他のプロキシタイプについては、FirewallType を参照してください。

ProxyAuthScheme

ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。

解説

認証タイプは次のいずれかです。

BASIC：Sync App はHTTP BASIC 認証を行います。
DIGEST：Sync App はHTTP DIGEST 認証を行います。
NTLM：Sync App はNTLM トークンを取得します。
NEGOTIATE：Sync App は認証において有効なプロトコルに応じて、NTLM もしくはKerberos トークンを取得します。
NONE：ProxyServer が認証を必要としない場合に設定します。

"NONE" 以外のすべての値については、ProxyUser およびProxyPassword 接続プロパティも設定する必要があります。

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

ProxyUser

ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。

解説

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

ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。


ProxyAuthScheme の値	ProxyUser に設定する値
BASIC	プロキシサーバーに登録されているユーザーのユーザー名。
DIGEST	プロキシサーバーに登録されているユーザーのユーザー名。
NEGOTIATE	プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。`user@domain` または`domain\user` の形式で指定。
NTLM	プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。`user@domain` または`domain\user` の形式で指定。
NONE	ProxyPassword 接続プロパティは設定しないでください。

Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このユーザー名を使用します。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムのプロキシ設定で指定されているユーザー名を使用します。

ProxyPassword

ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。

解説

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

ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。


ProxyAuthScheme の値	ProxyPassword に設定する値
BASIC	ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。
DIGEST	ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。
NEGOTIATE	ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。
NTLM	ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。
NONE	ProxyPassword 接続プロパティは設定しないでください。

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

Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このパスワードを使用します。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムのプロキシ設定で指定されているパスワードを使用します。

ProxySSLType

ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。

解説

このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この接続プロパティには、以下の値を設定できます。


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

ProxyExceptions

ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

解説

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

Sync App はデフォルトでシステムプロキシ設定を使用するため、それ以上の設定は必要ありません。この接続にプロキシ例外を明示的に設定する場合は、ProxyAutoDetect をFalse に設定します。

Logging

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

プロパティ	説明
LogModules	ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

LogModules

ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

解説

このプロパティは、含めるログモジュールを指定することでログファイルの内容をカスタマイズすることができます。ログモジュールは、クエリ実行、メタデータ、SSL 通信などの異なる領域にログ情報を分類します。各モジュールは4文字のコードで表され、文字の名前の場合は末尾にスペースが必要なものもあります。

例えば、EXEC はクエリ実行をログに記録し、INFO は一般的なプロバイダーメッセージをログに記録します。複数のモジュールを含めるには、次のように名前をセミコロンで区切ります：INFO;EXEC;SSL。

Verbosity 接続プロパティは、このプロパティで指定されたモジュールベースのフィルタリングよりも優先されます。 Verbosity レベルを満たし、指定されたモジュールに属するログエントリのみが記録されます。利用可能なすべてのモジュールをログファイルに含めるには、このプロパティを空白のままにします。

利用可能なモジュールの完全なリストとログの設定に関する詳細な手引きについては、ログの「高度なログの記録」セクションを参照してください。

Schema

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

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
BrowsableSchemas	レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
Views	レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。

Location

テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。

解説

Location プロパティは、定義をカスタマイズしたり（例えば、カラム名を変更する、カラムを無視するなど）、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。

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


プラットフォーム	%APPDATA%
Windows	APPDATA 環境変数の値
Linux	~/.config

BrowsableSchemas

レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

解説

利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

Tables

レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。

解説

データベースによっては、利用可能なすべてのテーブルをリストするのに時間がかかり、パフォーマンスが低下する場合があります。接続文字列にテーブルのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

利用可能なテーブルがたくさんあり、すでに作業したいテーブルが決まっている場合、このプロパティを使用して対象のテーブルのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。

Note：複数のスキーマまたはカタログを持つデータソースに接続する場合は、表示する各テーブルを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するテーブルが混同されることを防ぎます。

Views

レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。

解説

データベースによっては、利用可能なすべてのビューをリストするのに時間がかかり、パフォーマンスが低下する場合があります。接続文字列にビューのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

利用可能なビューがたくさんあり、すでに作業したいビューが決まっている場合、このプロパティを使用して対象のビューのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。

Note：複数のスキーマまたはカタログを持つデータソースに接続する場合は、確認する各ビューを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するビューが混同されることを防ぎます。

Miscellaneous

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

プロパティ	説明
MaxRows	集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
MaxThreads	Specifies the number of concurrent requests.
Other	特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
PseudoColumns	テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
UserDefinedViews	カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

MaxRows

集計やGROUP BY を使用しないクエリで返される最大行数を指定します。

解説

このプロパティは、集計やGROUP BY 句を含まないクエリに対してSync App が返す行数の上限を設定します。この制限により、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。 MaxRows が"-1" に設定されている場合、LIMIT 句が明示的にクエリに含まれていない限り、行の制限は行われません。

このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し過剰なリソース消費を防ぐのに役立ちます。

MaxThreads

Specifies the number of concurrent requests.

解説

This property allows you to issue multiple requests simultaneously, thereby improving performance.

The TaxJar API has a rate limit of 10000 requests per minute for TaxJar Professional plans and 25000 per minute for the TaxJar Premium plans.

Because of the TaxJar API limits, the Sync App is restricted to making an http request for each row in order to collect as much data as possible.

To improve the performance of the Sync App consider increasing this value based on the machine's resources.

Other

特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。

解説

このプロパティは、シニアユーザーが特定のシナリオに対して隠しプロパティを設定できるようにします。これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。複数のプロパティをセミコロン区切りのリストで定義できます。

Note： 特定のシナリオや問題に対処するためにサポートチームから助言があった場合にのみ、これらのプロパティを設定することを強く推奨します。

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

統合およびフォーマット


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

PseudoColumns

テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。

解説

このプロパティを使用すると、Sync App がテーブルカラムとして公開する擬似カラムを定義できます。

個々の擬似カラムを指定するには、以下の形式を使用します。"Table1=Column1;Table1=Column2;Table2=Column3"

すべてのテーブルのすべての擬似カラムを含めるには、次のようにします："*=*"

Timeout

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。

解説

このプロパティは、Sync App が操作をキャンセルする前に操作の完了を待機する最大時間を秒単位で制御します。操作の完了前にタイムアウト時間が経過すると、Sync App は操作をキャンセルして例外をスローします。

タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。

このプロパティを0に設定するとタイムアウトが無効になり、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

UserDefinedViews

カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

解説

このプロパティを使用すると、UserDefinedViews.json というJSON 形式の構成ファイルを通じてカスタムビューを定義および管理できます。これらのビューはSync App によって自動的に認識され、標準のデータベースビューのようにカスタムSQL クエリを実行できるようになります。 JSON ファイルは、各ビューをルート要素として定義し、その子要素として"query" を持ちます。この"query" にはビューのSQL クエリが含まれています。次に例を示します。

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

このプロパティを使用して、1つのファイルに複数のビューを定義し、ファイルパスを指定できます。例：UserDefinedViews=C:\Path\To\UserDefinedViews.json。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。

詳しくは、ユーザー定義ビューを参照してください。

Other

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

プロパティ	説明
StartDate	Determines the start date of the transaction orders/refunds.

StartDate

Determines the start date of the transaction orders/refunds.

解説

By default the orders or refunds retrieved from the API will be those of the last 3 months. In order to change this range please set this connection property to a desired date using the format YYYY/MM/DD.

TaxJar Connector for CData Sync

TaxJar Connector for CData Sync

概要

TaxJar バージョンサポート

接続の確立

TaxJar への接続を追加

Authenticating a TaxJar Account

Extra Notes

高度な機能

ユーザー定義ビュー

SSL の設定

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

クエリ処理

ログ

SSL の設定

SSL 設定のカスタマイズ

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

Firewall またはProxy 経由の接続

HTTP プロキシ

その他のプロキシ

データモデル

概要

主要機能

ビュー

テーブル

ストアドプロシージャ

テーブル

TaxJar Connector for CData Sync テーブル

Customers

Select

Insert

Update

Delete

Columns

Orders

Select

Insert

Update

Delete

Columns

Refunds

Select

Insert

Update

Delete

Columns

ビュー

TaxJar Connector for CData Sync ビュー

Categories

Columns

CustomerExemptRegions

Columns

NexusRegions

Columns

OrderLineItems

Select

Columns

RefundLineItems

Select

Columns

SummarizedRates

Columns

接続文字列オプション

Authentication

APIKey

解説

UseSandbox

解説

SSL

SSLServerCert

解説

Firewall

FirewallType

解説

FirewallServer

解説

FirewallPort

解説

FirewallUser

解説