Introduces Headless Component that can trigger custom component logic upon Quote Studio events.

Headless Component expands the capabilities of the Extensibility Framework Custom Components. With this, you can trigger custom component logic upon Quote Studio events.

From Quotes version 10.21 or later, you can designate components as Headless component without a user interface (UI). These components can be harnessed to execute your extensibility framework custom component logic based on Quote Studio events, specifically save or submit events.

Note that only a single active Headless Component is permissible.

Headless components allow you to utilize global methods (hooks) to create custom logic. The following are the hooks available in the extensibility framework:

beforeSave

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

beforeSubmit

This hook triggers when the Submit, Back, or Save changes and Leave button is clicked in Quote Studio.

beforePreviewCall

This hook triggers the Preview Call in Quote Studio. This is only applicable for Preview on-demand.

beforeProductAdd

Input:

Return:

The return type of this hook is JSON object.

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

afterProductAdd

Input:

Return:

N/A

Signature:

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

beforeProductUpdate

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

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 allows 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 future dated remove rate plan in the rules engine.

Signature:

@api
async beforeRulesExecution(context) {
      // Execute the logic
      return {
          rulesToExecute : [],
          runRules : true,
          forceExecuteRules: true,
          includeRemovedRatePlan: 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 are added to the inactive list.

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

Custom Fields

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

Custom Action Plugin:

Product Rate Plan and Product Rate Plan Charge records can be accessed in a custom action plugin.

Product Rate Plan and Product Rate Plan Charge custom fields can be accessed in a custom action plugin when the custom fields are added to the following fieldsets.

afterRulesExecution

This hook triggers 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

This hook triggers after making any update on the quote field and executes after the Quote update logic.

Signature:

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

beforeMSQChildSave

This hook executes when the user switches from one child quote to another just before the save logic is executed.

Return:

Signature

@api
beforeMSQChildSave() {
  //add logic
  return true;
}

beforeProductRemove

This hook executes when the Confirm button is selected within the Future-Dated Remove window and when the Delete button is clicked for a newly added product. It runs prior to the execution of both the Future-Dated Remove and Delete logic.

Input:

Return:

Signature:

@api
beforeProductRemove(removedQplan, deletedTimeline, timelineId) {
  //add logic
  return true;
}

For a sample code that uses the hooks mentioned in this article, see Sample code for hooks and events.