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 に接続するアプリケーションを構築するには、まず、Servoy Developer からCData JDBC Driver for Zuora を使用してデータプロバイダを作成する必要があります。

1. JDBC Driver をインストールします。
2. JDBC Driver JAR ファイル（cdata.jdbc.zuora.jar）を、Servoy のインストールディレクトリの/application_server/drivers/ ディレクトリにコピーします。
3. Servoy Developer を開きます。
4. Solution Explorer で「Resources」の下の「Database Server」を右クリックし、「Connect to existing database」->「empty」を選択します。
   1. サーバーに名前を付けます。
   2. クリックすると、サーバーの詳細設定が表示されます。

      • 次のようにURL を設定します。例：jdbc:zuora:OAuthClientID=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;Tenant=USProduction;ZuoraService=DataQuery;InitiateOAuth=GETANDREFRESH

        組み込みの接続文字列デザイナー

        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 へのアクセス権を持つアプリケーションを構築することができます。

新しいソリューションを作成する

1. Server Explorer で、「All solutions」を右クリックし、「Create new solution」を選択します。
2. ソリューションに名前を付けます。
3. 「search」モジュールを含むチェックボックスを選択します。
4. 「Finish」をクリックします。

新しいフォームを作成する

「Forms」を右クリックし、「Create new form」を選択します。

1. フォームに名前を付けます。
2. データソースを選択します。
3. タイプ（Simple など）を設定し、「Finish」をクリックします。

フォームにData Grid を追加する

1. Servoy NG-Grids からData Grid コンポーネントをフォームにドラッグします。

2. カラムコンポーネントをData Grid にドラッグし、各カラムコンポーネントの「dataprovider」プロパティをZuora 「table」のカラム（例：Invoices テーブルのId）に設定します。

   必要に応じてカラムを追加します。

アプリケーションに検索を追加する

検索機能を追加するには、「svySearch」拡張機能が必要です。（新しいソリューションを作成する際にデフォルトで含まれます。）ソリューションの作成時に拡張機能を追加しなかった場合、または、既存のソリューションを変更する場合は、ソリューション内のModules を右クリックして「Add Module」を選択することで検索モジュールを追加できます。「svySearch」を選択し、「OK」をクリックします。

1. Text Field コンポーネントをForm にドラッグします。
2. Form を右クリックし、「Open in Script Editor」を選択します。
3. 検索値を保持する新しい変数（JavaScript）を作成します。

   var searchText = '';
   

4. Text Field プロパティでForm に戻ります。
   1. 「dataprovider」プロパティを作成したForm 変数に設定します。
   2. ダブルクリックしてonAction イベントのメソッドを追加します。
   3. クリックして「Form」でメソッドを作成し、名前を付けて（例：onEnter）、「Create private」をクリックします。
   4. 「OK & Show」をクリックします。
5. 以下の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 に接続されたアプリケーションの構築を開始します。ご不明な点があれば、サポートチームにお問い合わせください。