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

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

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

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

DocuSign への接続を設定

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

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

    Import-Module DocuSignCmdlets;

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

    $conn = Connect-DocuSign  -OAuthClientId "$OAuthClientId" -OAuthClientSecret "$OAuthClientSecret" -CallbackURL "$CallbackURL"

DocuSign への接続には以下の接続プロパティを設定します:

• UseSandbox: UseSandbox は現在のユーザーアカウントがサンドボックスかそうでないかを示します。デフォルトはfalse です。サンドボックスアカウントがある場合はTrue に設定します。
• AccountId (optional): 認証が成功すると自動的に設定されます。 または、複数のAccount Id にアクセスできる場合は、接続文字列で手動で設定できます。アカウントId を取得するには、UserInfo ビューをクエリします。

DocuSign への認証

DocuSign はOAuth 認証標準を利用しています。OAuth を使って認証するには、アプリケーションを作成してOAuthClientId、OAuthClientSecret、およびCallbackURL 接続プロパティを取得しなければなりません。認証方法については、ヘルプドキュメントの「OAuth 認証の使用」を参照してください。

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

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

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

Select-DocuSign -Connection $conn -Table Documents | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myDocumentsData.csv -NoTypeInformation

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

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

データの削除

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

Select-DocuSign -Connection $conn -Table Documents -Where "DocumentName = TPSReport" | Remove-DocuSign

データの挿入と更新

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

Import-Csv -Path C:\MyDocumentsUpdates.csv | %{
  $record = Select-DocuSign -Connection $DocuSign -Table Documents -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-DocuSign -Connection $docusign -Table Documents -Columns ("DocumentId","DocumentName") -Values ($_.DocumentId, $_.DocumentName) -Where ("Id = `'"+$_.Id+"`'")
  }else{
    Add-DocuSign -Connection $docusign -Table Documents -Columns ("DocumentId","DocumentName") -Values ($_.DocumentId, $_.DocumentName)
  }
}

おわりに

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