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

インストールおよび接続

PSGet がある場合は、PowerShell Gallery から次のコマンドを使ってcmdlet をインストールできます。CData サイトからセットアップを取得することもできます。

Install-Module ZohoBooksCmdlets

プロファイルに以下を追加すると、次のセッションでcmdlet がロードされます。

Import-Module ZohoBooksCmdlets;

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

$conn = -InitiateoAuth "GETANDREFRESH" -OrganizationId "YourOrganizationId" -AccountsServer "YourAccountServerURL"

Authenticating to Zoho Books

Zoho Books uses the OAuth authentication standard. To authenticate using OAuth, you will need to create an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties. See OAuth 認証の使用 for an authentication guide.

データの取得

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

$results = Select-ZohoBooks -Connection $conn -Table "INVOICES" -Columns @("InvoiceId, InvoiceNumber") -Where "CustomerName='NewTech Industries'"

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

cmdlet 出力のパイプ処理

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

Select-ZohoBooks -Connection $conn -Table INVOICES -Where "CustomerName = 'NewTech Industries'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myINVOICESData.csv -NoTypeInformation

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

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

 
PS C:\> $conn  = -InitiateoAuth "GETANDREFRESH" -OrganizationId "YourOrganizationId" -AccountsServer "YourAccountServerURL"
PS C:\> $row = Select-ZohoBooks -Connection $conn -Table "INVOICES" -Columns (InvoiceId, InvoiceNumber) -Where "CustomerName = 'NewTech Industries'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "INVOICES",
  "Columns":  [

  ],
  "InvoiceId":  "MyInvoiceId",
  "InvoiceNumber":  "MyInvoiceNumber"
} 

データの削除

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

Select-ZohoBooks -Connection $conn -Table INVOICES -Where "CustomerName = 'NewTech Industries'" | Remove-ZohoBooks

データの変更

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

Import-Csv -Path C:\MyINVOICESUpdates.csv | %{
  $record = Select-ZohoBooks -Connection $conn -Table INVOICES -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-ZohoBooks -Connection $conn -Table INVOICES -Columns @("InvoiceId","InvoiceNumber") -Values @($_.InvoiceId, $_.InvoiceNumber) -Where "Id  = `'$_.Id`'"
  }else{
    Add-ZohoBooks -Connection $conn -Table INVOICES -Columns @("InvoiceId","InvoiceNumber") -Values @($_.InvoiceId, $_.InvoiceNumber)
  }
}