接続の確立

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

インストールおよび接続

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

Install-Module ZohoCRMCmdlets

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

Import-Module ZohoCRMCmdlets;

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

$conn = Connect-ZohoCRM

Zoho CRM への認証

本製品はすでにZoho CRM にOAuth アプリケーションとして登録されています。そのため、デフォルトでは、自動的に埋め込みクレデンシャルを使用して接続します。

独自のカスタムOAuth アプリを使用したい場合は、カスタムクレデンシャルを参照してください。

Zoho CRM 本製品はパフォーマンスを向上させるためにデフォルトでUseServerSideFiltering がTrue に設定されていますが、誤った結果が返される場合があります。

データの取得

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

$results = Select-ZohoCRM -Connection $conn -Table "Accounts" -Columns @("AccountName, AccountNumber") -Where "Industry='Data/Telecom OEM'"

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

cmdlet 出力のパイプ処理

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

Select-ZohoCRM -Connection $conn -Table Accounts -Where "Industry = 'Data/Telecom OEM'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myAccountsData.csv -NoTypeInformation

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

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

 
PS C:\> $conn  = Connect-ZohoCRM
PS C:\> $row = Select-ZohoCRM -Connection $conn -Table "Accounts" -Columns (AccountName, AccountNumber) -Where "Industry = 'Data/Telecom OEM'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "Accounts",
  "Columns":  [

  ],
  "AccountName":  "MyAccountName",
  "AccountNumber":  "MyAccountNumber"
}

データの削除

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

Select-ZohoCRM -Connection $conn -Table Accounts -Where "Industry = 'Data/Telecom OEM'" | Remove-ZohoCRM

データの変更

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

Import-Csv -Path C:\MyAccountsUpdates.csv | %{
  $record = Select-ZohoCRM -Connection $conn -Table Accounts -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-ZohoCRM -Connection $conn -Table Accounts -Columns @("AccountName","AccountNumber") -Values @($_.AccountName, $_.AccountNumber) -Where "Id  = `'$_.Id`'"
  }else{
    Add-ZohoCRM -Connection $conn -Table Accounts -Columns @("AccountName","AccountNumber") -Values @($_.AccountName, $_.AccountNumber)
  }
}