SelectProduct Component

Filter Plugin

The SelectProduct component provides a filter plugin interface that you can use to create additional filtering criteria for both product and rate plan selections.  

The filter plugin interface is defined as global SelectProductComponentOptions.IFilterPlugin and contains the following interface methods: 

• String getProductSoqlFragment: Returns additional filtering conditions in SOQL fragment for the product selection.  
• Stirng getRatePlanSoqlFragment: Returns additional filtering conditions in SOQL fragment for the rate plan selection.

See below for a sample code for the Filter Plugin.

Guided Selling Flow Plugin

The SelectProduct component provides a Guided Selling Flow plugin interface that you can use to create custom Guided Selling Flow button bars in Guided Product Selectors.

The plugin interface is defined as:

global SelectProductComponentOptions.IGuidedSellingFlowPlugin

The plugin contains the following interface method:

• LIST getFlows (Id): Returns a list of Guided Selling Flows to be displayed in the Guided Product Selectors.

See Guided Selling Flow Plugin Example for a sample use case.

Add / Remove Rate Plan Plugin

The SelectProduct component provides a filter plugin interface that you can use to create a custom plugin to control addition and removal of rate plans in the Product Selector.

The plugin interface is defined as global SelectProductComponentOptions.IAddRemoveRatePlanPlugin and contains the following interface methods: 

• void onAdd (String, List): Customizes the additional actions to take place based on the product rate plan added to the quote. For example, you can specify to add a related rate plan when a certain rate plan is added to a quote.
• void onRemove (String, List): Customize the additional actions to take place based the product rate plan removed from the quote. For example, you can prevent certain rate plan from being removed from a quote.

See Add/Remove Rate Plan Plugin Example for a sample use case.

Save Rate Plan Plugin

You can use the Save Rate Plan Plugin interface to:

• Detect changes (add, remove, update) to charge groups on a quote when saving those charge groups in the Product Selector.
• Perform validations on those charge groups.

The plugin interface is defined as global SelectProductComponentOptions.ISaveRatePlanPlugin and contains the following interface method and parameters:

void onSave(
   List<zChargeGroup> addedChargeGroups, 
   List<zChargeGroup> updatedChargeGroups,
   List<zChargeGroup> removedChargeGroups,
   List<zChargeGroup> persistedChargeGroups);

where :

• onSave: Checks the current state of all charge groups on save.  Includes the following parameters:
  • addedChargeGroups: All added charge groups during the current save.
  • updatedChargeGroups: All updated charge groups during the current save.
  • removedChargeGroups: All removed charge groups during the current save .
  • persistedChargeGroups: All previously saved but unedited charge groups.

Zuora does not recommend modifying the charge group or charge group list in the Save Rate Plan Plugin.

See Save Rate Plan Plugin Example for a sample use case.

Quote Rules Engine Plugin

The SelectProduct component provides the Quote Rules Engine plugin interface. The default plugin registers and enables the Product and Price Rules engine. You can create a custom rules plugin and replace the default rules engine plugin if you do not require the full configuration capability of our Product and Price Rules. For example if you only need a simple rules engine for automatic price/rules calculations happen, create your custom plugin class, and register your plugin as described in Component Registration.

The plugin interface contains the following interface methods:

• void runPriceRules
​  (List<zqu.ZChargeGroup> zcgs,
   List<zqu.ZQuoteRulesEngine.ChangeLog> logs)
• Map> runProductRules
​  (zqu__Quote__c quote,
   List<String> ratePlanIds,
   List<zqu.ZQuoteRulesEngine.ChangeLog> logs)
• Boolean runValidationRules
​  (zqu__Quote__c quote,
   List<ZChargeGroup> zcgs,
   List<ChangeLog> logs)

See Quote Rules Engine Plugin Example for a sample rules engine plugin code.

Rate Plan Customization Plugin

Use the Rate Plan Customization Plugin on the SelectProduct component to manipulate the charge groups before adding them to the quote, e.g., setting default values of some fields, adding or removing features.

The plugin interface is:

SelectProductComponentOptions.IRatePlanCustomizationPlugin

The plugin contains the following global method:

• void updateZChargeGroups(Quote__c quote, List<ZChargeGroup> zcgs)

This plugin executes on the add, removal, and saving of a product.

See Rate Plan Customization Plugin Example for a sample plugin code.

Visualforce Page Example

Add the SlectProduct component to  your Salesforce page inside an <apex:form> tag to set up the component options in your controller. Use the zqu__QuoteWizardTemplateNoForm template to ensure that your Visualforce page will have the Quote Wizard context.

<apex:page sidebar="false" tabStyle="zqu__Quote__c" standardController="zqu__Quote__c" extensions="CustomProductSelectorController">
  <apex:composition template="zqu__QuoteWizardTemplateNoForm" >
    <apex:define name="PageBody" >
      <apex:form >
        <zqu:SelectProduct options="{!theOptions}"/>
      </apex:form>
    </apex:define>
  </apex:composition>   
</apex:page>

Apex Controller Example

public with sharing class CustomProductSelectorController {
  public zqu.SelectProductComponentOptions theOptions { get; set; }
  public CustomProductSelectorController(){
    theOptions = new zqu.SelectProductComponentOptions();
    theOptions.title = 'Sample Code';
    theOptions.subTitle = 'Choose Product and Charges';
    theOptions.mode = zqu.SelectProductComponentOptions.MODE_EDIT;
    // Read-only mode, used to display all the selected product rate plan charges
    //theOptions.mode = zqu.SelectProductComponentOptions.MODE_DETAIL;
    theOptions.quoteType = 'Subscription';
    theOptions.quoteId = 'a0AE0000005aFovMAE';

    // Set the page url for buttons if necessary
    theOptions.previousUrl = '';
    theOptions.saveUrl = '';
    theOptions.cancelUrl = '';
    theOptions.filterPlugin = new CustomProductFilter();
  }
}

Filter Plugin Example

global class CustomProductFilter implements zqu.SelectProductComponentOptions.IFilterPlugin {
  String quoteId;

  public CustomProductFilter() {
    quoteId = ApexPages.currentPage().getParameters().get('id');
  }

  public String getProductSoqlFragment() {
    return '';
  }

  /*** Returns the Rateplan Filter SOQL Fragment that filters by billing frequency */
  public String getRateplanSoqlFragment() {
    String soqlFragment = '';
    zqu__Quote__c[] quotes = [select id, BillingFrequency__c from zqu__quote__c 
      where id = : quoteId];

    if (quotes != null && quotes.size() > 0) {
      String billingFrequency = quotes[0].BillingFrequency__c;
      if (!String.isBlank(billingFrequency)) {
        soqlFragment = ' BillingFrequency__c = \'' + billingFrequency + '\'';
      }
    }
    return soqlFragment; 
  }
}