Servoy で Zuora 連携Web アプリを構築
Servoy は、迅速なアプリケーション開発およびデプロイメントプラットフォームです。CData JDBC Driver for Zuora と組み合わせることで、リアルタイムのZuora のデータ と連携するZuora 接続アプリを構築できます。この記事では、Servoy からZuora に接続し、Zuora のデータ を表示・検索するシンプルなWeb アプリを構築する方法を説明します。
CData JDBC Driver は、最適化されたデータ処理機能を組み込んでおり、リアルタイムのZuora のデータ を操作する際に比類のないパフォーマンスを提供します。Zuora に複雑なSQL クエリを発行すると、ドライバーはフィルタや集計などのサポートされているSQL 操作を直接Zuora にプッシュし、サポートされていない操作(多くの場合SQL 関数やJOIN 操作)は組み込みのSQL エンジンを使用してクライアント側で処理します。組み込みの動的メタデータクエリにより、ネイティブのデータ型を使用してZuora のデータ を操作できます。
Servoy Developer でZuora に接続
Zuora 連携アプリを構築するには、まずCData JDBC Driver for Zuora を使用してServoy Developer でデータプロバイダーを作成する必要があります。
- JDBC Driver をインストールします。
- JDBC Driver の JAR ファイル(cdata.jdbc.zuora.jar)を、Servoy のインストールディレクトリにある /application_server/drivers/ ディレクトリにコピーします。
- Servoy Developer を開きます。
- Solution Explorer で、Database Server(Resources 配下)を右クリックし、「Connect to existing database」->「empty」を選択します。
- サーバーに名前を付けます。
- クリックして詳細サーバー設定を表示します。
URL を設定します(例:jdbc:zuora:OAuthClientID=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;Tenant=USProduction;ZuoraService=DataQuery;)
組み込みの接続文字列デザイナー
JDBC URL の構築については、Zuora JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルをダブルクリックするか、コマンドラインからJAR ファイルを実行します。
java -jar cdata.jdbc.zuora.jar
接続プロパティを入力し、接続文字列をクリップボードにコピーします。
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回再試行可能で、その後失敗として返されます。
- 先ほどコピーしたDriver クラスを選択します(例:cdata.jdbc.zuora.ZuoraDriver)
Zuora 連携Web アプリの構築
Servoy Developer のリソースでZuora への接続を設定したら、リアルタイムのZuora のデータ にアクセスできるアプリを構築する準備が整います。
新しいソリューションの作成
- Server Explorer で「All solutions」を右クリックし、「Create new solution」を選択します。
- ソリューションに名前を付けます。
- 「search」モジュールを含めるチェックボックスを選択します。
- 「Finish」をクリックします。
新しいフォームの作成
「Forms」を右クリックし、「Create new form」を選択します。
- フォームに名前を付けます。
- データソースを選択します。
- タイプ(例:Simple)を設定し、「Finish」をクリックします。
フォームにデータグリッドを追加
- Data Grid コンポーネント(Servoy NG-Grids から)をフォームにドラッグします。
カラムコンポーネントをData Grid にドラッグし、各カラムコンポーネントの「dataprovider」プロパティをZuora の「テーブル」のカラムに設定します(例:Invoices テーブルの Id)。
必要に応じてカラムを追加します。
アプリに検索機能を追加
検索機能を追加するには「svySearch」拡張機能が必要です(新しいソリューションを作成する際にデフォルトで含まれています)。ソリューション作成時に拡張機能を追加しなかった場合や、既存のソリューションを変更する場合は、Modules(ソリューション内)を右クリックし、「Add Module」を選択して検索モジュールを追加できます。「svySearch」を選択し、「OK」をクリックします。
- Text Field コンポーネントをフォームにドラッグします。
- フォームを右クリックし、「Open in Script Editor」を選択します。
- 検索値を保持する新しい変数(JavaScript)を作成します:
var searchText = '';
- フォームに戻り、Text Field のプロパティで:
- 「dataprovider」プロパティを先ほど作成したフォーム変数に設定します。
- ダブルクリックしてonAction イベントのメソッドを追加します。
- クリックして「Form」にメソッドを作成し、メソッドに名前を付け(例:onEnter)、「Create private」をクリックします。
- 「OK & Show」をクリックします。
- JavaScript ファイルに以下のJavaScript を追加して、Servoy フレームワークを使用し、Text Field のテキストに基づいてバインドされたデータを検索する機能を実装します:
var search = scopes.svySearch.createSimpleSearch(foundset).setSearchText(searchText); search.setSearchAllColumns(); search.loadRecords(foundset);
アプリの保存と起動
フォームとJavaScript ファイルを保存し、Run -> Launch NGClient をクリックしてWeb アプリを起動します。
CData JDBC Driver for Zuora の30日間無償トライアルをダウンロードして、Servoy でZuora 連携アプリの構築を始めましょう。ご不明な点があれば、サポートチームまでお問い合わせください。