Version Control
Version | Date | Description | Author |
V0.0 | 27/12/2016 | Draft | <name> |
Reference Documents
Description | Document Link |
Definitions
Abbreviation | Definition |
CRM | Customer Relationship Management |
Introduction
Overview
This is the documentation for the CORE's Pricing campaign module
Purpose of this document
The purpose of this document is to explain the purpose of system components, behavior and it's structure for the Pricing Campaign module.
<Process Name> Technical Documentation
<Process Name> Technical Solution Overview
<Include all actions performed by Users Or System that will trigger System Actions to run (Workflows, triggers, flows, assignment rules, approval processes, email notification, Account Locks, components), if the process is too complex to describe in one diagram only, you can split it by Feature, or Phase, ...
Something Similar to the screenshot below (for the Actions refer the type of solution implemented including the names, example: Action: Update Account is being done by system using Apex, For Apex implementation: include what is being done before Insert/Update after Insert/Update
<include rationale of the technical decision, for example, we are using 2 RT, why we need a first one, and a Second One>
Apex trigger Logic (including handlers)
It is agreed that Pricing Campaign CPC trigger is a 'heavy' object therefore we are not mixing flow triggers, process builders, workflows etc. with apex triggers. All related logic needs to be executed in the Apex trigger.
Context | Method | Description | |
|---|---|---|---|
Before insert | PP_Pricing_Campaign_CPC_Helper.doSetDuplicationRuleUniqueField | Set a duplication rule helper to prevent duplicate CPCs. | |
PP_Pricing_Campaign_CPC_Helper.doSetCommittedPrice | Set committed price & committed price in local currency. | ||
| PP_Pricing_Campaign_CPC_Helper.doSetAccountManagerReview | Set account manager review field. | ||
| PP_Pricing_Campaign_CPC_Helper.doSetShipToRegion | Find and set ship-to region. | ||
| PP_Pricing_Campaign_CPC_Helper.doCheckUtilities | Is the current user doesn't have bypass validation rules flag - validate utility lookups. | ||
| PP_Pricing_Campaign_CPC_Helper.doCheckRegionMarketPricing | Is the current user doesn't have bypass validation rules flag - validate RMPs lookups. | ||
| PP_Pricing_Campaign_CPC_Helper.doCheckIfProductIsAllowedOnQuote | Is the current user doesn't have bypass validation rules flag - validate whether the product is allowed on the quote. | ||
| PP_Pricing_Campaign_CPC_Helper.doPriceUpdate | |||
After insert | PP_Pricing_Campaign_CPC_Helper.doProcessQueue | Start a queueable method to update CPCs in an asynchronous manner to save the platform resources. This can only be used when updating the fields that we don't need to see immediately after update. | |
| doSetContractProduct | Set the contract product on the CPC. | ||
| doSetSoldToRegion | Set the sold to region on the CPC. | ||
| doSetFields | Set the owner, corporate sold-to, region-country-city and product level 2 fields on the CPC. | ||
| doSaveLogs | Save the results of the queueable transaction on error in SLV5_1_App_Log__c so that they can be inspected later. | ||
Before update | PP_Pricing_Campaign_CPC_Helper.doSetDuplicationRuleUniqueField | Set a duplication rule helper to prevent duplicate CPCs. | |
PP_Pricing_Campaign_CPC_Helper.doSetPriceSettingsUpdated | Set a flag that notifies the user that prices have changed. | ||
| PP_Pricing_Campaign_CPC_Helper.doSetCommittedPrice | Set committed price & committed price in local currency. | ||
| PP_Pricing_Campaign_CPC_Helper.doSetAccountManagerReview | Set account manager review field. | ||
| PP_Pricing_Campaign_CPC_Helper.doSetShipToRegion | Find and set ship-to region. | ||
| PP_Pricing_Campaign_CPC_Helper.doCheckUtilities | Is the current user doesn't have bypass validation rules flag - validate utility lookups. | ||
| PP_Pricing_Campaign_CPC_Helper.doCheckRegionMarketPricing | Is the current user doesn't have bypass validation rules flag - validate RMPs lookups. | ||
| PP_Pricing_Campaign_CPC_Helper.doCheckIfProductIsAllowedOnQuote | Is the current user doesn't have bypass validation rules flag - validate whether the product is allowed on the quote. | ||
| PP_Pricing_Campaign_CPC_Helper.doSetFields | Set the owner, corporate sold-to, region-country-city and product level 2 fields on the CPC. |
Lightning Components
<for each of the components describe according to the following points>
- Component Diagram
<when a component is using several components, include the architecture used>
- Component Description
What is the purpose, rationale for customization instead of Standard, explain advanced features implementation,
| LWC Name | Nested | Nested | Description |
|---|---|---|---|
| customLookup | A custom lookup component that is used to let the user select a lookup field based on a given logic. Used in several places in the application. | ||
| customSelect | A custom select component that is used to display to the user a given set of options. | ||
| gen_dictionary | A resource to hold final front-end- variables. | ||
| pp_cpcRecommendedPriceUpdaterBase | |||
| pp_customNotificationListener | |||
| pp_newOneQuoteBase | This is the base component for the CPC to Quote flow. | ||
| pp_newOneQuoteLineItemTable | A table that lets you select the CPCs that you want for a new Quote. | ||
| pp_newQuoteRecordForm | This is the Quote form for the CPC to Quote flow that lets you set the fields. | ||
| pp_newExistingOneQuoteLineItemTable | A table that lets you select the One Quote Line Items from an Existing quote for a new Quote. | ||
| pp_pricingCampaignBase | This is the base component to present campaign's CPCs to the user. This is used on the flexipage for the pricing campaign. | ||
| pp_pricingCampaignReportRedirection | A component to display a link to redirect the user to the appropriate report. | ||
| pp_pricingCampaignFilters | This is a component that allows the user to filter through the CPCs to find the ones they need. Some values come preselected. When one value changes, all the other available values are updated. The CPCs with the applied filters are displayed below in the table. | ||
| pp_pricingCampaignCurrencyBox | This is component to display to the user the currency conversion between different records. It uses some currency that are listed in the metadata that this LWC reads. | ||
| searchPickList | Generic Custom Dropdown with Search LWC. | ||
| pp_pricingCampaignRow | This is a base component that displays all the CPC related fields on a single table 'line'. | ||
| pp_pricingCampaignOutputField | This is a component that displays a field. | ||
| pp_pricingCampaignConversionOutput | A way to display to the user converted currency. | ||
| pp_pricingCampaignPagination | Custom pagination to improve usability of the page | ||
| pp_pollQueueableResult | Poll results of the queueable job to process up to 200 OQLIs. |
Method Name | Reason why? |
<List the methods that are running without sharing and describe reason why>
- Bypasses and Custom Permissions
<by development guidelines, all validation rule needs to have the bypass, so we just say generically that all validation have it, and if for some reason we need to avoid bypass, then we need to list the validation rules without bypass, and explain reason why>
Email Notifications (via Apex) & Email Service