# mulesoft Zuora Aqua Connector - Full Documentation # Zuora AQuA Connector Zuora AQuA Connector v1.0.0 Zuora AQuA 用 Anypoint Connector (Zuora AQuA Connector) は、REST Connect 2.0 を使用して生成されるスマートコネクタです。Zuora AQuA Connector により、Zuora プラットフォームに接続して、Zuora AQuA API が提供するすべての機能を使用できます。機能の一例は次のとおりです。 - バッチクエリの作成 - ID によるバッチクエリジョブの削除 - ジョブ ID を使用した集計クエリの取得 - パートナープロジェクト ID によるバッチクエリジョブパートナープロジェクトの取得 - ファイル ID によるファイルの取得 Zuora AQuA API のメソッドおよびパラメーターについての詳細は、 [Zuora AQuA API のドキュメント](https://knowledgecenter.zuora.com/DC_Developers/AB_Aggregate_Query_API)​を参照してください。 ## [](#コネクタについて)コネクタについて Anypoint Connector とは、Salesforce、Zuora AQuA、ServiceNow、Twitter などの外部システムの API やリソースに接続できる Mule Runtime Engine (Mule) 拡張機能です。 ## [](#始める前に)始める前に Zuora AQuA Connector を使用するには、Zuora AQuA、Mule、Anypoint Connector、Anypoint Studio、Mule の概念、Mule フローの要素、グローバル要素に精通していることが必要です。 アプリケーションを作成する前に、Zuora AQuA の対象リソースおよび Anypoint Platform へのアクセス権を持っている必要があります。Anypoint Studio を使用して Mule アプリケーションを作成する方法を理解しておく必要があります。 ### [](#互換性)互換性
アプリケーション/サービス バージョン

Mule

4.1.1 以降

Anypoint Studio

7.1.2 以降

Zuora

R249
## [](#次のステップ)次のステップ このトピックを読み終えたら、​[Anypoint Studio](https://docs.mulesoft.com/jp/zuora-aqua-connector/latest/zuora-aqua-connector-studio)​ を使用してアプリケーションを作成する準備は完了です。 ## [](#関連情報)関連情報 - [Anypoint Exchange の Zuora AQuA Connector](https://www.mulesoft.com/exchange/com.mulesoft.connectors/mule-zuora-aqua-connector/) - [Zuora AQuA リリースノート](https://docs.mulesoft.com/jp/release-notes/connector/zuora-aqua-release-notes-mule-4) - [MuleSoft ヘルプセンター](https://help.mulesoft.com) - [REST Connect Connector ジェネレーター](https://docs.mulesoft.com/jp/exchange/to-deploy-using-rest-connect) # Zuora AQuA Connector の Studio 設定 Anypoint Studio でコネクタを設定するには、次のプロセスを実行します。 1. コネクタを Mule プロジェクトに追加します。 2. コネクタを設定します。 3. コネクタの入力元を設定します。 ## [](#プロジェクトへのコネクタの追加)プロジェクトへのコネクタの追加 Anypoint Studio には、コネクタを Mule プロジェクトに追加する方法が 2 つあります。 - Studio タスクバーの Exchange ボタンから - \[Mule Palette (Mule パレット)\] ビューから ### [](#exchange-を使用してコネクタを追加する)Exchange を使用してコネクタを追加する 1. Studio で Mule プロジェクトを作成します。 2. Studio タスクバーの左上にある Exchange ​**(X)**​ アイコンをクリックします。 3. Exchange で、​**\[Login (ログイン)\]**​ をクリックし、Anypoint Platform のユーザー名とパスワードを指定します。 4. Exchange で、​**「Zuora AQuA」**​を検索します。 5. コネクタを選択して ​**\[Add to project (プロジェクトに追加)\]**​ をクリックします。 6. 画面の指示に従ってコネクタをインストールします。 ### [](#studio-でコネクタに追加する)Studio でコネクタに追加する 1. Studio で Mule プロジェクトを作成します。 2. \[Mule Palette (Mule パレット)\] ビューで、\[​**(X)**​ Search in Exchange ((X) Exchange 内を検索)\] をクリックします。\* 3. **\[Add Modules to Project (モジュールをプロジェクトに追加)\]**​ で、検索項目に「Zuora AQuA」と入力します。 4. **\[Available modules (使用可能なモジュール)\]**​ で、このコネクタの名前をクリックします。 5. **\[Add (追加)\]**​ をクリックします。 6. **\[Finish (完了)\]**​ をクリックします。 ## [](#入力元の設定)入力元の設定 このコネクタのコネクタ操作、​**HTTP リスナー**​、​**スケジューラー**​などのコネクタの入力元を設定します。 ## [](#コネクタの設定)コネクタの設定 このコネクタを設定する手順は、次のとおりです。 1. コネクタの操作を Studio キャンバスにドラッグします。 2. コネクタのグローバル要素を作成するには、次の項目を設定します。 - **Username (ユーザー名)**​: Zuora ユーザー名 - **Password (パスワード)**​: Zuora パスワード - **Base Uri (ベース URI)**​: インスタンスの AQuA API のベースパス。例: `[https://rest.apisandbox.zuora.com:443/](https://rest.apisandbox.zuora.com:443/)` ![基本認証の \[Global Element Properties (グローバル要素プロパティ)\] ウィンドウ](_images/zuora-aqua-basic-auth-studio.png) ## [](#次のステップ)次のステップ このコネクタを Studio で設定したら、​[「Zuora AQuA の例」](https://docs.mulesoft.com/jp/zuora-aqua-connector/latest/zuora-aqua-connector-examples)​セクションを参照して Zuora AQuA Connector をお試しください。 ## [](#関連情報)関連情報 [MuleSoft ヘルプセンター](https://help.mulesoft.com) # Zuora AQuA Connector リファレンス サポートされるバージョン: Select Zuora AQuA Connector v1.0.0 ## [](#設定)設定 * * * ### [](#Config)設定 #### [](#パラメーター)パラメーター
名前 型 説明 デフォルト値 必須

Name (名前)

String (文字列)

この設定の名前。コネクタはこの名前の設定を参照します。

x

Connection (接続)

Basic Connection Provider (基本接続プロバイダー)

この設定に指定する接続型。

x

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

1

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response Timeout (応答タイムアウト) の時間単位。

MINUTES (分)

Name (名前)

String (文字列)

他のコンポーネント内のこの要素を参照するために使用するこの要素の識別子。

x

Expiration Policy (有効期限ポリシー)

Expiration Policy (有効期限ポリシー)

動的設定インスタンスがアイドル状態を続けられる最小時間を設定します。この時間が経過すると、期限切れに相当するとみなされます。インスタンスが期限切れとみなされた瞬間にインスタンスが期限切れになるという意味ではありません。必要に応じて、インスタンスがパージされます。
#### [](#接続種別)接続種別 ##### [](#Config_Basic)Basic Connection Provider (基本接続プロバイダー) ###### [](#パラメーター-2)パラメーター
名前 型 説明 デフォルト値 必須

Default Headers (デフォルトヘッダー)

Default Header (デフォルトヘッダー)​ の配列

クエリパラメーター

Default Query Param (デフォルトクエリパラメーター)​ の配列

Connection Timeout (接続タイムアウト)

Number (数値)

リモートサービスへの接続を確立する場合のタイムアウト。

30

Connection Timeout Unit (接続タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

接続タイムアウトの時間単位

SECONDS (秒)

Use Persistent Connections (永続接続を使用)

Boolean (ブール)

false​ の場合、各接続は最初の要求が完了すると終了します。

true

Max Connections (最大接続数)

Number (数値)

同時に開いておくことができるアウトバウンド接続の最大数

-1

Connection Idle Timeout (接続アイドルタイムアウト)

Number (数値)

接続が終了するまでのアイドル状態を維持できる時間を表すタイムアウト。

30

Connection Idle Timeout Unit (接続アイドルタイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

接続アイドルタイムアウトの時間単位

SECONDS

Proxy Config (プロキシ設定)

Proxy (プロキシ)

プロキシ経由のアウトバウンド接続の再利用可能な設定要素。

Stream Response (応答のストリーミング)

Boolean (ブール)

受信した応答をストリーミングするかどうか

false

Response Buffer Size (応答バッファサイズ)

Number (数値)

HTTP 応答が保存されるバッファの領域 (バイト数)。

-1

Username (ユーザー名)

String (文字列)

要求を認証するためのユーザー名。

Password (パスワード)

String (文字列)

要求を認証するためのパスワード。

Base Uri (ベース URI)

String (文字列)

各インスタンスまたはテナントが独自に取得するパラメーターベース URI

https://rest.apisandbox.zuora.com:443

TLS Configuration (TLS 設定)

TLS

Reconnection (再接続)

Reconnection (再接続)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。​true​ に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。
## [](#操作)操作 - [Post Query or Export Deleted Data](#CreateV1BatchQuery) - [Delete a Running Job](#DeleteV1BatchQueryJobsById) - [Get Job Results](#GetV1BatchQueryJobsById) - [Get Last Job Completed](#GetV1BatchQueryJobsPartnerProjectByPartnerProject) - [Get Results Files](#GetV1FileByFileId) ## [](#sources-ソース)Sources (ソース) - [Batch JobResponse Result Listener](#BatchJobResultListener)
このソース (リスナー) では、ウォーターマークの保存にオブジェクトストアが使用されます。使用しているオブジェクトストアの実装 (CloudHub デプロイメント用のオブジェクトストアやオンプレミスデプロイメント用のオブジェクトストア) に固有の制限がある可能性があるため、ニーズに合わせてオブジェクトストアを設定してください。
詳細は、 「The Different Types of Object Stores Explained (異なる種別のオブジェクトストアの説明)」​を参照してください。
## [](#CreateV1BatchQuery)Post Query or Export Deleted Data `` この操作では、​`/v1/batch-query/`​ エンドポイントに HTTP POST 要求を行います。 POST クエリは以下の目的で使用します。 - 削除済みデータのエクスポート - API バージョンの POST クエリ - 通知の POST クエリ - 取得時間の POST クエリ ### [](#パラメーター-3)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://docs.mulesoft.com/jp/zuora-aqua-connector/latest/%3Ca href="https://knowledgecenter.zuora.com/​BB_I​ntroducing_​Z_B​usiness/Multi-entity" class="bare">https://knowledgecenter.zuora.com/​BB_I​ntroducing_​Z_B​usiness/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-Entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

反復可能なストリームを使用するように設定します。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

応答タイムアウトの時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。
### [](#出力)出力

型

Any (任意)
### [](#次の設定の場合)次の設定の場合 - [設定](#Config) ### [](#スロー)スロー - MULE-ZUORA-AQUA-CONNECTOR:BAD\_REQUEST - MULE-ZUORA-AQUA-CONNECTOR:CLIENT\_ERROR - MULE-ZUORA-AQUA-CONNECTOR:CONNECTIVITY - MULE-ZUORA-AQUA-CONNECTOR:INTERNAL\_SERVER\_ERROR - MULE-ZUORA-AQUA-CONNECTOR:NOT\_ACCEPTABLE - MULE-ZUORA-AQUA-CONNECTOR:NOT\_FOUND - MULE-ZUORA-AQUA-CONNECTOR:RETRY\_EXHAUSTED - MULE-ZUORA-AQUA-CONNECTOR:SERVER\_ERROR - MULE-ZUORA-AQUA-CONNECTOR:SERVICE\_UNAVAILABLE - MULE-ZUORA-AQUA-CONNECTOR:TIMEOUT - MULE-ZUORA-AQUA-CONNECTOR:TOO\_MANY\_REQUESTS - MULE-ZUORA-AQUA-CONNECTOR:UNAUTHORIZED - MULE-ZUORA-AQUA-CONNECTOR:UNSUPPORTED\_MEDIA\_TYPE ## [](#DeleteV1BatchQueryJobsById)Delete a Running Job `` この REST API は、現在のジョブが未完了であれば、そのジョブを削除します。ジョブが完了している場合は、エラーがスローされます。この操作では、​`/v1/batch-query/jobs/{id}`​ エンドポイントに対する HTTP DELETE 要求を行います。 ### [](#パラメーター-4)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

ジョブの ID。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://docs.mulesoft.com/jp/zuora-aqua-connector/latest/%3Ca href="https://knowledgecenter.zuora.com/​BB_I​ntroducing_​Z_B​usiness/Multi-entity" class="bare">https://knowledgecenter.zuora.com/​BB_I​ntroducing_​Z_B​usiness/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-Entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

反復可能なストリームを使用するように設定します。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。
### [](#出力-2)出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)
### [](#次の設定の場合-2)次の設定の場合 - [設定](#Config) ### [](#スロー-2)スロー - MULE-ZUORA-AQUA-CONNECTOR:BAD\_REQUEST - MULE-ZUORA-AQUA-CONNECTOR:CLIENT\_ERROR - MULE-ZUORA-AQUA-CONNECTOR:CONNECTIVITY - MULE-ZUORA-AQUA-CONNECTOR:INTERNAL\_SERVER\_ERROR - MULE-ZUORA-AQUA-CONNECTOR:NOT\_ACCEPTABLE - MULE-ZUORA-AQUA-CONNECTOR:NOT\_FOUND - MULE-ZUORA-AQUA-CONNECTOR:RETRY\_EXHAUSTED - MULE-ZUORA-AQUA-CONNECTOR:SERVER\_ERROR - MULE-ZUORA-AQUA-CONNECTOR:SERVICE\_UNAVAILABLE - MULE-ZUORA-AQUA-CONNECTOR:TIMEOUT - MULE-ZUORA-AQUA-CONNECTOR:TOO\_MANY\_REQUESTS - MULE-ZUORA-AQUA-CONNECTOR:UNAUTHORIZED - MULE-ZUORA-AQUA-CONNECTOR:UNSUPPORTED\_MEDIA\_TYPE ## [](#GetV1BatchQueryJobsById)Get Job Results `` ジョブ ID を使用して集約クエリを取得します。この操作では、/v1/batch-query/jobs/{id} エンドポイントに対する HTTP GET 要求を行います。 ### [](#パラメーター-5)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

ジョブの ID。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://docs.mulesoft.com/jp/zuora-aqua-connector/latest/%3Ca href="https://knowledgecenter.zuora.com/​BB_I​ntroducing_​Z_B​usiness/Multi-entity" class="bare">https://knowledgecenter.zuora.com/​BB_I​ntroducing_​Z_B​usiness/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-Entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

反復可能なストリームを使用するように設定します。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。
### [](#出力-3)出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)
### [](#次の設定の場合-3)次の設定の場合 - [設定](#Config) ### [](#スロー-3)スロー - MULE-ZUORA-AQUA-CONNECTOR:BAD\_REQUEST - MULE-ZUORA-AQUA-CONNECTOR:CLIENT\_ERROR - MULE-ZUORA-AQUA-CONNECTOR:CONNECTIVITY - MULE-ZUORA-AQUA-CONNECTOR:INTERNAL\_SERVER\_ERROR - MULE-ZUORA-AQUA-CONNECTOR:NOT\_ACCEPTABLE - MULE-ZUORA-AQUA-CONNECTOR:NOT\_FOUND - MULE-ZUORA-AQUA-CONNECTOR:RETRY\_EXHAUSTED - MULE-ZUORA-AQUA-CONNECTOR:SERVER\_ERROR - MULE-ZUORA-AQUA-CONNECTOR:SERVICE\_UNAVAILABLE - MULE-ZUORA-AQUA-CONNECTOR:TIMEOUT - MULE-ZUORA-AQUA-CONNECTOR:TOO\_MANY\_REQUESTS - MULE-ZUORA-AQUA-CONNECTOR:UNAUTHORIZED - MULE-ZUORA-AQUA-CONNECTOR:UNSUPPORTED\_MEDIA\_TYPE ## [](#GetV1BatchQueryJobsPartnerProjectByPartnerProject)Get Last Job Completed `` 最後に完了したジョブの詳細を取得します。この操作では、/v1/batch-query/jobs/partner/{partner}/project/{project} エンドポイントに対する HTTP GET 要求を行います。 ### [](#パラメーター-6)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

パートナー

String (文字列)

パートナー項目はデータインテグレーションパートナーの一意の ID を示します。

x

プロジェクト

String (文字列)

プロジェクト項目には特定のパートナーのデータインテグレーションパートナーの一意の ID が含まれています。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://docs.mulesoft.com/jp/zuora-aqua-connector/latest/%3Ca href="https://knowledgecenter.zuora.com/​BB_I​ntroducing_​Z_B​usiness/Multi-entity" class="bare">https://knowledgecenter.zuora.com/​BB_I​ntroducing_​Z_B​usiness/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

反復可能なストリームを使用するように設定します。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。
### [](#出力-4)出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)
### [](#次の設定の場合-4)次の設定の場合 - [設定](#Config) ### [](#スロー-4)スロー - MULE-ZUORA-AQUA-CONNECTOR:BAD\_REQUEST - MULE-ZUORA-AQUA-CONNECTOR:CLIENT\_ERROR - MULE-ZUORA-AQUA-CONNECTOR:CONNECTIVITY - MULE-ZUORA-AQUA-CONNECTOR:INTERNAL\_SERVER\_ERROR - MULE-ZUORA-AQUA-CONNECTOR:NOT\_ACCEPTABLE - MULE-ZUORA-AQUA-CONNECTOR:NOT\_FOUND - MULE-ZUORA-AQUA-CONNECTOR:RETRY\_EXHAUSTED - MULE-ZUORA-AQUA-CONNECTOR:SERVER\_ERROR - MULE-ZUORA-AQUA-CONNECTOR:SERVICE\_UNAVAILABLE - MULE-ZUORA-AQUA-CONNECTOR:TIMEOUT - MULE-ZUORA-AQUA-CONNECTOR:TOO\_MANY\_REQUESTS - MULE-ZUORA-AQUA-CONNECTOR:UNAUTHORIZED - MULE-ZUORA-AQUA-CONNECTOR:UNSUPPORTED\_MEDIA\_TYPE ## [](#GetV1FileByFileId)Get Results Files `` この REST API は、指定されたファイル形式で結果を取得します。AQuA 結果ファイルは 7 日後にパージされます。この操作では、/v1/file/{file-id} エンドポイントに対する HTTP GET 要求を行います。 ### [](#パラメーター-7)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

File id (ファイル ID)

String (文字列)

取得するファイルの Zuora ID。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://docs.mulesoft.com/jp/zuora-aqua-connector/latest/%3Ca href="https://knowledgecenter.zuora.com/​BB_I​ntroducing_​Z_B​usiness/Multi-entity" class="bare">https://knowledgecenter.zuora.com/​BB_I​ntroducing_​Z_B​usiness/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

反復可能なストリームを使用するように設定します。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。
### [](#出力-5)出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)
### [](#次の設定の場合-5)次の設定の場合 - [設定](#Config) ### [](#スロー-5)スロー - MULE-ZUORA-AQUA-CONNECTOR:BAD\_REQUEST - MULE-ZUORA-AQUA-CONNECTOR:CLIENT\_ERROR - MULE-ZUORA-AQUA-CONNECTOR:CONNECTIVITY - MULE-ZUORA-AQUA-CONNECTOR:INTERNAL\_SERVER\_ERROR - MULE-ZUORA-AQUA-CONNECTOR:NOT\_ACCEPTABLE - MULE-ZUORA-AQUA-CONNECTOR:NOT\_FOUND - MULE-ZUORA-AQUA-CONNECTOR:RETRY\_EXHAUSTED - MULE-ZUORA-AQUA-CONNECTOR:SERVER\_ERROR - MULE-ZUORA-AQUA-CONNECTOR:SERVICE\_UNAVAILABLE - MULE-ZUORA-AQUA-CONNECTOR:TIMEOUT - MULE-ZUORA-AQUA-CONNECTOR:TOO\_MANY\_REQUESTS - MULE-ZUORA-AQUA-CONNECTOR:UNAUTHORIZED - MULE-ZUORA-AQUA-CONNECTOR:UNSUPPORTED\_MEDIA\_TYPE ## [](#ソース)ソース ## [](#BatchJobResultListener)Batch JobResponse Result Listener `` 指定されたオブジェクトストア (PostQuery から入力されます) から取得したジョブの状況を定期的にポーリングし、予期される状況のジョブの結果を返します。このソースは、PostQuery 操作で送信されたジョブに対してのみ機能します。 ### [](#パラメーター-8)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Object Store Name (オブジェクトストア名)

String (文字列)

PostQuery の結果から JobId を格納している objectStore の名前を返します。

エンティティパラメーター

Entity Parameter Group (エンティティパラメーターグループ)

予期される状況

Enumeration (列挙)。次のいずれかになります。

  • PENDING

  • EXECUTING

  • COMPLETED

  • ABORTED

  • CANCELLED

  • SUBMITTED

  • ERROR

取得するジョブの予期される状況。

COMPLETED

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Primary Node Only (プライマリノードのみ)

Boolean (ブール)

クラスターでの実行時、このソースをプライマリノード上でのみ実行する必要があるかどうか。

Scheduling Strategy (スケジュール戦略)

scheduling-strategy

ポーリングをトリガーするスケジューラーを設定します。

x

Streaming Strategy (ストリーミング戦略)

反復可能なストリームを使用するように設定します。

Redelivery Policy (再配信ポリシー)

Redelivery Policy (再配信ポリシー)

同じメッセージの再配信を処理するためのポリシー。

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。
### [](#出力-6)出力

型

Any (任意)

Attributes Type (属性型)

Any (任意)
### [](#次の設定の場合-6)次の設定の場合 - [設定](#Config) ## [](#型)型 ### [](#DefaultHeader)Default Header (デフォルトヘッダー)
項目 型 説明 デフォルト値 必須

Key (キー)

String (文字列)

x

Value (値)

String (文字列)

x
### [](#DefaultQueryParam)Default Query Param (デフォルトクエリパラメーター)
項目 型 説明 デフォルト値 必須

Key (キー)

String (文字列)

x

Value (値)

String (文字列)

x
### [](#Proxy)Proxy (プロキシ)
項目 型 説明 デフォルト値 必須

Host (ホスト)

String (文字列)

x

Port (ポート)

Number (数値)

x

Username (ユーザー名)

String (文字列)

Password (パスワード)

String (文字列)

Non Proxy Hosts (非プロキシホスト)

String (文字列)
### [](#Tls)TLS
項目 型 説明 デフォルト値 必須

Enabled Protocols (有効化されたプロトコル)

String (文字列)

このコンテキストで有効化されたプロトコルのカンマ区切りリスト。

Enabled Cipher Suites (有効化された暗号化スイート)

String (文字列)

このコンテキストで有効化された暗号化スイートのカンマ区切りリスト。

Trust Store (トラストストア)

トラストストア

Key Store (キーストア)

Key Store (キーストア)

Revocation Check (取り消し確認)
### [](#TrustStore)トラストストア
項目 型 説明 デフォルト値 必須

Path (パス)

String (文字列)

トラストストアの場所 (可能な場合、現在のクラスパスとファイルシステムを基準として解決されます)。

Password (パスワード)

String (文字列)

トラストストアを保護するために使用するパスワード。

Type (型)

String (文字列)

使用するストアの型。

Algorithm (アルゴリズム)

String (文字列)

トラストストアで使用するアルゴリズム。

Insecure (安全ではない)

Boolean (ブール)

true の場合、証明書の検証が実行されず、攻撃に対して接続が脆弱になります。各自の責任で使用してください。
### [](#KeyStore)Key Store (キーストア)
項目 型 説明 デフォルト値 必須

Path (パス)

String (文字列)

キーストアの場所 (可能な場合、現在のクラスパスとファイルシステムを基準として解決されます)。

Type (型)

String (文字列)

使用するストアの型。

Alias (別名)

String (文字列)

キーストアに多数の非公開キーがある場合、この属性は、使用する鍵の別名を示します。定義しない場合、デフォルトでファイル内の最初の鍵が使用されます。

Key Password (キーパスワード)

String (文字列)

非公開キーを保護するために使用するパスワード。

Password (パスワード)

String (文字列)

キーストアを保護するために使用するパスワード。

Algorithm (アルゴリズム)

String (文字列)

キーストアで使用するアルゴリズム。
### [](#StandardRevocationCheck)Standard Revocation Check (標準の取り消し確認)
項目 型 説明 デフォルト値 必須

Only End Entities (最後のエンティティのみ)

Boolean (ブール)

証明書チェーンの最後の要素のみを確認します。

Prefer Crls (CRL を優先)

Boolean (ブール)

最初に OCSP ではなく CRL を試みます。

No Fallback (代替なし)

Boolean (ブール)

第 2 の確認方法 (以前に選択されていない方法) を使用しません。

Soft Fail (ソフトフェール)

Boolean (ブール)

取り消しサーバーに到達できない場合や取り消しサーバーが混雑している場合に検証エラーを回避します。
### [](#CustomOcspResponder)Custom Ocsp Responder (カスタム Ocsp レスポンダー)
項目 型 説明 デフォルト値 必須

Url

String (文字列)

OCSP レスポンダーの URL。

Cert Alias (証明書の別名)

String (文字列)

(トラストストアに含まれている) OCSP 応答の署名証明書の別名 (存在する場合)。
### [](#CrlFile)Crl File (Crl ファイル)
項目 型 説明 デフォルト値 必須

Path (パス)

String (文字列)

CRL ファイルへのパス。
### [](#Reconnection)Reconnection (再接続)
項目 型 説明 デフォルト値 必須

Fails Deployment (デプロイメントに失敗)

Boolean (ブール)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。

Reconnection Strategy (再接続戦略)

使用する再接続戦略。
### [](#Reconnect)Reconnect (再接続)
項目 型 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続する頻度 (ミリ秒)。

Blocking

Boolean (ブール)

false の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

Count (数)

Number (数値)

再接続の試行回数。
### [](#ReconnectForever)Reconnect Forever (繰り返し再接続)
項目 型 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続する頻度 (ミリ秒)。

Blocking

Boolean (ブール)

false の場合、再接続戦略が個別の非ブロックスレッドで実行されます。
### [](#ExpirationPolicy)Expiration Policy (有効期限ポリシー)
項目 型 説明 デフォルト値 必須

Max Idle Time (最大アイドル時間)

Number (数値)

有効期限の対象とみなされるまで、動的設定インスタンスがアイドル状態を維持できる最大時間のスカラー時間値

Time Unit (時間単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

maxIdleTime 属性の時間単位
### [](#EntityParametersGroup)Entity Parameter Group (エンティティパラメーターグループ)
項目 型 説明 デフォルト値 必須

Entity Id (エンティティ ID)

String (文字列)

Zuora AQuA カスタマーが複数のエンティティを持つ場合の省略可能なパラメーター (entityId または entityName のどちらかを指定する必要があります)。

Entity Name (エンティティ名)

String (文字列)

Zuora AQuA カスタマーが複数のエンティティを持つ場合の省略可能なパラメーター (entityId または entityName のどちらかを指定する必要があります)。
### [](#RepeatableInMemoryStream)Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
項目 型 説明 デフォルト値 必須

Initial Buffer Size (初期バッファサイズ)

Number (数値)

ストリームをコンシュームしてランダムにアクセスするために割り当てられるメモリ量。ストリームのデータ量がこのバッファサイズを超える場合は、​[Buffer Size Increment (バッファサイズ増分)]​ 属性に従って、​[Max in memory size (最大メモリ内サイズ)]​ を上限としてバッファが拡張されます。

Buffer Size Increment (バッファサイズ増分)

Number (数値)

バッファサイズが初期サイズを超えた場合にバッファサイズをどれだけ拡張するかを指定します。値を 0 または負の値に設定すると、バッファが拡張されません。つまり、バッファがフルになると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。

Max Buffer Size (最大バッファサイズ)

Number (数値)

使用するメモリの最大量。これを超えると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。0 以下の値は無制限を意味します。

Buffer Unit (バッファ単位)

Enumeration (列挙)。次のいずれかになります。

  • BYTE (バイト)

  • KB

  • MB

  • GB

これらのすべての属性の単位
### [](#RepeatableFileStoreStream)Repeatable File Store Stream (反復可能なファイルストアストリーム)
項目 型 説明 デフォルト値 必須

In Memory Size (メモリ内サイズ)

Number (数値)

データをメモリ内に保持するためにストリームで使用する最大メモリを定義します。これを超えると、ディスクへのコンテンツのバッファが開始されます。

Buffer Unit (バッファ単位)

Enumeration (列挙)。次のいずれかになります。

  • BYTE (バイト)

  • KB

  • MB

  • GB

[Max in Memory Size (最大メモリ内サイズ)]​ を表す単位
### [](#RedeliveryPolicy)Redelivery Policy (再配信ポリシー)
項目 型 説明 デフォルト値 必須

Max Redelivery Count (最大再配信数)

Number (数値)

プロセス失敗メッセージをトリガーするまでに、正常に処理されないメッセージを再配信できる最大回数。

Message Digest Algorithm (メッセージダイジェストアルゴリズム)

String (文字列)

使用するセキュアハッシュアルゴリズム。設定しない場合、デフォルトの SHA-256 になります。

Message Identifier (メッセージ識別子)

Redelivery Policy Message Identifier (再配信ポリシーメッセージ識別子)

メッセージを識別するために使用する戦略を定義します。

Object Store (オブジェクトストア)

ObjectStore

各メッセージの再配信カウンターが保存されるオブジェクトストア。
### [](#RedeliveryPolicyMessageIdentifier)Redelivery Policy Message Identifier (再配信ポリシーメッセージ識別子)
項目 型 説明 デフォルト値 必須

Use Secure Hash (セキュアハッシュを使用)

Boolean (ブール)

再配信されたメッセージの識別にセキュアハッシュアルゴリズムを使用するかどうか。

Id Expression (ID 式)

String (文字列)

メッセージがいつ再配信されたのかを判断するために使用する 1 つ以上の式を定義します。このプロパティは、useSecureHash が false の場合にのみ設定できます。
### [](#HttpResponseAttributes)Http Response Attributes (HTTP 応答属性)
項目 型 説明 デフォルト値 必須

Status Code (状況コード)

Number (数値)

x

Headers (ヘッダー)

Object (オブジェクト)

x

Reason Phrase (理由を示す語句)

String (文字列)

x
# Zuora AQuA の XML および Maven サポート Anypoint Studio の XML エディターまたはテキストエディターから XML で Mule アプリケーションを手動でコーディングする場合、参照ステートメントを XML Mule フローおよび Apache Maven POM ファイルに追加することで、アプリケーションでコネクタにアクセスできます。

Studio を使用して、このトピックで説明されている手動プロセスを回避できます。コネクタを Studio にインストールすると、Studio は自動的に XML コードにコネクタの名前空間およびスキーマの場所を入力し、POM ファイルに連動関係を追加します。
## [](#コネクタの名前空間の追加)コネクタの名前空間の追加 次のコードを設定 XML のヘッダーの ​``​ タグ内に貼り付けます。 ```text xsi:schemaLocation=" ... http://www.mulesoft.org/schema/mule/zuora-aqua-connector http://www.mulesoft.org/schema/mule/zuora-aqua-connector/current/mule-zuora-aqua-connector.xsd" ``` 次の例は、mule XML ブロック内に名前空間ステートメントが配置される方法を示しています。 ```xml ``` ## [](#pomfile)POM ファイルの連動関係の追加 `pom.xml`​ Maven ファイルは Anypoint Studio によって生成され、Mule アプリケーションの連動関係が含まれます。Mule アプリケーションを手動でコーディングする場合、次の XML スニペットを POM ファイルに含めてこのコネクタにアクセスできるようにします。 ```xml com.mulesoft.connectors mule-zuora-aqua-connector x.x.x mule-plugin ``` `x.x.x`​ を使用しているコネクタに対応するバージョンに置き換えます。 最新の ​`pom.xml`​ ファイル情報を取得するには、​ [Anypoint Exchange](https://www.mulesoft.com/exchange/)​ でコネクタにアクセスし、​**\[Dependency Snippets (連動関係スニペット)\]**​ をクリックします。 ## [](#次のステップ)次のステップ このセクションを完了したら、​[「Zuora AQuA の例」](https://docs.mulesoft.com/jp/zuora-aqua-connector/latest/zuora-aqua-connector-examples)​を試してください。 ## [](#関連情報)関連情報 - [MuleSoft ヘルプセンター](https://help.mulesoft.com) # Zuora AQuA の例 ## [](#例-アカウントの詳細の取得)例: アカウントの詳細の取得 この例では、指定されたアカウント ID のアカウント詳細を取得して JSON 形式で返します。 ## [](#studio-のフロー)Studio のフロー - HTTP ​**Listener**​ HTTP 要求からデータを受け入れます。 - **Get last job completed**​ Anypoint Connector for Zuora AQuA は Zuora と接続し、クエリを実行して指定されたアカウント ID のアカウント詳細を取得します。​**Get last job completed**​ 操作を追加して、最後に完了したジョブの詳細を返します。 - **Transform Message**​ **Get last job completed**​ 操作の結果を JSON 形式で出力します。 ![Listener、Get last job completed、Transform Message を含む Studio フロー](/mulesoft/current/ja-jp/zuora-aqua-connector/latest/_images/zuora-aqua-studio-use-case.png) ## [](#xml-フロー)XML フロー 次の XML コードを Anypoint Studio に貼り付けて、フローの例を試してください。 ```xml ``` ## [](#関連情報)関連情報 - [MuleSoft ヘルプセンター](https://help.mulesoft.com) - [知識ベース記事](https://support.mulesoft.com/s/knowledge)