SaaS 連携データベース Yoom を使ってZuora のデータを使ったフローボットを作成する

こんにちは！リードエンジニアの杉本です。

Yoom は さまざまなSaaS とノーコードで連携し、業務を自動化するSaaS 連携データベースです。この記事では、CData Connect Cloud を経由して Yoom からZuora に接続し、Zuora のデータを利用したフローボットを作成する方法を紹介します。

CData Connect Cloud は、Zuora のデータのクラウド to クラウドの仮想OData インターフェースを提供し、Yoom からリアルタイムにZuora データへ接続することができます。

CData Connect Cloud の設定

Yoom でZuora Zuora のデータをリアルタイムで操作するには、Connect Cloud からZuora に接続し、コネクションにユーザーアクセスを提供してZuora のデータのOData エンドポイントを作成する必要があります。

Connect Cloud からZuora に接続

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

1. Connect Cloud にログインし、 Add Connection をクリックします。
2. Add Connection パネルから「Zuora」を選択します。
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回再試行可能で、その後失敗として返されます。
   
4. Create & Test をクリックします。
5. Edit Zuora Connection ページのPermissions タブに移動し、ユーザーベースのアクセス許可を更新します。

Connect Cloud にZuora OData エンドポイントを追加する

Zuora に接続したら、目的のテーブルのOData エンドポイントを作成します。

1. OData ページに移動し、 Add to create new OData endpoints をクリックします。
2. Zuora コネクション（例：Zuora1）を選択し、Next をクリックします。
3. 使用するテーブルを選択し、Confirm をクリックします。

パーソナルアクセストークン（PAT）の取得

OAuth 認証をサポートしていないサービス、アプリケーション、プラットフォーム、またはフレームワークから接続する場合は、認証に使用するパーソナルアクセストークン（PAT）を作成できます。きめ細かなアクセス管理を行うために、サービスごとに個別のPAT を作成するのがベストプラクティスです。

1. Connect Cloud アプリの右上にあるユーザー名をクリックし、User Profile をクリックします。
2. User Profile ページで、Personal Access Tokens セクションまでスクロールし、Create PAT をクリックします。
3. PAT に名前を付け、Create をクリックします。

4. パーソナルアクセストークンは作成時にしか表示されないため、必ずコピーして安全に保存してください。

コネクションとOData エンドポイントが構成されたら、Yoom からZuora に接続できるようになります。

Yoom でフローボットを作成

Web API の準備が整ったので、Yoom にてフローボットの作成を進めていきます。

1. まず、Yoom にログインします。

2. フローボットを新規作成します。

ループ設定

フローボットのトリガー設定後、プロセスを作成します。まずはデータを複数行データベースに追加するため、ループ処理を設定します。ループを件数分実行するための一意のデータをZuora から取得します。

1. CData Connect Cloud コネクタを利用して、Zuora のデータを取得します。＋ ボタンでプロセスを追加し、オペレーションタイプの選択から「アプリと連携する」を選択します。

2. アプリ一覧から「CData Connect」を選択します。

3. アカウント情報を登録します。アクセストークンに、Connect Cloud のアカウント（メールアドレス）とPAT をコロンで繋ぎ、Base64 エンコードしたものを設定します。

4. アクション選択では、「レコードの一覧を取得」を選択します。アクション設定画面では、Connect Cloud のOData で設定したテーブル名を設定します。アウトプットを追加し、データをリスト形式で取得する設定をします。JSONPath には「$.value[*].カラム名」を指定します。

5. データ取得設定を保存し、ループ処理（同じ処理を繰り返す）を追加します。

ループで利用したデータを元に他カラムのデータを取得

ループで利用した一意のデータをキーにして、Zuora の他カラムのデータを取得します。

1. ループ分岐の右側のフローでアプリ連携のプロセスを追加し、「特定のレコードを取得」アクションを設定します。

2. プライマリーキーの値を設定します。「アウトプットを入力」から「ループ変数」を選択します。
3. アウトプットを設定します。入力形式はテキスト、JSONPath は「value[0].カラム名」を設定します。

Yoom データベースに追加

Yoom データベースに取得したデータを追加する処理を作成します。

1. オペレーションタイプの選択から「データベースを操作する」を選択し、データベース一覧からYoom データベースを選択します。

2. データベースとテーブルを指定し、実行アクションで「レコードを追加する」を選択します。
3. データ取得時に設定したアウトプットを、データベースのカラムに設定します。

フローボットの完成

Zuora のデータをYoom データベースに追加するフローボットが完成しました。

1. フローボットを実行し、Yoom データベースにZuora のデータが追加されることを確認します。

このように、CData Connect Cloud を経由することで、API 側の複雑な仕様を意識せずにSaaS と連携したフローボットをYoom で作成できます。。他にも多くのデータソースに対応するCData Connect Cloud の詳細をこちらからご覧ください。