Pricing Matrix Templates

The Pricing Matrix Templates page lists available Attribute-based Charge Templates and Rate Card Templates.

Each Attribute-based Charge Pricing Matrix Template can be used to define one or more Charges.

Pricing administrators can perform the following tasks from this page:

The Pricing Matrix Template page for an Attribute-based Charge type Template shows the basic details. It also lists the Input Columns and Output Columns that define the custom dynamic matrix. Pricing administrators can perform the following tasks from this page:

Pricing Matrix Template – Price Model / Price Agreement Relationship

The following image shows the relationship between Pricing Matrix Template fields and Dynamic Matrix Pricing for a Price Model or Price Agreement.

1. After a Pricing Matrix Template has been defined, it can be added as a Dynamic Pricing type for relevant Price Models or Price Agreements.

2. Input Columns in the Pricing Matrix Template define fields to specify the criteria for desired conditional pricing for single or multiple products in a Price Model or Price Agreement.

3. Output Columns in the Pricing Matrix Template define the pricing fields that will be returned as output from the Pricing Engine and written to quote lines. Pricing values are defined for each row item in the pricing matrix grid. The output value is limited to a single (list) unit price in Oracle CPQ 24C. However, when Block Pricing is desired, the Block Size and Block Price attributes can be added as Output Columns in the Pricing Matrix Template.

When the Dynamic Matrix Pricing column is enabled on the Price Model and Price Agreement list pages, associated Pricing Matrix Templates are displayed for applicable Price Models or Price Agreements.

Pricing Matrix Template - Product Charge Relationship

The following image shows the relationship between Pricing Matrix Template fields and Dynamic Attribute-based Matrix Pricing for a product price or charge.

1. After a Pricing Matrix Template has been defined, it can be selected as a Dynamic Pricing type when creating a product price or charge.

2. Input Columns in the Pricing Matrix Template define fields to specify the criteria for desired conditional pricing in the product price or charge.

3. Output Columns in the Pricing Matrix Template define the pricing fields that are available. Pricing values are defined for each condition in the product price or charge. When Block Pricing is desired, the Block Size and Block Price attributes are added as Output Columns in the Pricing Matrix Template.

To add dynamic matrix pricing to a Price Model Item product price or charge, the pricing administrator begins by selecting a customer pre-defined Pricing Matrix Template from the Dynamic Pricing drop-down.

After selecting the appropriate Pricing Matrix Template, the pricing administrator clicks the + icon to add a conditional row item to specify conditions and pricing.

• The conditional column items are determined by the selected Pricing Matrix Template Input Column definitions. In the example below, the selected definitions are Sales Channel, Market, and Industry.

• The column menu items are defined by the Lookup item selected for the given column in the Pricing Matrix Template. For example, the Sales Channel column from the Supremo Dynamic Adjustment template is linked to a Pricing Lookup that provides the 'Direct' and 'Distributor' values.

• The item pricing is determined by the selected Pricing Matrix Template Input Column definitions and the parent Price Model's list type and adjustment type (for discount and markup lists).

  For example, Item Markup % is defined by the parent Markup List type Price Model with a Percent adjustment type. If a customer implementation uses block pricing, Block Size and Block Price attributes can also be added.

Scripting Price Model Pricing Matrix Template - Advanced Price Model Relationship

The following image shows the relationship between Scripting Price Model - Pricing Matrix Template fields and an Advanced Price Model.

1. After a Scripting Price Model Matrix Template has been defined, it can be selected as a Template for Advanced Price Models.

2. "Input" Columns in the Scripting Price Model Matrix Template define fields to specify the criteria for dynamically calculated interim output charge values.
   The "Input" columns use Pricing Attributes with the In/Out parameter set to Input. See Pricing and Charge Attributes for more information.

3. "Output" Columns in the Scripting Price Model Matrix Template define attribute values that will be written as outputs from pricing.
   The "Output" columns use Pricing Attributes with the In/Out parameter set to Output. See Pricing and Charge Attributes for more information.

Add a Scripting Price Model Pricing Matrix Template

The Scripting Price Model type Pricing Matrix Template is used in combination with the new Advanced Price Models. Advanced Price Models require an associated Scripting Price Model type of Pricing Matrix Template to define the standard and custom attributes that will be accessed in the BML scripts.

Add Scripting Price Model Pricing Matrix Template to an Advance Price Model

To add dynamic matrix pricing to an Advanced Price Model, the pricing administrator creates an Advanced Price Model and then selects a customer pre-defined Scripting Price Model Pricing Matrix Template from the Template drop-down.

After selecting the appropriate Scripting Price Model type Pricing Matrix Template, the pricing administrator clicks the + icon to add a conditional row item to specify conditions and pricing.

In this example, an Advanced Price Model and a Scripting Price Model type Pricing Matrix Template is used to set discount corridors (or discount guideline) for Supremo product lines by setting the minimum and maximum discount amounts as shown below.

Refer to Example Advanced Price Model & Scripting Matrix Template for more information.

Export, Import, and status UIs allow customers to maintain Price Model and Price Agreement matrix pricing data outside of CPQ using Excel (.CSV) files. For more information, refer to Export and Import Matrix Pricing Data.

Customers can also migrate Price Models with dynamic matrix pricing. Associated Pricing Matrix Templates are provided as dependencies for the applicable Price Model.

Complete the following steps to create an Attribute-based Charge type Pricing Matrix Template in the CPQ Pricing Portal.

1. Navigate to the Admin page.

2. Click Pricing Portal in the Products section.

3. Click on the Pricing Matrix Template card.

4. Select Add from the Actions drop-down.

5. Enter the Name.

6. Enter the Variable Name.

7. Select Attribute-based Charge from the Template Type drop-down.

8. (optional) Enter a Description.

9. Click Create.

10. If required, complete the following to add a Charge Definition Constraint.

    1. Click the Basic Details Edit button.

    2. Click on More Details.

    3. Click inside the Charge Definition Constraint field, and the select the applicable Charge Definitions.

    4. Click the Basic Details Update button.

11. Complete the following to add Pricing Matrix Template Input Columns.

    1. Select Add from the Input Columns - Actions drop-down.

    2. Enter a Name for the input column.

    3. Enter the Variable Name for the input column.

    4. Select the Data Type.

    5. Select a Pricing Lookup from the Lookup drop-down.

       Note: This field is only available for string data types. Refer to Pricing Lookups for more information.

    6. Select the Operator function to use for the specified Pricing Attribute.

    7. Select the applicable Pricing Attribute.

       Note: You can enter text in the Pricing Attribute field to filter the Pricing Attributes list.

    8. (optional) Select or enter a Default Value.

    9. Check Default Value Overridable if the default value can be modified by an administrator or pricing manager during creation or modification of a Rate Card.

       • This option is only editable when a Default Value is specified.

       • The default value cannot be specified for currency data types.

       • Only True or False values can be selected for Boolean data types.

       • When a Lookup is selected, you can select a default value from values defined in Pricing Lookups.

    10. Check Required to make this field mandatory.

    11. Check Null as Wildcard to regard a Null value in the pricing matrix as a wildcard in matching the input condition.

        For example, a customer has the following discounts for T-shirt based on sizes and colors. (When the Size is large, the discount is 10% regardless of Color):

        • Size: large, Color: red, Discount: 10%

        • Size: large, Color: white, Discount: 10%

          Size: small, Color: red, Discount: 5%

        • Size: small, Color: white, Discount: 15%

          When this option is enabled, the setup can be simplified by setting Color as Null instead of enumerating all color choices. (Size: large, Color: null, Discount: 10%)

    12. (optional) Enter a Description.

    13. Click Create.

12. Repeat Step 11 to create additional input columns.

    Note: The Item Price attribute is automatically populated as a default output column.

13. If required, select Add Block Size/Price from the Output Columns - Actions drop-down to add block pricing output columns.

    Note: Both Block Size and Block Price attributes are added when Add Block Size/Price is selected. Correspondingly, if the Block Size attribute or the Block Price attribute is deleted, both of these interdependent attributes are also deleted.

Complete the following steps to create a Rate Card Template for releases Oracle CPQ 24B and Later.

1. Navigate to the Admin page.

2. Click Pricing Portal in the Products section.

3. Click on the Pricing Matrix Templates card.
4. Click Add.
   1. Enter the Name.
   2. Enter the Variable Name.
   3. Select Rate Card for the Template Type drop-down.
   4. (optional) Enter a Description.
   5. Click Create.

Add Pricing Matrix Template Columns

5. Select Add from the Actions drop-down.
6. Enter a Name for the Pricing Matrix Template column.
7. Enter the Variable Name for the Pricing Matrix Template column.
8. Select the Data Type.

9. Select a Pricing Lookup from the Lookup drop-down.

   • This field is only available for string data types.
   • Refer to Pricing Lookups for more information.

10. (optional) Select or enter a Default Value.

    • The default value cannot be specified for currency data types.
    • Only True or False values can be selected for Boolean data types.
    • When a Lookup is selected, you can select a default value from values defined in Pricing Lookups.

11. Check the Default Value Overridable option if the default value can be modified a sales user.

12. Check Negotiable to allow modification of this attribute at runtime.

13. Check Key to identify this field as a unique identifier.

14. Check Required to make this field mandatory.

15. optional) Enter a Description.

16. Click Create.

Complete the following steps to create a Scripting Price Model type Pricing Matrix Template in the CPQ Pricing Portal.

1. Navigate to Admin > Pricing Portal > Pricing Matrix Templates.

2. Select Add from the Actions drop-down.

   1. Enter the Name.

   2. Enter the Variable Name.

   3. Select Scripting Price Model from the Template Type drop-down.

   4. (optional) Enter a Description.

   5. Click Create.

3. Select Add from the Actions drop-down.

4. Enter the following data to create a template column.

   1. Enter the Name.

   2. Enter the Variable Name.

   3. Select the Data Type.

   4. If applicable, select a Lookup. (Lookups are only available for String Data Types)

   5. If applicable, enter of select a Default Value.

   6. Check Default Value Overridable if the default value can be modified.

   7. Check Required to make this field mandatory.

   8. Check Key to identify this field as a unique identifier.

   9. Repeat this step to enter additional columns.

   Example Scripting Price Model Pricing Matrix Template

   

5. Enter BML Script for the Scripting Price Model Pricing Matrix Template.

   1. Click Edit (In the Basic Details section).

   2. Expand More Details, and click the Advanced Script Edit link.

   3. Select the applicable attributes from the Pricing Document Attributes tab.

      Example Pricing Document Attributes

      • _currencyCode

      • salesChannel_c

      • lineMaximumDiscount_c

      • lineMinimumDiscount_c

      • salesProductType_c

      • calculationInfo

      • chargeDefinitionCode

      • chargeType

      • dynamicPricingType

      • maximumDiscount_c

      • minimumDiscount_c

      • pricePeriod

      • priceType

      • priceType

   4. Select _currentMatrix from the Special Parameters tab.

   5. Click Next.

   6. Enter the BML Script. See BML Script Example below

   7. Click Save and Close.

6. Click Update.

BML Script Example

salesChannel = jsonget(pricingDocument, "salesChannel_c", "string", "direct");

// Loop through lines
lines = jsonget(pricingDocument, "lines", "jsonarray");
indexes = range(jsonarraysize(lines));
for index in indexes {

  line = jsonarrayget(lines, index, "json");
  salesProductType = jsonget(line, "salesProductType_c", "string", "GOODS");

// Query the Pricing Data of this price model to get the discount corridor.
// Warning: this code snippet keeps things simple to highlight the syntax to set charges.
// In practice, avoid bmlq within loops whenever possible for better performance.
minDiscount = 0.;
maxDiscount = 0
resultSet = bmql("select minDiscount, maxDiscount from $_currentMatrix where salesChannel = $salesChannel and salesProductType = $salesProductType");
  for result in resultSet {
    minDiscount = getfloat(result, "minDiscount");
    maxDiscount = getfloat(result, "maxDiscount");
  }
  
  // Apply the discount corridor on all charges
  charges = jsonget(line, "charges", "jsonarray");
  if (isnull(charges)) {
    continue;
  }
  chargeIndexes = range(jsonarraysize(charges));
  for chargeIndex in chargeIndexes {
    charge = jsonarrayget(charges, index, "json");
    isProductPrice = jsonget(charge, "isProductPrice", "boolean");
    if (isProductPrice) {
      jsonput(line, "lineMinimumDiscount_c", minDiscount);
      jsonput(line, "lineMaximumDiscount_c", maxDiscount);
    } else {
      jsonput(charge, "minimumDiscount_c", minDiscount);
      jsonput(charge, "maximumDiscount_c", maxDiscount);
    }
  }
}
return pricingDocument;

Refer to Example Advanced Price Model & Scripting Matrix Template for more information.