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

Chargebeeをデータパイプラインソースとして設定し、サブスクリプション、請求、請求書、および支払いレコードを宛先に抽出します。

このガイドを使用して、コネクションの設定、パイプラインの設定、オブジェクトの追加、同期動作の確認、および既知の制限事項の理解を行います。

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

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

• クラウド接続: サイトのサブドメイン（https://{subdomain}.chargebee.com）を通じてHTTPS経由でChargebeeに接続します。オンプレミスエージェントは不要です。
• 本番サイトおよびテストサイトのサポート: 対応するサブドメインを指定して、本番Chargebeeサイトまたは専用テストサイトのいずれかに接続します。 Workatoは各サイトを個別のコネクションとして扱います。
• フル同期および増分同期: 増分サポートを公開しているオブジェクトに対して、フル同期モードと増分同期モードをサポートします。カーソルフィールドはオブジェクトによって異なります。詳細については、同期モードを参照してください。
• オブジェクトレベルの選択: 宛先内の個別のテーブルとして同期するChargebeeオブジェクトを選択します。完全なリストについては、サポートされているオブジェクトを参照してください。
• 削除追跡: サポートされているオブジェクトの削除を検出し、削除されたレコードを宛先でマークします。オブジェクトのリストについては、削除追跡を参照してください。
• カスタムフィールド検出: サポートされているオブジェクトについて、Chargebeeのカスタムフィールド（cf_*）を自動的に同期します。詳細については、カスタムフィールドを参照してください。
• スキーマドリフトの検出と処理: 新しいフィールドを自動同期でスキーマの変更を自動的に検出して適用するか、新しいフィールドをブロックでスキーマを固定します。
• フィールドレベルのデータ保護：データがデスティネーションに到達する前に、機密フィールドをハッシュ化するか、そのままレプリケートします。
• 構成可能な同期頻度: 時間ベースの間隔またはcron式を使用して同期をスケジュールします。サポートされる最小間隔は15分です。

前提条件 ​

Chargebeeをデータパイプラインソースとして接続するには、次が必要です。

• 本番または専用テストサイトのChargebeeアカウント。
• Chargebeeサイトから生成されたRead-only: All APIキー。設定手順については、ChargebeeのAPI Keysドキュメントを参照してください。
• Chargebeeサイトのサブドメイン
• Chargebeeサイトで使用されているProduct Catalogバージョン（PC 1.0またはPC 2.0）

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

Chargebeeデータパイプラインは、1つの認証方法をサポートしています。

• APIキー: Chargebeeサイトから生成されたRead-only: All APIキーを、サイトのサブドメインおよびProduct Catalogバージョンとともに指定します。 ChargebeeはAPIアクセスでOAuth 2.0をサポートしていません。設定要件については、前提条件を参照してください。

Chargebeeに接続する ​

Chargebeeをデータパイプラインソースとして接続するには、次の手順を実行します。

パイプラインの設定 ​

Chargebeeをデータパイプラインソースとして設定するには、次の手順を実行します。

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

0 8 * * *

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

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

コネクションのProduct Catalogバージョンによって、パイプラインに追加できるカタログオブジェクトが決まります。 SubscriptionとCouponには両方のカタログバージョンのフィールドが含まれますが、データが含まれるのはサイトのバージョンに対応するフィールドのみです。

コアアカウントおよび請求オブジェクト ​

Subscription、Invoice、およびCreditNoteは、削除追跡に使用されるネイティブのdeletedフラグに加えて、主要なビジネスライフサイクル用のstatus値を公開します。 Chargebeeは、SubscriptionのcancelledやInvoiceのvoidedなどのステータスを通じて、これらのレコードを移行します。 statusはコネクターの論理削除シグナルではなく、ビジネスライフサイクルシグナルとして扱います。

割引 ​

Product catalog: PC 1.0 ​

コネクションのProduct CatalogバージョンがPC 1.0の場合にのみ利用できます。

Product catalog: PC 2.0 ​

コネクションのProduct CatalogバージョンがPC 2.0の場合にのみ利用できます。

注文、見積もり、およびその他の請求オブジェクト ​

QuoteとQuotedSubscriptionには、Chargebee PerformanceまたはEnterpriseプランが必要です。詳細については、制限事項を参照してください。

利用状況およびイベント ​

同期モード ​

Chargebeeデータパイプラインは、フル同期と増分同期をサポートしています。同期モードは、パイプラインに追加するときにオブジェクトごとに設定されます。

フル同期 ​

フル同期では、選択したオブジェクトについてChargebeeから利用可能なすべてのレコードを読み取り、宛先テーブルを上書きします。フル同期のみのオブジェクトには、CouponCode、Gift、DifferentialPrice、UnbilledCharge、およびUsageが含まれます。使用可能なカーソルがないためフル同期のみのものもあれば、増分アップサートに安全な主キーがないものもあります。 SubscriptionItem、InvoiceLineItem、PriceTier、QuotedSubscriptionなど、親と同期する子オブジェクトもフル同期のみをサポートします。

増分同期 ​

増分同期では、オブジェクト固有のカーソルを使用して、前回正常に実行されて以降に作成または更新されたレコードのみを抽出します。増分同期をサポートするほとんどのオブジェクトはupdated_atを使用し、Eventはoccurred_atを使用し、CommentとPromotionalCreditはcreated_atを使用します。 Usageはフル同期のみで、その追記専用エンドポイントはupdated_atでフィルタリングし、usage_dateで並べ替えます。追記専用抽出では新しい行が挿入され、既存の行に対する競合解決は実行されません。

SubscriptionItemやInvoiceLineItemなど、親レコードとともに同期されるオブジェクトには独立したカーソルがありません。 Workatoは、親オブジェクトの行が抽出されるたびにこれらの行を抽出します。

各オブジェクトで利用可能な同期モードを確認するには、サポートされているオブジェクトの表を参照してください。

削除追跡 ​

WorkatoはChargebeeのdeletedフラグを読み取り、Customer、Subscription、Invoice、CreditNote、Transaction、PaymentSource、Coupon、Order、UnbilledCharge、およびQuoteについて、宛先行の_workato_is_deleted列をtrueに設定します。 Subscription、Invoice、およびCreditNoteもstatusを公開しますが、コネクターはこれをネイティブの削除追跡の代替ではなく、ビジネスライフサイクルフィールドとして扱います。 PlanとAddonについて、Workatoはstatus == "deleted"から_workato_is_deletedを導出します。

CouponCode、Gift、およびDifferentialPriceは、抽出中にコネクターが監視できる削除シグナルを提供しません。これらのオブジェクトはフル同期のみをサポートするため、Workatoは各フル同期を前回の実行と比較し、Chargebeeに表示されなくなったレコードを宛先で削除済みとしてマークします。 DifferentialPriceには生のdeletedフィールドがありますが、そのリスト抽出ではネイティブの削除追跡のために削除済み行が公開されません。

削除追跡をサポートするオブジェクトを確認するには、サポートされているオブジェクトの表を参照してください。

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

Chargebeeからデータを同期する場合、スキーマとデータ型には次の考慮事項が適用されます。

金額 ​

Chargebeeは、金額を関連する通貨の最小通貨単位の整数として保存します。たとえば、USDの場合はセントです。 Workatoはこれらの生の整数値を保持し、通貨換算は実行しません。 Chargebeeが_in_decimalサフィックス付きの10進形式の金額フィールドを提供する場合、Workatoはそれを文字列として保持します。

タイムスタンプ ​

ChargebeeはタイムスタンプをUnixエポック整数として返します。 Workatoは宛先で生のエポック値を保持し、タイムスタンプ形式には変換しません。

カスタムフィールド ​

Chargebeeはユーザー定義のカスタムフィールドをサポートしており、これらはcf_industryなど、cf_プレフィックス付きでオブジェクトに表示されます。 Workatoは、Customer、Subscription、Invoice、CreditNote、Plan、Addon、Item、およびItemPriceのカスタムフィールドを自動的に検出して同期します。他のオブジェクトのカスタムフィールドは同期されません。

カスタムフィールドはアカウントによって異なり、時間の経過とともに変化します。新しいカスタムフィールドが自動的に同期されるように、パイプラインを設定するときにAuto-sync new fieldsを選択します。

ネストされたオブジェクトと配列 ​

Chargebeeオブジェクトには、Customerのbilling_addressやInvoiceのline_itemsなど、ネストされたオブジェクトや配列を含めることができます。 Workatoは、ネストされた配列が独自のサポート対象オブジェクトに対応する場合を除き、これらを宛先のJSON文字列列として保存します。たとえば、Invoice.line_itemsは代わりにInvoiceLineItemオブジェクトとして同期されます。 Workatoはネストされたフィールドを個別の列にフラット化しません。非常に大きな請求書の場合、Chargebeeはline_items_next_offset値を返すことがあります。コネクターはインラインのline_items配列を抽出しますが、そのオーバーフローオフセットは追跡しないため、インライン配列を超える追加の明細項目は同期されません。

合成列 ​

Workatoは、削除トラッキングがあるオブジェクトの同期先テーブルに、次の合成列を追加します。

機密データの処理 ​

Chargebeeオブジェクトには、個人を特定できる情報（PII）や財務データが含まれる場合があります。次のオブジェクトには、一般的に機密フィールドが含まれます:

ChargebeeはAPIを通じて完全なカード番号やCVV値を返さないため、WorkatoはPaymentSourceの生の支払いカードデータを同期することはありません。

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

制限事項 ​

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

QuoteおよびQuotedSubscriptionには有料のChargebeeプランが必要 ​

QuoteとQuotedSubscriptionは、Chargebee PerformanceまたはEnterpriseプランでのみ利用できます。アカウントでこの機能が有効になっていない場合、これら2つのオブジェクトはAdd new objectsパネルに表示されません。

ビジネスエンティティは個別のオブジェクトとして同期されません ​

Chargebeeが対応するリストエンドポイントを公開していないため、WorkatoはChargebeeサイトのビジネスエンティティを一覧表示する専用オブジェクトを同期しません。サイトでBusiness Entities機能を使用している場合、エンティティに属するオブジェクトには引き続きbusiness_entity_idフィールドが含まれます。Workatoはそれをそのまま保持するため、エンティティ別にレコードをセグメント化できます。

Chargebeeサイトごとに1つのコネクション ​

Chargebee APIキーは単一のサイトにスコープ設定されるため、本番サイトとその専用テストサイトを含め、同期元のChargebeeサイトごとに個別のコネクションを作成します。

Transactionレコードは毎日再インポートされます ​

Chargebeeは、WorkatoがTransactionレコードを最初に抽出した後に、その決済ステータスを更新する場合があります。これらの遅延更新をキャプチャするために、Workatoは増分同期に加えて、24時間ごとにTransactionテーブル全体を再インポートします。

最小同期頻度 ​

サポートされる最小同期間隔は15分です。