Xero のデータでDashのWebアプリを作る方法｜CData Connect AI + Python

Jerod Johnson
Director, Technology Evangelism

CData Connect AI Python SDKとpandasを使い、リアルタイムのXero のデータをDashのWebアプリで可視化する方法を解説。コーディングなしの接続設定からグラフ表示まで実現します。

CData Connect AI の Python SDK（DB-API 2.0準拠）を使うと、pandas と Dash でリアルタイムのXero のデータを可視化する Web アプリを、個別ドライバー不要で構築できます。接続・モジュールインストール・アプリ構築の3ステップで、約10分で完成します。

Python は豊富なモジュールのエコシステムを備えているため、素早く作業に取りかかり、システムをより効果的に連携できます。CData Connect AI Python SDK、pandas モジュール、そして Dash フレームワークを使えば、Xero のデータを扱う Xero 連携の Web アプリケーションを構築できます。この記事では、Connect AI に接続し、pandas と Dash を使ってXero のデータを可視化するシンプルな Web アプリを構築する方法をご紹介します。

Connect AI Python SDK（cdata-connect-ai）は DB-API 2.0（PEP 249）に準拠したクライアントなので、pandas は SDK の接続オブジェクトから直接クエリ結果を読み取れます。ソースごとにドライバーをインストールする必要はありません。パーソナルアクセストークンで接続して、アプリを構築しましょう。

Python + pandas + Dash でできること

Xero データの可視化ダッシュボード作成

SQL クエリで取得した Xero のレコードを pandas の DataFrame に読み込み、Dash のグラフコンポーネントに渡すだけで、業種別の傾向などを視覚的に確認できるダッシュボードを構築できます。

リアルタイムデータの自動更新レポート

Connect AI 経由の接続はパーソナルアクセストークンで認証されるため、スケジュール実行するスクリプトに組み込めば、Xero の最新データを反映したレポートを定期的に生成できます。

複数データソースとの統合分析

DB-API 2.0 準拠のクライアントなので、同じコードパターンで Xero 以外のデータソースにも接続でき、pandas 上で結合・集計してから Dash で一元的に可視化できます。

Xero データ連携について

CData を使用すれば、Xero のライブデータへのアクセスと統合がこれまでになく簡単になります。お客様は CData の接続機能を以下の目的で利用しています：

Xero Accounts と、米国およびオーストラリアの Payroll API の両方に接続できます。
Customers、Transactions、Invoices、Sales Receipts などの Xero オブジェクトの読み取り、書き込み、更新、削除ができます。
SQL ストアドプロシージャを使用して、カートへのアイテム追加、注文の送信、添付ファイルのダウンロードなどのアクションを実行できます。
会計、給与、ファイル、固定資産、プロジェクトデータを扱うことができます。

お客様は、Tableau、Qlik Sense、Excel などのお気に入りのツールと Xero データを定期的に統合し、Xero データをデータベースやデータウェアハウスに統合しています。

はじめに

Connect AI で Xero に接続する方法は？

CData Connect AI では、直感的なクリック操作ベースのインターフェースでデータソースに接続できます。

Connect AI にログインし、Sources をクリックして、 Add Connection をクリックします

「Add Connection」パネルから「Xero」を選択します

Xero に接続するために必要な認証プロパティを入力します。
接続には、認証用の値に加えてSchema 接続プロパティを設定してください。Xero はプライベートアプリケーション、パブリックアプリケーション、パートナーアプリケーションに認証を提供します。設定したアプリケーションに応じて、XeroAppAuthentication プロパティを PUBLIC、PRIVATE、またはPARTNER に設定する必要があります。プライベートアプリケーションから接続するには、追加でOAuthAccessToken、OAuthClientId、 OAuthClientSecret、CertificateStoreType、CertificateStore、およびCertificateStorePassword を設定してください。

パブリックまたはパートナーアプリケーションから接続する場合は、埋め込みOAuthClientId、OAuthClientSecret、およびCallbackURL を指定するか、アプリを登録してOAuth の値を入手できます。

Xero への認証については、ヘルプドキュメントの「はじめに」を参照してください。
「Save & Test」をクリックします
「Permissions」タブに移動し、ユーザーベースの権限を更新します。

パーソナルアクセストークン（PAT）を生成する

Python SDK は、アカウントのメールアドレスとパーソナルアクセストークン（PAT）を使って Connect AI に認証します。アクセスの粒度を保つために、アプリケーションごとに個別の PAT を作成することをおすすめします。

Connect AI アプリの右上にある歯車アイコン（）をクリックして、設定ページを開きます。
設定ページの Access Tokens セクションに移動し、 Create PAT をクリックします。
PAT に名前を付けて Create をクリックします。
パーソナルアクセストークンは作成時にのみ表示されます。必ずコピーして安全な場所に保管してください。

必要なモジュールをインストールする

pip ユーティリティを使って、SDK（pandas エクストラ付き）、Dash、Plotly をインストールします。

pip install "cdata-connect-ai[full]"
pip install dash
pip install plotly

Python で Xero のデータの Web アプリを構築する

必要なモジュールをインストールしたら、Web アプリを構築する準備は完了です。以下にコードスニペットを紹介しますが、完全なソースコードは記事の末尾に掲載しています。

まずモジュールをインポートし、アカウントのメールアドレスと PAT で Connect AI に接続して、Xero のデータを DataFrame に読み込みます。識別子は <Connection>.<Schema>.<Table> という3つの部分で構成されており、接続名はデフォルトでソース名（例：Xero1）になります。

import dash
from dash import dcc, html
import pandas as pd
import plotly.graph_objs as go
import cdata_connect_ai

conn = cdata_connect_ai.connect(
    username="[email protected]",
    password="<your_pat>",
)

df = pd.read_sql(
    "SELECT Name, QuantityOnHand "
    "FROM [Xero1].[Xero].[Items] "
    "WHERE Name = 'Golf balls - white single'",
    conn,
)

conn.close()

アプリとレイアウトを設定する

クエリ結果を DataFrame に格納したら、Xero のデータから棒グラフを作成し、アプリのレイアウトを設定します。

app = dash.Dash(__name__)
app.title = 'CData Connect AI + Dash'

trace = go.Bar(x=df['Name'], y=df['QuantityOnHand'], name='Name')

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

アプリを実行できるようにする

接続、アプリ、レイアウトの設定が完了したら、アプリを実行する準備は整いました。

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

それでは、Python で Web アプリを実行し、ブラウザでXero のデータを確認してみましょう。

python xero-dash.py