ETL/ELT のEmbulk を使ってDocuSign データをDB にロードする方法

詳細情報をご希望ですか?

無償トライアル:

ダウンロードへ

製品の詳細情報へ:

DocuSign JDBC Driver

DocuSign のAccounts、Envelopes、Folders データに連携するJava アプリケーションを素早く、簡単に開発できる便利なドライバー。



OSS のETL/ELT ツールEmbulk のJDBC Plugin を使って、DocuSign データを簡単にDM に同期する方法。

Embulk は、大量のデータをDB、クラウドデータストア、DWH にロードできるオープンソースETL ツールです。近頃のトレンドでは、1社で複数のオンプレアプリやSaaS を使っており、データ分析にはETL/ELT ツールを使ってデータを丸ごとDB/DWH にロードしてから、分析やビジュアライズをすることが主流になっています。Embulk には、いろいろなプラグインがあり、多様なInput とOutput 処理をサポートしています。この記事では、Embulk のJDBC Input Plugin と CData Drivers for DocuSign を使って、DocuSign のデータを簡単にDB にロードします。この例ではロード先のDB にはMySQL を使います。

※製品について詳しい情報をご希望の方は以下からお進みください。

Embulk でCData JDBC Driver for DocuSign データをロード

  • CData JDBC Driver for DocuSign をEmbulk と同じマシンにインストールします。
  • 以下のパスにJDBC Driver がインストールされます。後ほどこのパスを使います。
    C:\Program Files\CData\CData JDBC Driver for DocuSign 2019J\lib\cdata.jdbc.docusign.jar
  • 次に、EmbulkとCData JDBC Driverをつなぎこむための、JDBC Input Plugin をインストールします。
    https://github.com/embulk/embulk-input-jdbc/tree/master/embulk-input-jdbc
  • embulk gem install embulk-input-jdbc
  • 今回はロード先DB としてMySQL を使います。ほかにもSQL Server、PostgreSQL、Google BigQuery などを使うことも可能です。
    https://github.com/embulk/embulk-output-jdbc/tree/master/embulk-output-mysql embulk gem install embulk-output-mysql
  • config ファイルを作成し、DocuSign -> MySQL のジョブを作成します。docusign-mysql.yml というファイル名で作成しました。
  •             
                    in:
                        type: jdbc
                        driver_path: C:\Program Files\CData\CData JDBC Driver for DocuSign 2019J\lib\cdata.jdbc.docusign.jar
                        driver_class: cdata.jdbc.docusign.DocuSignDriver
                        url: jdbc:docusign:OAuthClientId=MyClientId; OAuthClientSecret=MyClientSecret; 
    CallbackURL=http://localhost:33333;
    InitiateOAuth=REFRESH
                        table: "Documents"
                    out: 
                        type: mysql
                        host: localhost
                        database: DatabaseName
                        user: UserId
                        password: UserPassword
                        table: "Documents"
                        mode: insert
                
            
  • ポイントはJDBC URLです。

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

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

    DocuSign への認証

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

  • テーブル名は取得したいテーブル名を入れます。
  • これで準備完了です。あとは「embulk run」で実行するだけです。
  • embulk run docusign-mysql.yml
  • 実行後、MySQL Workbenchからテーブルを確認してみると、データが取得できているはずです。

クエリ条件でフィルタリングしたデータのロード

ちなみに、上記の例ではテーブル名を直接指定しましたが、以下のようにSQL Queryを書いてもいいです。 Where句で作成日や修正日を指定すれば、最新のデータだけを対象にすることも可能です。

        
            in:
            type: jdbc
            driver_path: C:\Program Files\CData\CData JDBC Driver for DocuSign 2019J\lib\cdata.jdbc.docusign.jar
            driver_class: cdata.jdbc.docusign.DocuSignDriver
            url: jdbc:docusign:OAuthClientId=MyClientId; OAuthClientSecret=MyClientSecret; 
CallbackURL=http://localhost:33333;
InitiateOAuth=REFRESH
                query: "SELECT DocumentId, DocumentName FROM Documents WHERE [RecordId] = 1"
            out: 
                type: mysql
                host: localhost
                database: DatabaseName
                user: UserId
                password: UserPassword
                table: "Documents"
                mode: insert
        
    

CData JDBC Driver for DocuSign をEmbulk で使うことで、DocuSign コネクタとして機能し、簡単にデータを取得して同期することができました。ぜひ、30日の無償評価版 をお試しください。