Zuora Connector の 6.0.x へのアップグレードおよび移行
Zuora 用 Anypoint Connector (Zuora Connector) をバージョン 6.0.x にアップグレードします。
新規操作
Zuora Connector 6.0.0 には、次の新しい操作が含まれています。
| Zuora 6.0.0 の新しい操作 | |
|---|---|
名前 |
説明 |
Generate an OAuth token |
生成されるベアラートークンを使用して OAuth クライアントを Zuora REST API で認証することができます。 |
Object POSTFeature |
この操作では、/v1/object/feature エンドポイントに対する HTTP POST 要求を行います。 |
Get workflow task usage |
指定された期間内でのワークフロータスクの日別使用状況を取得します。 |
Object PUTFeature |
この操作では、/v1/object/feature/{id} エンドポイントに対する HTTP PUT 要求を行います。 |
PUT Rev Pro Accounting Codes |
Zuora 請求の特定の製品料金プランチャージ ID に対応する Zuora 収益勘定コードを更新します。 |
Update subscription custom fields of a specified subscription version |
指定されたバージョンのカスタム項目を更新します。 |
削除された操作
Zuora Connector 6.0.0 では、次の操作が削除されました。
| Zuora 6.0.0 で削除された操作 | |
|---|---|
名前 |
説明 |
Import usage file |
この操作では、/usage-imports エンドポイントに対する HTTP POST 要求を行います。 |
Create usage records |
この操作では、/usage エンドポイントに対する HTTP POST 要求を行います。 |
Request breakdown of credit memo items by order |
注文別に分類された、指定したクレジットメモ項目を取得します。 |
Request breakdown of invoice items by order |
注文別に分類された、指定した請求書項目を取得します。 |
Delete schema of Usage custom field definition |
この操作では、/fields/definitions/Usage エンドポイントに対して HTTP DELETE 要求を行います。 |
CRUD: Delete payment method snapshot |
この REST API リファレンスでは、支払方法スナップショットを削除する方法について説明します。 |
Get Usage custom field definition |
この操作では、/fields/definitions/Usage エンドポイントに対して HTTP GET 要求を行います。 |
Get rating results by account |
この操作では、/rating/rated-results/account/{accountNumber} エンドポイントに対する HTTP GET 要求を行います。 |
Get rating results by charge |
この操作では、/rating/rated-results/charge/{chargeNumber} エンドポイントに対する HTTP GET 要求を行います。 |
Get rating results by subscription |
この操作では、/rating/rated-results/subscription/{subscriptionNumber} エンドポイントに対する HTTP GET 要求を行います。 |
Get rated usage by account |
この操作では、/rating/rated-usages/account/{accountNumber} エンドポイントに対する HTTP GET 要求を行います。 |
Get rated usage by charge |
この操作では、/rating/rated-usages/charge/{chargeNumber} エンドポイントに対する HTTP GET 要求を行います。 |
Get rated usage by subscription |
この操作では、/rating/rated-usages/subscription/{subscriptionNumber} エンドポイントに対する HTTP GET 要求を行います。 |
Get status of usage import |
Get details of usage import |
Download usage import failure file |
この操作では、/usage-imports/{id}/errors エンドポイントに対する HTTP GET 要求を行います。 |
Download usage import file |
この操作では、usage-imports/{id}/import-file エンドポイントに対する HTTP GET 要求を行います。 |
Get status of usage import |
この操作では、/usage-imports/{id}/status エンドポイントに対して HTTP GET 要求を行います。 |
Download usage file template |
この操作では、/usage-imports/templates/html エンドポイントに対して HTTP GET 要求を行います。 |
Query usage records in stream |
この操作では、/usage/stream-query エンドポイントに対して HTTP GET 要求を行います。 |
Get breakdown of credit memo by order |
注文別に分類された指定されたクレジットメモを取得します。1 つのクレジットメモ項目を注文関連項目のリストに分類することができます。 |
Get breakdown of invoice by order |
注文別に分類された指定された請求書を取得します。1 つの請求書項目を注文関連項目のリストに分類することができます。 |
Get rated result for order |
指定された注文のすべてのサブスクリプションの評価結果を取得します。 |
使用状況カスタム項目定義のスキーマを設定します。 |
この操作では、/fields/definitions/Usage エンドポイントに対して HTTP PUT 要求を行います。 |
Update usage record |
指定された使用状況レコードの特定の情報を更新します。 |
操作パラメーターの変更
次の操作が変更されています。
| Zuora 5.x に存在 | Zuora 6.x で変更された操作 | ||||
|---|---|---|---|---|---|
操作名 |
入力パラメーター |
出力パラメーター |
操作名 |
入力パラメーター |
出力パラメーター |
Create Credit Memo From Charge |
なし |
なし |
Create Credit Memo From Charge |
なし |
taxStatus (追加) taxMessage (追加) |
Get Credit Memo |
なし |
なし |
Get Credit Memo |
なし |
taxStatus (追加) taxMessage (追加) |
Update Credit Memo |
なし |
なし |
Update Credit Memo |
なし |
taxStatus (追加) taxMessage (追加) |
Apply Credit Memo |
なし |
なし |
Apply Credit Memo |
なし |
taxStatus (追加) taxMessage (追加) |
Unapply Credit Memo |
なし |
なし |
Unapply Credit Memo |
なし |
taxStatus (追加) taxMessage (追加) |
Cancel Credit Memo |
なし |
なし |
Cancel Credit Memo |
なし |
taxStatus (追加) taxMessage (追加) |
Post Credit Memo |
なし |
なし |
Post Credit Memo |
なし |
taxStatus (追加) taxMessage (追加) |
Unpost Credit Memo |
なし |
なし |
Unpost Credit Memo |
なし |
taxStatus (追加) taxMessage (追加) |
Get Credit Memos |
なし |
なし |
Get Credit Memos |
なし |
taxStatus (creditmemos に追加) taxMessage (creditmemos に追加) |
Create Debit Memo From Charge |
なし |
なし |
Create Debit Memo From Charge |
accountNumber (追加) (条件によっては必須) accountId (条件によっては必須) |
なし |
Create Debit Memo From Charge |
なし |
なし |
Create Debit Memo From Charge |
なし |
taxStatus (追加) taxMessage (追加) |
Get Debit Memo |
なし |
なし |
Get Debit Memo |
なし |
taxStatus (追加) taxMessage (追加) |
Update Debit Memo |
なし |
なし |
Update Debit Memo |
なし |
taxStatus (追加) taxMessage (追加) |
Cancel Debit Memo |
なし |
なし |
Cancel Debit Memo |
なし |
taxStatus (追加) taxMessage (追加) |
Post Debit Memo |
なし |
なし |
Post Debit Memo |
なし |
taxStatus (追加) taxMessage (追加) |
Unpost Debit Memo |
なし |
なし |
Unpost Debit Memo |
なし |
taxStatus (追加) taxMessage (追加) |
Get Debit Memos |
なし |
なし |
Get Debit Memos |
なし |
taxStatus (debitmemos に追加) taxMessage (debitmemos に追加) |
Create Credit Memo From Invoice |
なし |
なし |
Create Credit Memo From Invoice |
items (quantity に追加) |
taxStatus (追加) taxMessage (追加) |
Create Debit Memo From Invoice |
なし |
なし |
Create Debit Memo From Invoice |
items (quantity に追加) |
taxStatus (追加) taxMessage (追加) |
Submit Data Query |
outputFormat (JSON) |
なし |
Submit Data Query |
TSV (outputFormat に追加) DSV (outputFormat に追加) outputFormat (JSONL) columnSeparator (追加) useIndexJoin (追加) readDeleted (追加) |
なし |
Create Subscription |
なし |
なし |
Create Subscription |
gatewayId (追加) paymentMethodId (追加) |
なし |
Cancel Authorization |
accountId accountNumber |
なし |
Cancel Authorization |
paymentGatewayId (追加) (省略可能) accountId (変更) (省略可能) accountNumber (変更) (省略可能) |
なし |
Return Hosted Pages |
pageSize nextPage |
なし |
Return Hosted Pages |
pageSize (削除) nextPage (削除) |
なし |
Preview Order |
なし |
なし |
Preview Order |
description (追加) paymentMethod (newSubscriptionOwnerAccount に追加) chargeModelData (various fields に追加) |
なし |
Preview Order Asynchronously |
なし |
なし |
Preview Order Asynchronously |
description (追加) paymentMethod (newSubscriptionOwnerAccount に追加) chargeModelData (various fields に追加) |
なし |
Create Order |
なし |
なし |
Create Order |
description (追加) paymentMethod (various fields に追加) chargeModelData (various fields に追加) |
なし |
Create Order Asynchronously |
なし |
なし |
Create Order Asynchronously |
description (追加) paymentMethod (various fields に追加) chargeModelData (various fields に追加) |
なし |
Get All Orders |
なし |
なし |
Get All Orders |
description (orders に追加) paymentMethod (newSubscriptionOwnerAccount に追加) chargeModelData (pricing に追加) |
なし |
Get Orders By Subscription Owner |
なし |
なし |
Get Orders By Subscription Owner |
description (orders に追加) paymentMethod (newSubscriptionOwnerAccount に追加) chargeModelData (pricing に追加) |
なし |
Get Orders By Subscription Number |
なし |
なし |
Get Orders By Subscription Number |
description (orders に追加) paymentMethod (newSubscriptionOwnerAccount に追加) chargeModelData (pricing に追加) |
なし |
Get Orders By Invoice Owner |
なし |
なし |
Get Orders By Invoice Owner |
description (orders に追加) paymentMethod (newSubscriptionOwnerAccount に追加) chargeModelData (pricing に追加) |
なし |
Get An Order |
なし |
なし |
Get An Order |
description (order に追加) paymentMethod (newSubscriptionOwnerAccount に追加) chargeModelData (pricing に追加) |
なし |
Get Order Metrics For Evergreen Subscription |
なし |
なし |
Get Order Metrics For Evergreen Subscription |
description (order に追加) paymentMethod (newSubscriptionOwnerAccount に追加) chargeModelData (pricing に追加) |
なし |
Create Account |
なし |
なし |
Create Account |
paymentMethod (追加) |
なし |
Create Payment Method |
なし |
なし |
Create Payment Method |
IBAN (追加) businessIdentificationCode (追加) accountNumber (追加) identityNumber (追加) bankCode (追加) branchCode (追加) SEPA (type に追加) Betalingsservice (type に追加) Autogiro (type に追加) Bacs (type に追加) |
なし |
Query Custom Object Records |
なし |
なし |
Query Custom Object Records |
ids (追加されたクエリパラメーター) |
なし |
Update invoices |
なし |
なし |
Update invoices |
invoiceDate (invoices に追加) |
なし |
Crud: Post or Cancel Build Run |
なし |
なし |
Crud: Post or Cancel Build Run |
invoiceDate (追加) |
なし |
Create Sequence Set |
なし |
なし |
Create Sequence Set |
payment (sequenceSets に追加) refund (sequenceSets に追加) |
payment (sequenceSets に追加) refund (sequenceSets に追加) |
Update Sequence Set |
なし |
なし |
Update Sequence Set |
payment (追加) refund (追加) |
なし |
Get Sequence Set |
なし |
なし |
Get Sequence Set |
なし |
payment (sequenceSets に追加) refund (sequenceSets に追加) |
Get Sequence Set |
なし |
なし |
Get Sequence Set |
なし |
payment (sequenceSets に追加) refund (sequenceSets に追加) |
Update Custom Object Definition |
なし |
なし |
Update Custom Object Definition |
required (追加) Zuora-Version (追加されたヘッダーパラメーター) |
required (追加) |
Get All Custom Object Definitions |
なし |
なし |
Get All Custom Object Definitions |
Zuora-Version (追加されたヘッダーパラメーター) |
filterable (追加) |
Create Custom Object Definition |
なし |
なし |
Create Custom Object Definition |
filterable (追加) Zuora-Version (追加されたヘッダーパラメーター) |
filterable (追加) |
Get Custom Object Definition |
なし |
なし |
Get Custom Object Definition |
Zuora-Version (追加されたヘッダーパラメーター) |
filterable (追加) |
Delete Custom Object Definition |
なし |
なし |
Delete Custom Object Definition |
Zuora-Version (追加されたヘッダーパラメーター) |
なし |
Create Custom Object Records |
なし |
なし |
Create Custom Object Records |
Zuora-Version (追加されたヘッダーパラメーター) |
なし |
Query Custom Object Records |
なし |
なし |
Query Custom Object Records |
Zuora-Version (追加されたヘッダーパラメーター) |
なし |
Get Custom Object Record |
なし |
なし |
Get Custom Object Record |
Zuora-Version (追加されたヘッダーパラメーター) |
なし |
Update Custom Object Record |
なし |
なし |
Update Custom Object Record |
Zuora-Version (追加されたヘッダーパラメーター) |
なし |
Update Individual Fields In A Custom Object Record |
なし |
なし |
Update Individual Fields In A Custom Object Record |
Zuora-Version (追加されたヘッダーパラメーター) |
なし |
Delete Custom Object Record |
なし |
なし |
Delete Custom Object Record |
Zuora-Version (追加されたヘッダーパラメーター) |
なし |
Update Or Delete Custom Object Records As A Batch |
なし |
なし |
Update Or Delete Custom Object Records As A Batch |
Zuora-Version (追加されたヘッダーパラメーター) |
なし |
Update Invoice |
なし |
なし |
Update Invoice |
invoiceDate (追加) |
なし |
Refund Credit Memo |
なし |
なし |
Refund Credit Memo |
gatewayOptions (追加) |
なし |
Refund Payment |
なし |
なし |
Refund Payment |
gatewayOptions (追加) |
なし |
Preview Subscription |
なし |
なし |
Preview Subscription |
chargeModelConfiguration (chargeOverrides に追加) |
なし |
Create Subscription |
なし |
なし |
Create Subscription |
chargeModelConfiguration (chargeOverrides に追加) |
なし |
Update Subscription |
なし |
なし |
Update Subscription |
chargeModelConfiguration (chargeOverrides と chargeUpdateDetails に追加) |
なし |
Get Subscription By Account |
なし |
なし |
Get Subscription By Account |
chargeModelConfiguration (ratePlanCharges に追加) |
なし |
Get Subscriptions By Key |
なし |
なし |
Get Subscriptions By Key |
chargeModelConfiguration (ratePlanCharges に追加) |
なし |
Get Subscriptions By Key And Version |
なし |
なし |
Get Subscriptions By Key And Version |
chargeModelConfiguration (ratePlanCharges に追加) |
なし |
All Actions Operations |
なし |
なし |
All Actions Operations |
rejectUnknownFields (追加されたクエリパラメーター) |
なし |
All Crud Post Operations |
なし |
なし |
All Crud Post Operations |
rejectUnknownFields (追加されたクエリパラメーター) |
なし |
All Crud Put Operations |
なし |
なし |
All Crud Put Operations |
rejectUnknownFields (追加されたクエリパラメーター) |
なし |
アップグレード前提条件
アップグレードを実行する前に、次の作業を行う必要があります。
-
以前のバージョンに復元する必要がある場合に備えて、ファイル、データ、設定のバックアップを作成します。
-
Zuora Connector をインストールして、以前は Zuora Connector 5.x.x に含まれていた Zuora 操作を置き換えます。
アップグレード手順
以下の手順に従って、Zuora Connector 6.0.0 へのアップグレードを実行します。
-
Studio で Mule プロジェクトを作成します。
-
[Mule Palette (Mule パレット)] ビューで、[Search in Exchange (Exchange 内を検索)] をクリックします。
-
[Add Modules to Project (モジュールをプロジェクトに追加)] で、検索項目に「Zuora」と入力します。
-
[Available modules (使用可能なモジュール)] で、[Zuora Connector] を検索して [Add (追加)] をクリックします。
-
[Finish (完了)] をクリックします。
-
pom.xml で zuora-connector 連動関係バージョンが 6.0.0 であることを確認します。
Anypoint Studio はコネクタを自動的にアップグレードします。
アップグレードを確認する
コネクタの最新バージョンをインストールしたら、次の手順に従ってアップグレードを確認します。
-
Anypoint Studio で、[Problems (問題)] ビューまたは [Console (コンソール)] ビューにエラーがないことを確認します。
-
アプリケーションを Anypoint Platform から実行している場合、出力は Anypoint Studio のコンソールウィンドウに表示される。
-
コマンドラインから Mule を使用してアプリケーションを実行している場合、アプリケーションログは OS コンソールに表示される。
アプリケーションのログファイル (
log4j2.xml) でログファイルパスがカスタマイズされていない場合、デフォルトの場所 MULE_HOME/logs/<app-name>.log でアプリケーションログを表示することもできます。
-
-
プロジェクトの
pom.xml をチェックして、問題がないことを確認します。 -
接続をテストして、操作が機能することを確認します。
アップグレードの取り消し
前のバージョンの Zuora Connector に戻す必要がある場合、プロジェクトの pom.xml で zuora-connector 連動関係バージョン 6.0.0 を前のバージョンに変更します。
Anypoint Studio でプロジェクトの pom.xml を更新する必要があります。