Appsmith で Zuora 連携アプリケーションを作成

Cameron Leblanc
Technology Evangelist

Appsmith でCData Connect AI を介して Zuora のデータに接続し、Zuora のデータにリアルタイムでアクセスできるカスタムビジネスアプリケーションを作成。

Appsmith は、チームがビジネスオペレーションを改善するためのUI を素早く簡単に構築できる、オープンソースの内部ツールビルダーです。CData Connect AI と組み合わせることで、ビジネスアプリケーションから Zuora のデータに即座にアクセスできるようになります。この記事では、Connect AI を使用して Zuora に接続し、Appsmith で Zuora のデータから基本的なアプリケーションを作成するプロセスを説明します。

CData Connect AI は、Zuora への純粋なSQL Server のクラウドtoクラウドインターフェースを提供し、Appsmith 内からライブ Zuora のデータを直接使用してビジネスアプリケーションを作成できます。ネイティブデータベースへのデータレプリケーションは必要ありません。アプリケーションを構築する際、Appsmith はデータを収集するためのSQL クエリを生成します。CData Connect AI は、最適化されたデータ処理機能により、フィルタやJOIN を含むすべてのサポートされるSQL オペレーションを Zuora に直接送信します。これにより、サーバーサイドの処理を活用して、リクエストされた Zuora のデータを迅速に取得できます。

Appsmith 用に Zuora への接続を構成

Appsmith から Zuora への接続は、CData Connect AI を介して行います。Appsmith から Zuora のデータを操作するには、まず Zuora 接続を作成して構成します。

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

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

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回再試行可能で、その後失敗として返されます。
Save & Test をクリックします
Add Zuora Connection ページのPermissions タブに移動し、User-based permissions を更新します。

パーソナルアクセストークンの追加

REST API、OData API、またはVirtual SQL Server を介してConnect AI に接続する場合、パーソナルアクセストークン（PAT）を使用してConnect AI への接続を認証します。アクセスの粒度を維持するために、サービスごとに個別のPAT を作成することをお勧めします。

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

接続が構成され、PAT が生成されたので、Appsmith から Zuora のデータに接続する準備が整いました。

ライブ Zuora のデータからAppsmith アプリケーションを作成

Appsmith からCData Connect AI Virtual SQL Server への接続を確立するには、以下の手順に従います。

Appsmith で Zuora に接続

Appsmith インスタンスにログインし、新しいアプリケーションを作成します。
新しいアプリケーションで、Data ページを開き、Bring your data を選択します。
このページで、Microsoft SQL Server を検索し、データソースとして選択します。
新しいデータソースの名前を入力し、以下の接続設定を入力します。
- Host address: tds.cdata.com
- Port: 14333
- Database name: 接続するCData Connect AI データソースの接続名を入力します（例：Zuora1）。
- Username: CData Connect AI のユーザー名を入力します。これはCData Connect AI インターフェースの右上に表示されます。例：test@cdata.com。
- Password: 先ほど生成したPAT を入力します。
Test configuration をクリックして接続が成功したことを確認し、Save をクリックしてデータソースを保存します。

新しいクエリを作成

データソースへの接続を構成したら、SQL クエリを追加してデータソースから実際にデータを取得します。

新しいデータソースの画面で、New Query をクリックします。
クエリエディタが開き、データを選択するSQL クエリを入力できます。SQL クエリの指定については、CData Connect AI のExplorer を使用して、SQL クエリと取得するデータをプレビューできます。
SQL クエリを作成したら、Appsmith のクエリエディタに戻り、SQL クエリを入力してRun をクリックします。
クエリが正常に実行されたら、あとは取得したデータを表示するためのページをセットアップするだけです。