Product、Account、または RatePlan などのオブジェクトを Zuora アプリケーションから照会するには、Zuora「オブジェクトの照会」アクティビティーを使用します。この操作で指定する照会ストリングは、Zuora Object Query Language 標準に準拠している必要があります。
このタスクについて
Zuora アプリケーションからオブジェクトを照会するには、このタスクを使用します。このアクティビティーの呼び出しは、同期呼び出しです。同期呼び出しでは、入力データが処理のためにアクティビティーに送信され、オーケストレーションに応答が返信されます。
Zuora「オブジェクトの照会」アクティビティーを構成するには、次のステップを実行します。
手順
- アクティブなオーケストレーションで、「アクティビティー」タブを開いて Zuora フォルダーのコンテンツを展開します。
- 「オブジェクトの照会」アクティビティー・アイコンをオーケストレーション上にドラッグします。 Zuora オブジェクトの照会「チェックリスト」が表示されます。
- 「チェックリスト」で、「要約」をクリックします。
- 「アクティビティー名」フィールドの内容を確認して、必要に応じて必要な変更を行います。
- 「チェックリスト」で、「エンドポイントの選出」をクリックします。
- 「参照」をクリックし、「プロジェクト・エクスプローラー」ダイアログ・ボックスを使用して、関連する Zuora エンドポイントを選択します。
- オプション: 「新規作成」をクリックして必要な接続の詳細を指定することで、エンドポイントを作成することができます。 「接続のテスト」をクリックして、Zuora アプリケーションに正常に接続されたことをテストします。この構成のエンドポイントを保存して使用するには、「OK」をクリックします。
- 選択したエンドポイントの構成に対して必要な変更を行うには、「編集」をクリックして、別のウィンドウでオプションにアクセスします。 変更を行うと、アクティブなオーケストレーションで使用されているすべてのエンドポイントに、グローバルに影響します。
- 「チェックリスト」から「入力のマップ」を選択します。
「オブジェクトの照会」アクティビティーの選択したオブジェクトから生成された XML スキーマが、「アクティビティーへ」パネルの request 入力パラメーターの下にノードとして表示されます。
- オーケストレーション変数とアクティビティーの入力パラメーターとの間のマップを作成します。
注: 入力構造の必須エレメントの値は、実行時に指定されている必要があります。 この値は、エレメントのデフォルト値を指定するか、エレメントを入力ノードにリンクすることによって指定できます。 実行時に必須エレメントの値が指定されていないと、アクティビティーは完了し、queryResponse の結果にはエラー・メッセージが取り込まれます。アクティビティーの応答をレビューすることにより、要求が成功したのか失敗したのかを判別できます。
- 「チェックリスト」から「出力のマップ」を選択します。
アクティビティーの応答保持のために生成された XML スキーマが、「アクティビティーから」パネルの response 出力パラメーターの下にノードとして表示されます。
- 出力パラメーターとオーケストレーション変数との間のマップを作成します。
注: 「オブジェクトの照会」アクティビティーの出力は
queryResponse であり、これは一般的な構造を持ちます。
「オブジェクトの照会」アクティビティーの出力を以降のアクティビティーで使用しなければならない場合は、
直接マッピングを行うことはできません。データは、「XSLT の適用」アクティビティーを
活用して queryResponse から抽出する必要があります。
特定のデータ抽出に使用できるサンプルの XSLT を以下に示します。
<?xml version="1.0" encoding="UTF-8"?>
<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:ns1="http://api.zuora.com/" xmlns:ns2="http://object.api.zuora.com/">
<xsl:template match="/ns1:queryResponse/ns1:result">
<xsl:element name="Products">
<xsl:apply-templates select="ns1:records" />
</xsl:element>
</xsl:template>
<xsl:template match="ns1:records">
<xsl:element name="Product">
<xsl:element name="Id">
<xsl:value-of select="ns2:Id"/>
</xsl:element >
<xsl:element name="Name">
<xsl:value-of select="ns2:Name"/>
</xsl:element >
<xsl:element name="SKU">
<xsl:value-of select="ns2:SKU"/>
</xsl:element >
<xsl:element name="EffectiveStartDate">
<xsl:value-of select="ns2:EffectiveStartDate"/>
</xsl:element >
<xsl:element name="EffectiveEndDate">
<xsl:value-of select="ns2:EffectiveEndDate"/>
</xsl:element >
<xsl:element name="Description">
<xsl:value-of select="ns2:Description"/>
</xsl:element >
</xsl:element>
</xsl:template>
</xsl:stylesheet>
タスクの結果
Zuora「オブジェクトの照会」アクティビティーを構成しました。