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

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

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

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

ADP への接続を設定

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

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

    Import-Module ADPCmdlets;

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

    $conn = Connect-ADP  -OAuthClientId "$OAuthClientId" -OAuthClientSecret "$OAuthClientSecret" -SSLClientCert "$SSLClientCert" -SSLClientCertPassword "$SSLClientCertPassword"

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

接続を確立する前に、ADP に連絡してOAuth アプリとそれに関連するクレデンシャルを提供してもらう必要があります。 これらのクレデンシャルはADP からのみ取得が可能で、直接取得することはできません。

ADP への接続

次のプロパティを指定してADP に接続します。

• OAuthClientId：ADP より提供されたアプリのクライアントId に設定。
• OAuthClientSecret：ADP より提供されたアプリのクライアントシークレットに設定。
• SSLClientCert：ADP より提供された証明書に設定。
• SSLClientCertPassword：証明書のパスワードに設定。
• UseUAT：CData 製品はデフォルトで、本番環境にリクエストを行います。開発者アカウントを使用している場合は、UseUAT をtrue に設定します。
• RowScanDepth：テーブルで利用可能なカスタムフィールドカラムをスキャンする行数の最大値。デフォルト値は100に設定されています。大きい値を設定すると、パフォーマンスが低下する場合があります。

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

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

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

Select-ADP -Connection $conn -Table Workers | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myWorkersData.csv -NoTypeInformation

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

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

データの削除

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

Select-ADP -Connection $conn -Table Workers -Where "AssociateOID = G3349PZGBADQY8H8" | Remove-ADP

データの挿入と更新

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

Import-Csv -Path C:\MyWorkersUpdates.csv | %{
  $record = Select-ADP -Connection $ADP -Table Workers -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-ADP -Connection $adp -Table Workers -Columns ("AssociateOID","WorkerID") -Values ($_.AssociateOID, $_.WorkerID) -Where ("Id = `'"+$_.Id+"`'")
  }else{
    Add-ADP -Connection $adp -Table Workers -Columns ("AssociateOID","WorkerID") -Values ($_.AssociateOID, $_.WorkerID)
  }
}

おわりに

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