接続の確立

CData Cmdlets ユーザーは、データモジュールをインストールし、接続プロパティを設定してスクリプトを開始できます。このセクションでは、CSV インポートおよびエクスポートcmdlet などのネイティブPowerShell cmdlet でTaxJar Cmdlets を使用する例を示します。

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 本製品 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 本製品 consider increasing this value based on the machines resources.

接続オブジェクトの作成

Connect-TaxJar cmdlet を使って、別のcmdlet に渡すことができる接続オブジェクトを作成します。

$conn = Connect-TaxJar -APIKey "3bb04218ef8t80efdf1739abf7257144"

データの取得

Select-TaxJar cmdlet はデータを取得するためのネイティブなPowerShell インターフェースを提供します。

$results = Select-TaxJar -Connection $conn -Table "Orders" -Columns @("TransactionID, UserID") -Where "TransactionID='123'"

Invoke-TaxJar cmdlet はSQL インターフェースを提供します。このcmdlet を使うと、Query パラメータを介してSQL クエリを実行できます。

cmdlet 出力のパイプ処理

cmdlet は行オブジェクトをパイプラインに一度に一行ずつ返します。以下は、結果をCSV ファイルにエクスポートします。

Select-TaxJar -Connection $conn -Table Orders -Where "TransactionID = '123'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myOrdersData.csv -NoTypeInformation

Select-TaxJar からの結果をSelect-Object cmdlet にパイプして、Export-CSV cmdlet にパイプする前にいくつかのプロパティを実行していることがわかるでしょう。これをする理由は、CData Cmdlets は接続、テーブル、およびカラムの情報を結果セットの各行オブジェクトに追加しますが、必ずしもその情報がCSV ファイルに必要ではないからです。

ただし、これによってcmdlet の出力を別のcmdlet にパイプすることが容易になります。以下に、結果セットをJSON に変換する例を示します。

 
PS C:\> $conn  = Connect-TaxJar -APIKey "3bb04218ef8t80efdf1739abf7257144"
PS C:\> $row = Select-TaxJar -Connection $conn -Table "Orders" -Columns (TransactionID, UserID) -Where "TransactionID = '123'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "Orders",
  "Columns":  [

  ],
  "TransactionID":  "MyTransactionID",
  "UserID":  "MyUserID"
}

データの削除

以下は、抽出条件に合うあらゆるレコードを削除します。

Select-TaxJar -Connection $conn -Table Orders -Where "TransactionID = '123'" | Remove-TaxJar

データの変更

cmdlet はデータクレンジング同様、データの変換を容易にします。次の例は、レコードがすでに存在するかどうか、挿入する前に更新が必要かどうかをチェックしてから、CSV ファイルのデータをTaxJar にロードします。

Import-Csv -Path C:\MyOrdersUpdates.csv | %{
  $record = Select-TaxJar -Connection $conn -Table Orders -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-TaxJar -Connection $conn -Table Orders -Columns @("TransactionID","UserID") -Values @($_.TransactionID, $_.UserID) -Where "Id  = `'$_.Id`'"
  }else{
    Add-TaxJar -Connection $conn -Table Orders -Columns @("TransactionID","UserID") -Values @($_.TransactionID, $_.UserID)
  }
}

Cmdlets for TaxJar