OrderBackfillProcessor Class

Knowledge Center > ZZ Sandbox > Yingying's Drafts > OrderBackfillProcessor Class

OrderBackfillProcessor Class

This functionality is only available if you have the Orders feature enabled.

This article describes the OrderBackfillProcessor class, its methods, and the related classes. The OrderBackfillProcessor and the related classes are designed to backfill the subscription-related information to the Salesforce record. 
When you submit Salesforce Contract to Zuora, the Zuora Connector for Salesforce CPQ will call Zuora asynchronous REST API to create subscriptions in Zuora. Upon completion, only the subscription Ids are returned. You can then use OrderBackfillProcessor class to populate the following subscription-related information:

  • Subscription Id
  • Subscription RatePlan Id
  • Subscription RatePlan Charge Id
  • Subscription Order Number
  • Subscription Order Id
  • Subscription Order Action Id
  • Subscription Order Action Type

The backfill volume is limited by the constraints of the Orders API.

See Set up the SubmitContractOrder Plugin for:

  • New Custom Fields you must add before you can use the backfill processor.
  • Validation on the OrderAction object before the Order Summary is created.
  • Backfill Field Mapping between Zuora Order Response fields and SB-Subscription or Contract fields.
  • Limits of the Order Backfill Process Service.

OrderBackfillProcessor Methods

The OrderBackfillProcessor class includes the following methods.

Method Type Description
backfill(Set<Id> contractIds) Result Processes the backfill operation for a set of Salesforce Contract records.
backfillSubscriptions(Set<Id> subscriptionIds) Result Processes the backfill operation for a set of Salesforce SBQQ__Subscription__c records.
backfillOrderResult(Id contractId, Set<Id> subscriptionIds, String orderResponse) void Populates the corresponding fields in the Salesforce Contract and SBQQ__Subscription__c records with the values of the fields in the Order Response.

OrderBackfillProcessor.Result Class

The OrderBackfillProcessor.Result class contains the following properties.

Property Type Description
success Boolean Indicates the success status of the operation.
message String Contains Error, Warning or Information message (if any) for the overall backfill operation.
records List<ResultItem> Contains a List of ResultItem references.  Each ResultItem contains the backfill result for one Subscription in a Contract. See the OrderBackfillProcessor.ResultItem Class below for more information.

OrderBackfillProcessor.ResultItem Class

The OrderBackfillProcessor.ResultItem class contains the following properties.

Property Type Description
success Boolean Indicates the success status of the operation.
message String Contains Error, Warning or Information message (if any) for the backfill operation of the individual Subscription line item.
subscriptionId Id The Salesforce ID of the backfilled Subscription.
contractId Id The Salesforce ID of the containing Contract.
Last modified

Tags

This page has no custom tags.

Classifications

(not set)