CData BizTalk Adapter for Zuora の Receive Location を構成する

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
CData BizTalk Adapter for Zuora を使用して、BizTalk でZuora のデータを取得します。Receive Location を使用して SQL コマンドを実行し、Zuora でのアクションを自動化します。

この記事の手順に従って、Zuora のデータに接続し、Static One-Way Receive Location を構成して、シンプルなテスト(Zuora のデータを取得して XML ファイルに書き込む)を実行できます。

Receive Location は SQL コマンドを実行し、結果を含む BizTalk メッセージを作成できます。Updategram コマンドを実行する場合は、Send Port を使用してください。

Receive Port の作成

アプリケーションに Receive Location を追加するには、まず Receive Port を追加する必要があります。Receive Port は複数の Receive Location からデータを受信できます。

  1. まだ行っていない場合は、BizTalk Administration Console でアプリケーションを開きます。
  2. アプリケーション内で、Receive Ports を右クリックし、New -> Static One-Way Receive Port をクリックします。Receive Port Properties ダイアログが表示されます。
  3. Name メニューで、Receive Port の名前を入力します。

Receive Location の作成

Receive Port を作成したら、Receive Location を作成し、Zuora アダプターをトランスポートタイプとして使用するよう構成します。

  1. Receive Locations を右クリックし、New -> One-Way Receive Location をクリックします。
  2. 新しい Receive Location がメンバーとなる適切な Receive Port を選択します。Receive Location Properties ダイアログが表示されます。
  3. Name メニューで、Receive Location の名前を入力します。
  4. Receive Location プロパティで、Transport Type メニューから CData.Zuora を選択します。
  5. Receive pipeline メニューで、デフォルトオプションの PassThruReceive を選択します。

アダプターの構成

Transport Properties ダイアログで、アダプターが実行するコマンドを指定します。

  1. Receive Location プロパティで、Configure をクリックします。アダプターの Transport Properties ダイアログが表示されます。
  2. SQL Command プロパティに、コマンドを入力します。この例では
    SELECT Id, BillingCity FROM Invoices WHERE BillingState = 'CA'
    を使用します。
利用可能なアダプター構成プロパティについては、"Adapter Configuration" の章を参照してください。

接続文字列の構成

Connection String Options ダイアログで、認証情報やその他の接続プロパティを設定します。

  1. Receive Location プロパティで、Configure をクリックします。アダプタープロパティダイアログが表示されます。
  2. Connection String プロパティのボタンをクリックします。
  3. Connection String プロパティのボックスをクリックします。Connection String Options ダイアログが表示されます。
  4. 接続プロパティを入力します。一般的な接続文字列は以下のとおりです:
    OAuthClientID=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;Tenant=USProduction;ZuoraService=DataQuery;
    

    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 サービスを使用します。デフォルトでは、ZuoraServiceAQuADataExport に設定されています。

    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回再試行可能で、その後失敗として返されます。
  5. Test Connection をクリックして、接続値を確認し接続をテストします。

各種プロパティとその機能の説明については、ヘルプドキュメントを参照してください。

Send Port を使用してデータを XML ファイルに書き込む

これで Static One-Way Receive Location を Send Port と共に使用する準備が整いました。Receive Location が作成した BizTalk メッセージには Send Port を関連付ける必要があります。データをファイルに書き込むには、File Send Port を作成します。

  1. BizTalk Administration コンソールで、Send Ports -> New -> Static One-Way Send Port を右クリックします。
  2. 構成ウィンドウの上部に Send Port の名前を入力し、Type メニューから FILE を選択します。

  3. 宛先フォルダを構成します。これがディスク上にファイルが作成される場所になります。
  4. ファイル名には、マクロを使用してファイルが作成された日付を簡単に識別できます。デフォルトでは %MessageId%.xml が使用されます。ただし、これはランダムに生成された BizTalk ID であるため、ユーザーフレンドリーな名前ではありません。Invoices_yyyy-MM-dd.xml 形式のファイルを作成するには、Invoices_%Date%.xml と入力します。

    :マクロの詳細については、ヘルプドキュメントの BizTalk Configuration セクションを参照してください。

  5. OK をクリックします。URI フィールドに値が入力されます。
  6. Send Port の構成画面の左側で Filters をクリックします。
  7. 以下のプロパティを設定します:
    Property:メニューから "BTS.InboundTransportLocation" を選択します。
    Operator:メニューから "==" を選択します。
    Value:Receive Location の URI を入力します。URI は Receive Location プロパティに表示されています。

これで、Send Port を使用して Receive Location から送信されたファイルを書き込めます。

Location と Port を Enlist および Enable する

最後のステップは、Send Port を Enlist し、Receive Location を Enable することです。Send Port を右クリックして Enlist をクリックします。次に、Receive Location を右クリックして Enable をクリックします。

:Receive Location は最後に Enable してください。これにより、ファイルが Send Port によって確実に書き込み用にピックアップされます。

トラブルシューティング

エラーが発生しているかどうかを確認するには、Administration Console のナビゲーションツリーで "Event Viewer (Local)" を展開します。Windows Logs を展開し、Applications をクリックします。

ログにはシステム上のすべてのアプリケーションのエラーメッセージが含まれるため、エラーメッセージのソースが "CData BizTalk Zuora Receive Adapter" であることを確認することが重要です。エラーメッセージの詳細から、エラーが発生している理由がわかります。エラーの解決方法については、[email protected]/jp にお問い合わせください。

はじめる準備はできましたか?