Headless component

beforeSave

This hook will trigger when the Save button is clicked in Quote Studio.

beforeSubmit

This hook will trigger when the Submit button is clicked in Quote Studio.

beforePreviewCall

This hook will trigger the Preview Call in Quote Studio. (Only applicable for Preview on-demand).

beforeProductAdd

This hook will trigger when the product add button is clicked, executing before the product addition logic runs (before the product is added to the UI).

Input

Return

The return type of this hook is JSON object.

@api
beforeProductAdd(newRatePlanMap, effectiveDate) {
   //add logic
   return { proceed: true, newRatePlanMap, effectiveDate }
}

afterProductAdd

This hook will trigger when the add product button is clicked, executing after the product addition logic runs (after the product is added to the UI).

Input

Return

N/A

Signature

@api
afterProductAdd(newProductTimeline) {
   //add logic
}

beforeProductUpdate

This hook will trigger after making any update on the product (charge, amendment, rate plan, future dated update, revert on future dated update, or revert on future dated -  remove), executing before the product update logic.

Input

Return

The return type of this hook is JSON object.

Return Signatures

• For a charge update, Return { updatedCharges, proceed: true | false } 
• For an amendment update, Return { updatedAmendment, proceed: true | false } 
• For a rate plan update, Return { updatedRatePlan, proceed: true | false} 
• For a future dated update, Return { updatedCharges, updatedRatePlan, updatedAmendment, updatedRatePlan, proceed: true | false } 
• For a future dated update - revert, Return { proceed: true }
• For a future dated remove - revert, Return { proceed: true }

Signature

@api
beforeProductUpdate(updatedCharges, updatedAmendment, updatedRatePlan, isRevert) {
//add logic
return { updatedCharges: [], proceed: true}
}

afterProductUpdate

This hook will trigger after making any update on the product (charge, amendment, rate plan, future dated - updates, future dated update - revert, or future dated remove - revert), executing after the product update logic.

Input

Return

N/A

Signature

@api
afterProductUpdate(updatedCharge, updatedRatePlan) {
 //add logic
}

beforeRulesExecution

This hook helps to run the custom logic before running the rules. This will allow the following functionalities:

• Filter the rules
• Skip/run rules execution

The input and return types of this hook are both JSON objects.

In Quotes version 10.37, the following parameters are added to the return type of the hook.

• forceExecuteRules parameter - You can use this parameter to run the rules regardless of the triggering conditions, Active field status, or other conditions.
• includeRemovedRatePlan parameter - You can use this parameter to include the remove rate plan in the rules engine.

Signature

@api
async beforeRulesExecution(context) {
      // Execute the logic
      return {
          rulesToExecute : [],
          runRules : true,
      }
}

Input 

Return

@api pageState contains the rules data if the fields are added to fieldset CPQX Rule Fields on the ZRule__c object.
 
Rules are listed as active and inactive based on the zqu__Active__c field. If this field is not added to the fieldset by default, all the rules will be added to the inactive list.

pageState : {
      rules : {
          active: [],
          inactive: []
      }
  }

Custom Fields

ProductRatePlan fields added to the below fieldset would be available in @api quoteState in the extensibility framework.

Custom Action Plugin

ProductRatePlan and ProductRatePlanCharge records can be accessed in a custom action plugin.

ProductRatePlan and ProductRatePlanCharge custom fields can be accessed in a custom action plugin when the custom fields are added to the following fieldsets.

afterRulesExecution

This hook will trigger after the rules are executed.

Input

Return

N/A

Signature

@api
afterRulesExecution(rulesResponse) {
//add logic
}

beforeSubmitNavigation

This hook triggers when the submit button is clicked, executing immediately after the submit logic and before redirecting to the next page from Quote Studio.

Return

Signature

@api
beforeSubmitNavigation() {
   //add logic
   return { proceed: true };
}

afterQuoteUpdate(oldQuote, newQuote) {
   // add Logic
}