各製品の資料を入手。
詳細はこちら →DocuSign のデータをPowerShell でMySQL にレプリケーションする方法
PowerShell のシンプルなスクリプトで、DocuSign のデータ をMySQL データベースにレプリケーション(複製)する方法を紹介します。
最終更新日:2023-09-26
この記事で実現できるDocuSign 連携のシナリオ
こんにちは!ドライバー周りのヘルプドキュメントを担当している古川です。
CData Cmdlets for DocuSign を使えば、PowerShell からDocuSign のデータ データにリアルタイムで連携できます。データ同期などのタスクの連携にぴったりの製品です。 本記事では、PowerShell からCData Cmdlets for DocuSign およびCData Cmdlets for MySQL を使って、同期スクリプトを作成して実行します。
まずは、PowerShell でDocuSign への接続を行います。レプリケーションは4つのステップがあります。
DocuSign への接続には以下の接続プロパティを設定します:
- UseSandbox: UseSandbox は現在のユーザーアカウントがサンドボックスかそうでないかを示します。デフォルトはfalse です。サンドボックスアカウントがある場合はTrue に設定します。
- AccountId (optional): 認証が成功すると自動的に設定されます。 または、複数のAccount Id にアクセスできる場合は、接続文字列で手動で設定できます。アカウントId を取得するには、UserInfo ビューをクエリします。
DocuSign への認証
DocuSign はOAuth 認証標準を利用しています。OAuth を使って認証するには、アプリケーションを作成してOAuthClientId、OAuthClientSecret、およびCallbackURL 接続プロパティを取得しなければなりません。認証方法については、ヘルプドキュメントの「OAuth 認証の使用」を参照してください。
DocuSign のデータの取得
-
モジュールのインストール:
Install-Module DocuSignCmdlets
-
DocuSign への接続:
$docusign = Connect-DocuSign -OAuthClientId $OAuthClientId -OAuthClientSecret $OAuthClientSecret -CallbackURL $CallbackURL
-
取得ターゲットのリソースの取得:
$data = Select-DocuSign -Connection $docusign -Table "Documents"
Invoke-DocuSign cmdlet を使って、SQL-92 クエリを使用することもできます:
$data = Invoke-DocuSign -Connection $docusign -Query 'SELECT * FROM Documents WHERE DocumentName = @DocumentName' -Params @{'@DocumentName'='TPSReport'}
-
戻り値からカラム名のリストを保存します。
$columns = ($data | Get-Member -MemberType NoteProperty | Select-Object -Property Name).Name
DocuSign のデータをMySQL データベースにレプリケーション
カラム名を指定できるようにして、データをMySQL データベースにレプリケーションします。
-
モジュールのインストール:
Install-Module MySQLCmdlets
-
MySQL DB に、MySQL Server 名、ユーザー、パスワード、レプリケーション先のデータベース名を指定して、接続します:
$mysql = Connect-MySQL -User $User -Password $Password -Database $Database -Server $Server -Port $Port
-
DocuSign、保存された値、そしてAdd-MySQL Cmdlet を使って、MySQL にデータを1レコードずつ挿入します。この例では、MySQL 側のテーブルは、DocuSign のリソース(Documents)と同じテーブル名を持っている必要があります。
$data | % { $row = $_ $values = @() $columns | % { $col = $_ $values += $row.$($col) } Add-MySQL -Connection $mysql -Table "Documents" -Columns $columns -Values $values }
次回以降のレプリケーションをシンプルに実現
-
一度PowerShell でDocuSign とMySQL に接続したら、次からは1行のコマンドでレプリケーションを実施できます:
Select-DocuSign -Connection $docusign -Table "Documents" | % { $row = $_ $values = @() $columns | % { $col = $_ $values += $row.$($col) } Add-MySQL -Connection $mysql -Table "Documents" -Columns $columns -Values $values }
-
別のPowerShell モジュールで、DocuSign を別のデータベースに複製する場合、Select-DocuSign cmdlet のデータから、カラム、接続およびテーブルを除外しておきましょう。これらのデータはデータ移動のときだけ必要となるためです。
$columns = ($data | Get-Member -MemberType NoteProperty | Select-Object -Property Name).Name | ? {$_ -NotIn @('Columns','Connection','Table')}
おわりに
これで、DocuSign のデータをMySQL に複製できました。分析、BI などでDocuSign のデータをMySQL から使うことができるようになります。