PowerShell からSugar CRM のデータに接続してデータの取得・更新・挿入・削除・CSV エクスポートを実行する方法

CData Cmdlets for SugarCRM を使えば、PowerShell からSugar CRM に手軽に連携して、データのCRUD やエクスポートを実行できます。

本記事では、Sugar CRM への接続方法からCSV エクスポート、データの操作までサンプルコード付きで解説していきます。

Sugar CRM への接続を設定

それでは、まずはSugar CRM への接続設定からはじめていきましょう。接続設定にはCData Sugar CRM Cmdlets が必要となります。右側のサイドバーから製品の全機能が使える30日間の無償トライアルがダウンロードできるので、ぜひご利用ください。

インストールが完了したら、プロファイルに以下の行を追加してください。次のPowerShell セッションでモジュールがロードされます。

    Import-Module SugarCRMCmdlets;

Connect-SugarCRM コマンドを使ってSugar CRM との接続を設定します。各接続プロパティの取得方法は次に説明します。

    $conn = Connect-SugarCRM  -User "$User" -Password "$Password" -URL "$URL" -CacheMetadata "$CacheMetadata"

CData 製品をSugarCRM に認証するには、以下を有効なSugarCRM ユーザー資格情報に設定する必要があります。User：SugarCRM アカウントのユーザー。Password：SugarCRM アカウントのパスワード。

OAuth consumer key とconsumer secret は、Admin -> OAuth Keys で生成することができます。OAuthClientId にOAuth consumer key を、OAuthClientSecret にconsumer secret　を設定します。

さらに、SugarCRM への接続を確立するには以下を指定します。URL：'http://{sugar crm instance}.com' の形式で、SugarCRM アカウントに紐付いているURL に設定。Platform：認証中にログインの競合が発生した場合は、SugarCRM UI で作成したプラットフォームのいずれかに設定。

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

これで接続設定は完了です。

Sugar CRM のデータを取得してCSV にパイプライン

接続が完了したので、Accounts テーブルデータを取得して結果をCSV ファイルにエクスポートします。

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

このコードでは、Select-SugarCRM から取得した結果をSelect-Object に流して、Export-Csv に渡す前にいくつかのプロパティを除外しています。これは、CData Cmdlets が接続情報、テーブル、およびカラム情報を結果セットのそれぞれの行に挿入するためです。それらの情報を表示したくない場合に、Export-Csv コマンドに渡す前に除外を先に行い、そのあとでCSV ファイルにエクスポートします。

それでは、続いてデータの削除や挿入・更新を実行してみます。

データの削除

以下のように、フィルタリングで合致するレコードを削除することができます。

Select-SugarCRM -Connection $conn -Table Accounts -Where "Name = Bob" | Remove-SugarCRM

データの挿入と更新

データの挿入や更新を使って、加工やクレンジングも行えます。以下の手順では、CSV ファイルのデータを読み込んで挿入対象のオブジェクトに同じレコードが存在するかを確認した上で、存在する場合にはデータを更新、存在しない場合にはデータの挿入を行います。

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

おわりに

このように、CData Cmdlets を使えばPowerShell でのSugar CRM のデータへの連携をシンプルに実現できます。ぜひCData PowerShell Cmdlets の30日間無償トライアルをダウンロードして、シンプルかつパワフルなデータ連携をお試しください。