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

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

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

SuiteCRM への接続

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

次の接続プロパティを設定すると、V4.1 API 経由でSuiteCRM データに接続できます。

• Schema：suitecrmv4 に設定。
• Url：SuiteCRM アプリケーションに紐づいているURL（例：http://suite.crm.com）に設定。
• User：SuiteCRM に紐づいているユーザーに設定。
• Password：SuiteCRM に紐づいているパスワードに設定。

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

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

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

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

pip install pandas
pip install dash
pip install dash-daq

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

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

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

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

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

cnxn = mod.connect("URL=http://mySuiteCRM.com;User=myUser;Password=myPassword;")

SuiteCRM にクエリを実行

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

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

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

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

app_name = 'dash-suitecrmedataplot'

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

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

Layout 設定

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

trace = go.Bar(x=df.Name, y=df.Industry, 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='SuiteCRM Accounts Data', barmode='stack')
		})
], className="container")

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

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

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

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

python suitecrm-dash.py

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

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

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

cnxn = mod.connect("URL=http://mySuiteCRM.com;User=myUser;Password=myPassword;")

df = pd.read_sql("SELECT Name, Industry FROM Accounts WHERE Industry = 'Manufacturing'", cnxn)
app_name = 'dash-suitecrmdataplot'

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

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