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

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

CData Python Connector は、ビルトインされた効率的なデータプロセスにより、リアルタイムSugar CRM data データにPython からアクセスし、高いパフォーマンスと接続性を発揮します。Sugar CRM に複雑なクエリを投げる際に、ドライバーはフィルタリング、集計などがサポートされている場合、SQL 処理を直接Sugar CRM 側に行わせ、サポートされていないSQL 処理については、組み込まれたSQL エンジンによりクライアント側で処理を行います（特にJOIN やSQL 関数など）。

Sugar CRM への接続

Sugar CRM data への連携は、RDB ソースへのアクセスと同感覚で行うことができます。必要な接続プロパティを使って接続文字列を作成します。本記事では、接続文字列をcreate_engine 関数のパラメータとして送ります。

本製品をSugarCRM に認証するには、以下を有効なSugarCRM ユーザー資格情報に設定する必要があります。User：SugarCRM アカウントのユーザー。Password：SugarCRM アカウントのパスワード。

OAuth consumer key とconsumer secret は、Admin -> OAuth Keys で生成することができます。OAuthClientId にOAuth consumer key を、OAuthClientSecret にconsumer secret　を設定します。

さらに、SugarCRM への接続を確立するには以下を指定します。URL：'http://{sugar crm instance}.com' の形式で、SugarCRM アカウントに紐付いているURL に設定。Platform：認証中にログインの競合が発生した場合は、SugarCRM UI で作成したプラットフォームのいずれかに設定。

SugarCRM メタデータの取得は高負荷になる可能性があることに注意してください。メタデータのキャッシュ で説明しているように、メタデータをローカルに格納することをお勧めします。

以下の手順に従い、必要なモジュールをインストールし、Python オブジェクト経由でSugar CRM にアクセスします。

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

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

pip install pandas
pip install dash
pip install dash-daq

Python でSugar CRM データ をビジュアライズ

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

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

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

接続文字列を使ってデータへの接続を確立します。connect 関数を使ってCData Sugar CRM Connector にSugar CRM data との接続を確立します。

cnxn = mod.connect("User=MyUser;Password=MyPassword;URL=MySugarCRMAccountURL;CacheMetadata=True;")

Sugar CRM にクエリを実行

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

df = pd.read_sql("""SELECT Name, AnnualRevenue FROM Accounts WHERE Name = 'Bob'""", cnxn)

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

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

app_name = 'dash-sugarcrmedataplot'

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

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

Layout 設定

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

trace = go.Bar(x=df.Name, y=df.AnnualRevenue, name='Name')

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='Sugar CRM Accounts Data', barmode='stack')
		})
], className="container")

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

接続、アプリ、レイアウトを定義したら、アプリを実行してみましょう。Python コードの最後はこのようです。

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

では、Python でウェブアプリを稼働させて、ブラウザでSugar CRM data を見てみましょう。

python sugarcrm-dash.py

製品の無償トライアル情報

Sugar CRM Python Connector の30日の無償トライアル をぜひダウンロードして、Sugar CRM data への接続をPython アプリやスクリプトから簡単に作成しましょう。

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

cnxn = mod.connect("User=MyUser;Password=MyPassword;URL=MySugarCRMAccountURL;CacheMetadata=True;")

df = pd.read_sql("SELECT Name, AnnualRevenue FROM Accounts WHERE Name = 'Bob'", cnxn)
app_name = 'dash-sugarcrmdataplot'

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.Name, y=df.AnnualRevenue, name='Name')

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='Sugar CRM Accounts Data', barmode='stack')
		})
], className="container")

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