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

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

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

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

Dynamics CRM への接続を設定

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

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

    Import-Module DynamicsCRMCmdlets;

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

    $conn = Connect-DynamicsCRM  -User "$User" -Password "$Password" -URL "$URL" -CRM Version "$CRM Version"

Dynamics CRM 接続プロパティの取得・設定方法

Dynamics CRM では、インスタンスごとに接続文字列の設定が必要です。 Authentication セクションでは、有効なDynamics CRM のUser、Password の入力、およびDynamics CRM Server Organization root のURL を設定します。さらに、CRMVersion プロパティに、'CRM2011+' もしくは'CRMOnline' を設定します。IFD コンフィグレーションもサポートされていますので、InternetFacingDeployment をTRUE に設定してください。

また、Security Token Service（STS）、もしくはAD FS エンドポイントをSTSURL プロパティに設定することもできます。 この値はGetSTSUrl ストアドプロシージャで取得できます。 Office 365 ユーザーはデフォルトSTS URL にCRMVersion の設定だけで接続することができます。

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

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

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

Select-DynamicsCRM -Connection $conn -Table Account | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myAccountData.csv -NoTypeInformation

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

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

データの削除

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

Select-DynamicsCRM -Connection $conn -Table Account -Where "FirstName = Bob" | Remove-DynamicsCRM

データの挿入と更新

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

Import-Csv -Path C:\MyAccountUpdates.csv | %{
  $record = Select-DynamicsCRM -Connection $DynamicsCRM -Table Account -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-DynamicsCRM -Connection $dynamicscrm -Table Account -Columns ("FirstName","NumberOfEmployees") -Values ($_.FirstName, $_.NumberOfEmployees) -Where ("Id = `'"+$_.Id+"`'")
  }else{
    Add-DynamicsCRM -Connection $dynamicscrm -Table Account -Columns ("FirstName","NumberOfEmployees") -Values ($_.FirstName, $_.NumberOfEmployees)
  }
}

おわりに

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