接続の確立

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

インストールおよび接続

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

Install-Module SugarCRMCmdlets

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

Import-Module SugarCRMCmdlets;

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

$conn = Connect-SugarCRM -URL 'http://mySugarCRM.com' -User 'myUser' -Password 'myPassword'

SugarCRM への接続

SugarCRM への接続を確立するには、URL をhttp://{sugar crm instance}.com の形式でSugarCRM アカウントに紐付いているURL に設定します。

SugarCRM への認証

本製品をSugarCRM に認証するには、以下を設定します。

User：SugarCRM アカウントのユーザー。
Password：SugarCRM ユーザーに紐付けられたパスワード。
Platform（オプション）：認証中にログインの競合が発生した場合は、SugarCRM UI で作成したプラットフォームのいずれかに設定。

デフォルトでは、SugarCRM は"sugar" クライアントId を認証に使用しますが、ユーザーはオプションでカスタムアプリのクライアントId とクライアントシークレットの値を指定することができます。詳しくは、カスタムOAuth アプリケーションの作成を参照してください。

OAuthClientId：カスタムOAuth アプリのクライアントId。
OAuthClientSecret：カスタムOAuth アプリのクライアントシークレット。

SugarCRM メタデータのキャッシュ

SugarCRM メタデータの取得は高負荷になる可能性があることに注意してください。メタデータのキャッシュで説明しているように、メタデータをローカルに格納することをお勧めします。

データの取得

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

$results = Select-SugarCRM -Connection $conn -Table "Accounts" -Columns @("Name, Industry") -Where "Industry='Manufacturing'"

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

cmdlet 出力のパイプ処理

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

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

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

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

 
PS C:\> $conn  = Connect-SugarCRM -URL 'http://mySugarCRM.com' -User 'myUser' -Password 'myPassword'
PS C:\> $row = Select-SugarCRM -Connection $conn -Table "Accounts" -Columns (Name, Industry) -Where "Industry = 'Manufacturing'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

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

  ],
  "Name":  "MyName",
  "Industry":  "MyIndustry"
}

データの削除

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

Select-SugarCRM -Connection $conn -Table Accounts -Where "Industry = 'Manufacturing'" | Remove-SugarCRM

データの変更

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

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

Cmdlets for SugarCRM