Python のDash ライブラリを使って、DocuSign データ に連携するウェブアプリケーションを開発する方法

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

Python エコシステムには、多くのモジュールがあり、システム構築を素早く効率的に行うことができます。CData Python Connector for DocuSign を使うことで、pandas モジュールとDash フレームワークでDocuSign にデータ連携するアプリケーションを効率的に開発することができます。本記事では、pandas、Dash とCData Connector を使って、DocuSign に連携して、DocuSign データ をビジュアライズするシンプルなウェブアプリを作る方法をご紹介します。

CData Python Connectors の特徴

CData Python Connectors は、以下のような特徴を持った製品です。

1. DocuSign をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレデータソースに対応
2. Dash をはじめとする多様なデータ分析・BI ツールにDocuSign データを連携
3. ノーコードでの手軽な接続設定

必要なモジュールのインストール

まずは、pip で必要なモジュールおよびフレームワークをインストールします：

pip install pandas
pip install dash
pip install dash-daq

Python でDocuSign データを可視化

必要なモジュールとフレームワークがインストールされたら、ウェブアプリを開発していきます。コードのスニペットは以下の通りです。フルコードは記事の末尾に掲載しているので、参考にしてください。

まず、CData Connector を含むモジュールをインポートします：

import os
import dash
import dash_core_components as dcc
import dash_html_components as html
import pandas as pd
import cdata.docusign as mod
import plotly.graph_objs as go

接続文字列を使ってデータへの接続を確立します。connect 関数を使ってCData DocuSign Connector からDocuSign データ との接続を確立します。

cnxn = mod.connect("OAuthClientId=MyClientId; OAuthClientSecret=MyClientSecret; 
CallbackURL=http://localhost:33333;
InitiateOAuth=GETANDREFRESH;OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")")

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

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

DocuSign への認証

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

DocuSign にクエリを実行

read_sql 関数を使って、padas からSQL 文を発行し、DataFrame に結果を格納します。

df = pd.read_sql("""SELECT DocumentId, DocumentName FROM Documents WHERE DocumentName = 'TPSReport'""", cnxn)

ウェブアプリケーションの設定

DataFrame に格納されたクエリ結果を使って、ウェブアプリにname、stylesheet、title を設定していきます。

app_name = 'dash-docusignedataplot'

external_stylesheets = ['https://codepen.io/chriddyp/pen/bWLwgP.css']

app = dash.Dash(__name__, external_stylesheets=external_stylesheets)
app.title = 'CData + Dash'

Layout 設定

次に、DocuSign データ をベースにした棒グラフを作詞し、アプリのレイアウトを設定します。

trace = go.Bar(x=df.DocumentId, y=df.DocumentName, name='DocumentId')

app.layout = html.Div(children=[html.H1("CData Extention + Dash", style={'textAlign': 'center'}),
	dcc.Graph(
		id='example-graph',
		figure={
			'data': [trace],
			'layout':
			go.Layout(alt='DocuSign Documents Data', barmode='stack')
		})
], className="container")

アプリをセットアップして実行

接続、アプリ、レイアウトを定義したら、アプリを実行してみましょう。以下のコードで実行できます。

if __name__ == '__main__':
    app.run_server(debug=True)

最後に、Python でウェブアプリを起動してブラウザでDocuSign データ を見てみましょう。

python docusign-dash.py

ちゃんとデータが表示できてますね！

おわりに

DocuSign Python Connector の30日の無償トライアル をぜひダウンロードして、DocuSign データ への接続をPython アプリやスクリプトから簡単に作成してみてください。

import os
import dash
import dash_core_components as dcc
import dash_html_components as html
import pandas as pd
import cdata.docusign as mod
import plotly.graph_objs as go

cnxn = mod.connect("OAuthClientId=MyClientId; OAuthClientSecret=MyClientSecret; 
CallbackURL=http://localhost:33333;
InitiateOAuth=GETANDREFRESH;OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

df = pd.read_sql("SELECT DocumentId, DocumentName FROM Documents WHERE DocumentName = 'TPSReport'", cnxn)
app_name = 'dash-docusigndataplot'

external_stylesheets = ['https://codepen.io/chriddyp/pen/bWLwgP.css']

app = dash.Dash(__name__, external_stylesheets=external_stylesheets)
app.title = 'CData + Dash'
trace = go.Bar(x=df.DocumentId, y=df.DocumentName, name='DocumentId')

app.layout = html.Div(children=[html.H1("CData Extention + Dash", style={'textAlign': 'center'}),
	dcc.Graph(
		id='example-graph',
		figure={
			'data': [trace],
			'layout':
			go.Layout(alt='DocuSign Documents Data', barmode='stack')
		})
], className="container")

if __name__ == '__main__':
    app.run_server(debug=True)