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

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

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

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

Act CRM への接続を設定

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

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

    Import-Module ActCRMCmdlets;

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

    $conn = Connect-ActCRM  -URL "$URL" -User "$User" -Password "$Password" -ActDatabase "$ActDatabase"

Authentication セクションのUser とPassword プロパティに、有効なAct! ユーザー資格情報を設定する必要があります。認証値に加えて、以下も参照してください。

• Act! Premium への接続

  認証値に加えて、Act! へのURL も設定が必要です。例：https://eup1-iis-04.eu.hosted.act.com/。

  さらに、接続するActDatabase を指定する必要があります。これは、ご自分のアカウントの「About Act! Premium」メニューのページ右上にある「?」で確認することができます。表示されたウィンドウの「Database Name」を使用します。

• Act! Premium Cloud への接続

  Act! Premium Cloud アカウントに接続するには、ActCloudName プロパティも指定する必要があります。このプロパティはCloud アカウントのURL アドレスで確認できます。例：https://eup1-iis-04.eu.hosted.act.com/ActCloudName/。

ActCRM メタデータの取得は高負荷になる可能性があることに注意してください。CacheMetadata プロパティを設定して、メタデータをローカルに格納することをお勧めします。

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

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

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

Select-ActCRM -Connection $conn -Table Activities | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myActivitiesData.csv -NoTypeInformation

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

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

データの削除

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

Select-ActCRM -Connection $conn -Table Activities -Where "Subject = Sample subject" | Remove-ActCRM

データの挿入と更新

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

Import-Csv -Path C:\MyActivitiesUpdates.csv | %{
  $record = Select-ActCRM -Connection $ActCRM -Table Activities -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-ActCRM -Connection $actcrm -Table Activities -Columns ("ActivityDisplayName","Subject") -Values ($_.ActivityDisplayName, $_.Subject) -Where ("Id = `'"+$_.Id+"`'")
  }else{
    Add-ActCRM -Connection $actcrm -Table Activities -Columns ("ActivityDisplayName","Subject") -Values ($_.ActivityDisplayName, $_.Subject)
  }
}

おわりに

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