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

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

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

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

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

Python + pandas + Dash でできること

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

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

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

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

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

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

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

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

  1. Connect AI にログインし、Sources をクリックして、 Add Connection をクリックします
    2. 接続の追加
  2. 「Add Connection」パネルから「Zuora」を選択します
    3. データソースの選択
  3. Zuora に接続するために必要な認証プロパティを入力します。

    Zuora はユーザー認証にOAuth 標準を使用しています。OAuth 認証ついて詳しくは、オンラインヘルプドキュメントを参照してください。

    Tenant プロパティの設定

    プロバイダへの有効な接続を作成するには、アカウントの設定と合致するテナント値を1つ選択する必要があります。以下は、利用可能なオプションのリストです。

    • USProduction：リクエストはhttps://rest.zuora.com に送信されます。
    • USAPISandbox：リクエストはhttps://rest.apisandbox.zuora.com に送信されます。
    • USPerformanceTest：リクエストはhttps://rest.pt1.zuora.com に送信されます。
    • EUProduction：リクエストはhttps://rest.eu.zuora.com に送信されます。
    • EUSandbox：リクエストはhttps://rest.sandbox.eu.zuora.com に送信されます。

    デフォルトではUSProduction テナントを使用します。

    Zuora サービスの選択

    データクエリとAQuA API の2つのZuora サービスを使用します。デフォルトでは、ZuoraService はAQuADataExport に設定されています。

    DataQuery

    データクエリ機能は、非同期の読み取り専用SQL クエリを実行することで、Zuora テナントからのデータのエクスポートを実現します。 このサービスは、素早く軽量なSQL クエリでの使用を推奨します。

    制限

    • フィルタ適用後の、テーブルごとの入力レコードの最大数： 1,000,000
    • 出力レコードの最大数： 100,000
    • テナントごとの、実行用に送信される同時クエリの最大数： 5
    • テナントごとの、同時クエリの制限に達した後に実行用に送信され、キューに追加されるクエリの最大数： 10
    • 1時間単位での、各クエリの最大処理時間： 1
    • GB 単位での、各クエリに割り当てられるメモリの最大サイズ： 2
    • Index Join を使用する際のインデックスの最大値。言い換えれば、Index Join を使用する際にWHERE 句で使われる一意の値に基づいた、左のテーブルから返されるレコードの最大数： 20.000

    AQuADataExport

    AQuA API のエクスポートは、すべてのオブジェクト（テーブル）のすべてのレコードをエクスポートするように設計されています。AQuA のクエリジョブには以下の制限があります。

    制限

    • AQuA のジョブ内のクエリが8時間以上実行されている場合、ジョブは自動的に停止されます。
    • 停止されたAQuA のジョブは3回再試行可能で、その後失敗として返されます。
    接続の設定（Salesforce の例）
  4. 「Save & Test」をクリックします
  5. 「Permissions」タブに移動し、ユーザーベースの権限を更新します。 権限の更新

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

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

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

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

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

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

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

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

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

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 Id, BillingCity "
    "FROM [Zuora1].[Zuora].[Invoices] "
    "WHERE BillingState = 'CA'",
    conn,
)

conn.close()

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

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

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

trace = go.Bar(x=df['Id'], y=df['BillingCity'], name='Id')

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

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

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

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

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

python zuora-dash.py
ブラウザで動作する Dash の Web アプリ（Salesforce の例）

関連情報と無料トライアル

これで、CData Connect AI Python SDK を使って、リアルタイムのZuora のデータでインタラクティブな Dash の Web アプリを構築できるようになりました。Zuora（および数百種類のその他のデータソース）への接続について詳しくは、Connect AI のページをご覧ください。

CData Connect AI の詳細、または無料トライアルにお申し込みください：

無料トライアル お問い合わせ


完全なソースコード

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 Id, BillingCity "
    "FROM [Zuora1].[Zuora].[Invoices] "
    "WHERE BillingState = 'CA'",
    conn,
)

conn.close()

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

trace = go.Bar(x=df['Id'], y=df['BillingCity'], name='Id')

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

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

はじめる準備はできましたか？

CData Connect AI の詳細、または無料トライアルにお申し込みください：

無料トライアル

この記事の内容

関連記事