Zuoraをデータパイプラインソースとして設定 ​

Zuoraをデータパイプラインソースとして設定し、Zuoraから請求、サブスクリプション、支払い、および収益データを抽出して宛先に同期します。

このガイドを使用してZuoraをデータパイプラインソースとして接続し、パイプラインを設定して、サポートされるオブジェクト、sync modes、および制限事項を理解します。

サポートされている機能 ​

Zuoraをパイプラインソースとして使用する場合、次の機能がサポートされます。

• クラウド接続：Workatoはhttps経由のZuora REST APIを通じてZuoraに接続します。 オンプレミスエージェントは不要です。
• Environmentサポート：Zuoraプロダクション、API sandbox、およびcentral sandbox Environmentに接続します。
• Sync modes：Full syncとincremental sync。 Incremental syncは、各レコードのUpdatedDateタイムスタンプを使用して、新規および更新されたレコードのみを抽出します。
• オブジェクトレベルの選択：カスタムオブジェクトを含め、同期するZuoraオブジェクトを選択します。
• Delete tracking：付随するdelete jobを通じてhard-deletedレコードを任意で検出します。 Delete trackingはデフォルトで無効です。 詳細については、削除追跡を参照してください。
• Schema drift処理：Zuoraに追加された新しいフィールドを自動的に同期するか、新しいフィールドをブロックして宛先スキーマを固定します。
• 設定可能な同期頻度：時間ベースまたはcronベースのスケジュールで同期します。 最小間隔は15分です。

前提条件 ​

Zuoraをデータパイプラインソースとして設定する前に、次の要件を満たしてください。

• APIアクセス権を持つZuoraテナント
• 選択した認証方法の認証情報:
  • OAuth 2.0：Zuoraで作成されたOAuthクライアントのクライアントIDとクライアントシークレット。 設定手順については、ZuoraでOAuthクライアントを作成を参照してください。
  • Basic authentication：Workato用にプロビジョニングされた連携ユーザーのユーザー名とパスワード。 Basic authenticationは、Zuora Production Copy Environmentでのみ使用してください。
• 同期予定のfeature-gatedオブジェクトに対して有効化されたZuora機能（Invoice Settlement、Orders、Prepaid with Drawdownなど）。 各オブジェクトに必要な機能については、サポートされるオブジェクトを参照してください。

ZuoraでOAuthクライアントを作成 ​

Zuoraテナント内のユーザー用にOAuthクライアントを作成し、Workatoに必要なクライアントIDとクライアントシークレットを生成します。 手順については、Zuoraドキュメントのユーザー用のOAuthクライアントを作成を参照してください。 Basic authenticationを使用する予定の場合は、このセクションをスキップします。

サポートされるコネクションタイプ ​

Zuoraデータパイプラインは、次の認証方法をサポートします。

• OAuth 2.0：Zuoraで生成されたクライアントIDとクライアントシークレットで認証します。 Zuoraは、すべてのサーバー間連携にOAuth 2.0を推奨しています。 設定手順については、ZuoraでOAuthクライアントを作成を参照してください。
• Basic authentication：連携ユーザーのユーザー名とパスワードで認証します。 Basic authenticationは、Zuora Production Copy Environmentでのみ使用してください。

Zuoraに接続 ​

次の手順を完了して、Zuoraをデータパイプラインソースとして接続します。

パイプラインの設定 ​

次の手順を完了して、Zuoraをデータパイプラインソースとして設定します。

[minute] [hour] [day of month] [month] [day of week]

0 8 * * *

サポートされるオブジェクト ​

Zuoraデータパイプラインは、Zuora REST APIリソースからデータを同期します。 次の表は、サポートされているオブジェクトをカテゴリ別に示しています。 各オブジェクトは、宛先内の個別のテーブルとして同期されます。

すべてのオブジェクトはfull syncとincremental syncをサポートします。 Incremental syncは、各レコードのUpdatedDateフィールドを使用します。 Delete trackingはオブジェクトごとのオプトインであり、デフォルトでは無効です。 詳細については、削除追跡を参照してください。

コアオブジェクト ​

Feature-gatedオブジェクト ​

次のオブジェクトを使用するには、対応するZuora機能をテナントで有効にする必要があります。

関連オブジェクト ​

カスタムオブジェクト ​

Zuoraデータパイプラインは、テナント内のカスタムオブジェクトを自動的に検出します。 カスタムオブジェクトは、UpdatedDateフィールドを通じてfull syncとincremental syncをサポートします。

同期モード ​

Zuoraデータパイプラインはfull syncとincremental syncをサポートします。

フル同期 ​

Full syncは、Zuoraからオブジェクトのすべてのレコードを抽出します。 初回の履歴同期、または宛先でオブジェクトのテーブルを再構築する場合は、full syncを使用します。

増分同期 ​

Incremental syncは、各レコードのUpdatedDateタイムスタンプに基づいて、前回の同期後に作成または更新されたレコードのみを抽出します。 同期境界で同じタイムスタンプを共有するレコードは、次回の同期で再配信される場合があります。 宛先はレコードIdで重複を排除するため、重複は残りません。

請求書の無効化などのビジネスステータスの変更は、レコードのUpdatedDateを更新し、incremental syncを通じて自動的に反映されます。

削除追跡 ​

Zuoraはレコード削除を3つの方法で処理し、それぞれがデータパイプラインと異なる形で連動します。

• ステータス遷移：請求書の無効化など、Zuoraでのほとんどの運用上の削除は、レコードのステータスフィールドを変更します。 レコードは引き続き存在し、通常のincremental syncを通じて同期されます。 特別な処理は不要です。
• Hard deletes：Zuora DELETE APIを通じて削除されたレコードは、標準の抽出パスから即座に消えます。 オブジェクトでdelete trackingが有効になっている場合、パイプラインは付随するクエリを通じてhard-deletedレコードを検出し、_zuora_deleted列でマークします。 Zuoraはhard-deletedレコードを30日間保持します。 30日より古い削除は検出できません。
• GDPR scrubs：GDPR scrub操作で削除されたレコードは、どのAPIでもクエリできず、検出できません。

Delete trackingはデフォルトで無効です。 データ移行ワークフローなどで、組織がZuora DELETE APIを通じてレコードをhard-deleteする場合にのみ有効にします。

スキーマとデータ型の処理 ​

次のセクションでは、スキーマとデータ型の処理に関する情報を提供します。

合成列 ​

オブジェクトでdelete trackingが有効になっている場合、Workatoは宛先テーブルに次の合成列を追加します。

オブジェクトでdelete trackingが無効になっている場合、_zuora_deleted列はスキーマから省略されます。

機密データの処理 ​

Zuoraオブジェクトには、PIIおよび支払いデータが含まれる場合があります。 次のオブジェクトには、一般的に機密フィールドが含まれます:

パイプライン設定時にフィールドレベルのデータ保護でHashオプションを使用し、機密データが宛先に到達する前に保護します。 詳細については、パイプラインを構成手順を参照してください。

制限事項 ​

Zuoraをデータパイプラインソースとして使用する場合、次の制限事項が適用されます。

Hard-deletedレコード ​

Zuora DELETE APIを通じてhard-deleteされたレコードは、オブジェクトでdelete trackingが有効になっている場合にのみ、30日間だけ検出できます。 同じ同期ウィンドウ内で作成および削除されたレコード、およびGDPR scrub操作で削除されたレコードは検出できません。 詳細については、削除追跡を参照してください。

最小同期頻度 ​

サポートされる最小同期間隔は15分です。 これより高い頻度で同期をトリガーすることはできません。