Rebates in CPQ - Predicted Earnings - Implementation Guidelines
Overview
The intent is to provide an estimation of the rebate value, called predicted earnings, on line items in Smart CPQ Quotes. This rebate information is retrieved from Enable Trading Programs through a dedicated integration. It requires some specific implementation guidelines to be followed in CPQ. Additional implementation is expected on Enable Trading Programs, which is not addressed in the current documentation.
Behavior
Predicted earnings will provide in CPQ an estimation of the current Rebate expected for a Line Item. The data should be refreshed anytime an input value for the rebate computation is changed or the line item is created. Associated to that value will be provided a confidence rating that may be displayed to let the user know how reliable the rebate information is.
Restrictions :
- It does not consider other line items when providing the predicted rebate value. Additional quantities of similar product/dimensions line items are not considered even if it could change the expected rebate.
- Enable Trading Programs currently does not support multi currencies and multi UoM. Therefore, any line item in a Currency/UoM different than the one used in the Rebate Program will predict earnings with a low level of confidence rating.
Authentication keys
Authentication keys should be provided for each tenant by Enable to PROS and stored in PROS environments by the cloud administration team.
CLOUD DEPLOYMENT
These are three API related settings that need to be setup as part of custom plugin deployment for cloud team (specified in CSC ticket):
- ENABLE_EARNINGS_URL - the end point of Enable Predicted Earnings api call, provided by Enable.
- For example : https://partner-api-uat.enable.com/predicted-earnings/predicted-earnings
- ENABLE_EARNINGS_CLIENT_KEY - the client key of Enable api call, provided by Enable
- Example : 297ba145d6f5071b253762c2f2a9735945d0ee08e0be6d7412457d9518b60279b89ca9b27b95159
7e8bd45c0e02bbad6b28e4670767385175712db64511aabcec
- ENABLE_EARNINGS_SUBSCRIPTION_KEY - the subscription key of Enable api call, provided by Enable
- Example : df4e4fdda1144df8763c94e9dfffabcb
- Example : 297ba145d6f5071b253762c2f2a9735945d0ee08e0be6d7412457d9518b60279b89ca9b27b95159
Quote implementation
The implementation only focuses on the Performance Quoting module. Therefore all implementation tasks described below are to be done in the Quote Designer.
FIELDS
Following fields are needed:
- Customer ID
- Contains the ID of the customer as known by Enable
- Mandatory
COLUMNS
Following columns are needed to send data to Enable. Related cells should be added to line templates that will receive predicted earnings information.
- Product ID
- Contains the SKU of the Product as known by Enable
- Data type : String / Business
- Mandatory
- Quantity
- Contains the Quantity of the line item
- Data type : Big Decimal
- Mandatory
- Net Price
- Contains the Net Price of the line item
- Data type: Monetary
- Mandatory
- Currency
- Contains the Currency code of the line item as known by Enable
- Data type : Currency / String
- Mandatory
- Unit of Measure
- Contains the UoM code of the line item as known by Enable
- Data type : Unit Of Measure / String
- Mandatory
Additional optional columns can be sent to Enable to filter down to fewer eligible programs and program lines.
The following columns are needed to retrieve data from Enable. Related cells should be added to line templates that will receive predicted earnings information.
- Predicted Earnings
- Data type - Monetary
- Should not be computed
The following columns are optional to retrieve data from Enable. Related cells should be added to line templates that will receive predicted earnings information.
- Confidence Rating
- Data type BigDecimal
- Should not be computed
- Possible values
- 0.1
- low level of confidence
- 0.5
- medium level of confidence
- 1.0
- high level of confidence
- Reason for rating
- Data type String
- Should not be computed
- Only provided when rating = 0.1
EXTERNAL DATASOURCE
An External Datasource must be defined as such:
- General settings
- Service Name
- PredictedEarningsService
- Inherited context
- Empty
- Service Name
- Get Field Mapping
- Add a map with the desired policy (each input is recommended)
- Add input mapping
- Field - select the field used to store the Customer ID
- Name - "customerAccount"
- Mandatory - Y
- Get Column Mapping
- Add a map with the desired policy (each input is recommended)
- Add input mapping
- Column - select the column used to store the Product ID
- Name - "sku"
- Mandatory - Y
- Add input mapping
- Column - select the column used to store the Quantity
- Name - "units"
- Mandatory - Y
- Add input mapping
- Column - select the column used to store the Net Price
- Name - "amount"
- Mandatory - Y
- Add input mapping
- Column - select the column used to store the Unit Of Measure
- Name - "unitOfMeasure"
- Mandatory - Y
- Add input mapping
- Column - select the column used to store the Currency
- Name - "currency"
- Mandatory - Y
- Optional in case of additional filter - Add input mapping
- Column - select the column used to filter
- Name - project dependent, please refer to the project design
- Mandatory - N
- Add output mapping
- Column - select the column used to store the Predicted Earnings
- Name - "predictedEarnings"
- Optional - Add output mapping
- Column - select the column used to store the Confidence Rating
- Name - "rating"
- Optional - Add output mapping
- Column - select the column used to store the Reason for Rating
- Name - "reasonForRating"
ACTIONS
Optional: A refresh action, referring to the External Datasource, can be declared in order to manually refresh predicted earnings for the quote.
Additional implementation recommendations
Following implementation steps are not mandatory but recommended to capture the value of the rebate information:
- Add a new "Net Price with Rebate" column that shows the Net Price after the rebate value has been deleted.
- Add a New Net Margin column based on this Net Price with Rebate.
- Aggregate the Rebate values at the quote level, and show the margin at this level.
- Show the impact of the rebate at the line item and quote levels by implementing a waterfall chart.
