Power Apps でZuora のデータを連携利用

こんにちは！ドライバー周りのヘルプドキュメントを担当している古川です。

Microsoft PowerApps は、データに連携するモバイルおよびタブレット向けアプリをドラッグ＆ドロップとリッチな関数で実現します。CData API ServerとADO.NET Provider for Zuora (もしくは250+ の他のADO.NET Providers)を組み合わせて使い、PowerApps のリモートデータソースへの連携機能を拡張することができます。PowerApps のCommon Data Service に別途データをコピーする必要はありません。CData API Server は、Zuora のデータにデータベースのようなアクセスを可能にし、SaaS API やNoSQL をインメモリのSQL-92 エンジンで操作できるようにします。

CData API Server は、Swagger のメタデータ標準をサポートします。Azure App Service、Microsoft Flow、およびPowerApps でSwagger メタデータからのUI 生成やコード生成が可能です。Swagger 定義を使えば、PowerApps からZuora に連携する関数が生成できます。本記事では、それらの関数をPowerApps から使って、リモートのZuora に連携する方法を説明します。

CData API Server とは？

CData API Server は、以下のような特徴を持ったAPI 開発ツールです。

• あらゆるデータソースからAPI を生成：SQL Server、MySQL、Oracle、PostgreSQL、DB2 などのRDB、Excel、CSV、Google スプレッドシートなどCData の充実したコネクタライブラリを利用できます。
• 主要なデータ形式に対応：OData、REST、JSON、CSV / TSV など、主要な形式に対応しています。
• 一元管理でAPI を効率運用：単一の管理プラットフォーム上でAPI の更新、停止、共有が可能です。
• ノーコードでシンプルな設定：GUI ベースのインターフェースを使用して、複雑なコーディングなしでAPI を作成・セキュアに公開できます。

詳しくは、こちらの製品資料をご確認ください。

API Server の設定

以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなZuora OData サービスを作成していきましょう。

デプロイ

API Server は内蔵のJetty サーバー上で動作します。Windows をお使いの場合は、スタンドアロンサーバーとして起動するか、IIS に組み込んで使用することが可能です。また、お使いのJava サーブレットコンテナにAPI Server のWAR ファイルを配置して実行することもできます。具体的なセットアップ方法については、こちらのヘルプドキュメントをご覧ください。

Zuora への接続

Salesforce Connect からZuora のデータを操作するには、まずZuora への接続を作成・設定します。

1. API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
2. 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「Zuora」を選択します。
3. 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
   CData コネクタの追加方法はこちら >>
4. それでは、Zuora への接続設定を行っていきましょう！

5. 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回再試行可能で、その後失敗として返されます。
6. 接続情報の入力が完了したら、「保存およびテスト」をクリックします。

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

Tenant プロパティの設定

• 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 サービスの選択

DataQuery

制限

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

AQuADataExport

制限

• AQuA のジョブ内のクエリが8時間以上実行されている場合、ジョブは自動的に停止されます。
• 停止されたAQuA のジョブは3回再試行可能で、その後失敗として返されます。

API Server のユーザー設定

次に、API Server 経由でZuora にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。

1. 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
2. 次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
3. その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。

Zuora 用のAPI エンドポイントの作成

ユーザーを作成したら、Zuora のデータ用のAPI エンドポイントを作成していきます。

1. まず、「API」ページに移動し、 「 テーブルを追加」をクリックします。
2. アクセスしたい接続を選択し、次へをクリックします。
3. 接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。

OData のエンドポイントを取得

以上でZuora への接続を設定してユーザーを作成し、API Server でZuora データのAPI を追加しました。これで、OData 形式のZuora データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。

また、CORS を有効にして［Server］とクリックして次のセクションを定義する必要があります。［*］なしですべてのドメインを許可するオプションを選択することもできます。

1. Access-Control-Allow-Origin:値を［*］またはAPI Server を呼び出すドメインに設定します。
2. Access-Control-Allow-Methods:値を［GET,PUT,POST,OPTIONS］または使用する必要のあるHTTP メソッドに設定します。
3. Access-Control-Allow-Headers:［x-ms-client-request-id, authorization, content-type］に設定します。

最後に、URL の一部としてauthtoken を渡すことにより、ユーザーが認証できるようにAPI Server を構成する必要があります。そのために、インストール先のwww/app_data フォルダに移動し、settings.cfg ファイルを変更して[Application] セクションに次の行を追加します。

Swagger メタデータの取得

メタデータを使用してCustom API 接続を作成します。Swagger 定義を取得するには、ブラウザで次の要求を行い、結果のJSON ファイルを保存します。

API Server を介してZuora に接続

以下のステップで、リモートZuora を検索する簡単なアプリを作成する方法を説明します。

1. Microsoft Power Apps で、［Custom connectors］をクリックします。
2. ［Create custom connector］をクリックし、［Import an OpenAPI］ファイルを選択します。
3. コネクタに名前を付け、JSON ファイルを参照して［Continue］をクリックします。
4. 関連する一般情報を入力し、ベースURL が/api.rsc/@myauthtoken (myauthtoken はconfigure API Server ユーザーのAuthToken) の形式であることを確認して［Continue］をクリックします。
5. Authentication タイプには［No authentication］を選択します。［Continue］をクリックします。
6. アクションと参照の定義を確認し、［Create connector］をクリックします。
7. コネクタをテストするには、新しい接続を作成する必要があります。［Test］をクリックし、［Connections］の下の［New Connection］をクリックして［Create］を選択します。
8. ［Custom connectors］メニューからコネクタに戻り、［Test］をクリックします。ここから使用可能な操作をテストできます。

データソースをPowerApp に接続

以下のステップに従って、PowerApp からZuora に接続します。

1. Power Apps のメインメニューから［Create an app］をクリックし、オンプレミスまたはクラウドのPowerApp Studio を選択します。
2. 空のアプリを選択し、携帯レイアウトまたはタブレットレイアウトのどちらかを選択します。
3. ［View］タブで［Data Sources］をクリックし、［Add Data Source］をクリックします。
4. 作成した接続をクリックしてコネクタをテストします。

ギャラリーの事前設定

以下のステップに従って、Zuora を検索できる簡単なアプリを作成します。Power Apps の数式を使用してZuora の行をギャラリーコントロールの行にバインドします。

1. ［View］タブで［Gallery］->［Vertical］をクリックしてギャラリーを追加します。

2. ギャラリーを選択し、ギャラリー設定の［Advanced］タブでギャラリーの［Items］プロパティをZuora に割り当てます。以下の式を使用すると、Invoices テーブルの例にアクセスできます。

   ForAll(CDataSwaggerAPI.getAllInvoices().value, {myId: Id, myBillingCity: BillingCity})

3. 要素をクリックし、［Text］プロパティ(UI 要素の［Advanced］タブ) をThisItem.myId またはThisItem.myBillingCity に設定してZuora 列をUI 要素に割り当てます。

   

Zuora のデータの検索

ギャラリーに表示されるレコードをフィルタリングするには、［Screen］にTextInput を追加し、TextInput の［Text］プロパティをクリアしてギャラリーの［Items］プロパティを以下のような式にます。また、必要に応じてTextInput1 をギャラリーのTextInput コントロール名に置き換えます。

この式は、API Server がリモートZuora に対して実行するOData クエリを作成し、最初にすべてのレコードをアプリに取り込むことをせずに現在のデータに対して検索が実行されるようにします。 サポートされているOData の詳細については、API Server のヘルプドキュメントを参照してください。

Zuora のデータの編集

以下のステップに従って、ギャラリーで選択されたZuora レコードのフィールドを表示する編集可能な画面をロードします。

1. ［Insert］タブで、［New Screen］->［Blank］とクリックし、スクリーンの名前を［Details］に設定します。
2. ギャラリーを新しいスクリーンに結び付けます。ギャラリーの最初のエントリで矢印ボタンを選択し、［Advanced］プロパティの［OnSelect］フィールドに以下のように入力します。
   Navigate( Details, None )
3. ［Details］スクリーンの［Insert］タブで、［Id］と［Id］値の別のラベルを追加します。［Text］プロパティをBrowseGallery.Selected.Id に設定します。

各カラムについて、以下のことを行う必要があります。Custom API の場合、フォーム要素はAPI Server に対してどのリクエストを作成する必要があるかを検出できないため、データ変更式を手動で書く必要があることに注意してください。

1. フィールドのラベルを追加します。
2. ［Text］メニューからのテキスト入力を画面に追加し、text プロパティをギャラリーから選択したアイテムの値に設定します。(例: BrowseGallery.Selected.myId).

アプリに基本的な更新機能とナビゲーションを提供するには、［Submit］ボタンと［Back］ボタンを追加します。

1. ［Submit］ボタンでOnChange プロパティを以下のように設定します。 CDataSwaggerAPI.updateInvoices(BrowseGallery.Selected.myId,BrowseGallery.Selected.myId,{Id:TextInput1.Text,BillingCity:TextInput2.Text})
2. ［Back］ボタンの場合は、［OnSelect］フィールドを以下のように設定します。 Navigate( BrowseScreen, None )

これで、モバイルアプリまたはタブレットアプリでZuora を参照、検索、更新できるようになりました。