Pricing and Charge Attributes

Overview

Oracle CPQ supports canonical Pricing and Charge Attributes in the CPQ pricing module. Pricing Attributes are mapped to specific attributes from Commerce, Parts, or Configuration. CPQ provides several standard Pricing Attributes with predefined mapping for frequently used attributes (e.g. Configuration Quantity, Commerce Quantity, Pricing Segment, and Account). Customers can also add their own custom Pricing and Charge Attributes. Pricing Attributes can be used to define conditions and functions for Price Models and Pricing Rules. The Price Models and Pricing Rules will be invoked based on the values from the Pricing Attributes and will automatically populate the price values referenced in conditions and functions.

Oracle CPQ 24D combined Charge Attributes with Pricing Attributes into a single module in the Pricing Portal. Refer to Charge Attributes for releases prior to Oracle CPQ 24D. The "Charge" type Pricing Entity identifies Charge Attributes inside the Pricing Attributes module. The Pricing Attributes module supports all previous Charge Attribute fields and functionality.

Pricing Attribute Pages

Pricing Attributes List Page - This list page allows administrators to view the pricing attributes Pricing Entity (Header or Line), Name, Variable Name, Data Type, and Type without opening individual Pricing Attributes details. The array type attributes are appropriately labeled in the Data Type column on the Pricing Attributes list page.

Item	Description
1	Navigate to Pricing Portal.
2	Click Actions to Add new custom Pricing Attributes, Reorder custom charge attributes, or to Manage Columns for the Pricing Attributes list. Note: Only custom Charge type Pricing Attributes can be reordered.
3	Enter search criteria to filter Pricing Attributes results, which remain persistent while navigating within Pricing Attributes.
4	Sort Pricing Attributes using the Pricing Entity, Name, Variable Name, Data Type, or Type column headers.
5	Edit an existing Price Attribute by clicking on the appropriate Name link or click on the line ellipsis and selecting Edit.
6	Edit or Delete a Pricing Attribute by clicking on the line ellipsis and selecting the appropriate action.

Pricing Attribute Page - This page allows administrators to manage Pricing Attributes. This section describes fields for Header and Line type Pricing Attributes. See Charge Type Pricing Attribute Page for more information about charge-related fields.

Item	Description
1	Navigate to the Pricing Attributes list page.
2	Navigate to Next or Previous pricing attribute in the pricing attributes list or filtered pricing attributes search results list.
3	Data Type: Boolean, Currency, String, Decimal, Date, or Integer.
4	Pricing Entity: Header, Line, or Charge
5	In/Out: Identifies if an attribute is a Pricing Engine input, output, internal, or external. Each Pricing Attribute can have only one of the following values: Input – This option defines attribute values that are used as inputs to pricing calculations. Output – This option defines attribute values that will be written as outputs from pricing into Commerce. Internal - This option defines attributes that are used only inside the Pricing Engine. For example, a customer segment attribute can be used internally within the Pricing Engine to determine pricing. It could be used in matrix-based pricing, pricing rule conditions, price model conditions, or BML scripts, but never be written into an output attribute. External – This value is automatically set for Charge Set Attributes that are currently calculated by CPQ Quoting but will in future be calculated by Pricing Engine. For now these attributes form part of the schema definition for Charge Set attributes in CPQ Commerce. This value cannot be selected when created new custom Pricing Attributes. The In/Out parameter can be set to Input, Output, or Internal for new custom Pricing Attributes. Charge Attributes are automatically set to Output.
6	Type: Custom or Standard
7	Status: Active or Inactive
8	Edit the pricing attributes Name, Lookup, Default Value, or Description.
7	Mapped Data Sources
8	Click Edit to add, reorder, and delete attribute mappings. Click Manage Columns to manage displayed columns.

Charge Type Pricing Attribute Page - This page allows administrators to manage Pricing Attributes. This section describes fields for Charge type Pricing Attributes.

Item	Description
1	Navigate to the Pricing Attributes list page.
2	Navigate to Next or Previous pricing attribute in the pricing attribute list or filtered pricing attribute search results list.
3	A Lookup associates a Lookup to a String type attribute.
4	The Data Type: Boolean, Currency, Date, Decimal, Integer, String, or Text Area.
5	The Default Value for specified for Boolean, Date, Decimal, Integer, or String data types. When a Lookup is selected, you can select a default value from values defined in Lookups.
6	Pricing Entity: Header, Line, or Charge
7	In/Out: Identifies if an attribute is a Pricing Engine input, output, internal, or external. Each Pricing Attribute can have only one of the following values: Input – This option defines attribute values that are used as inputs to pricing calculations. Output – This option defines attribute values that will be written as outputs from pricing into Commerce. Internal - This option defines attributes that are used only inside the Pricing Engine. For example, a customer segment attribute can be used internally within the Pricing Engine to determine pricing. It could be used in matrix-based pricing, pricing rule conditions, price model conditions, or BML scripts, but never be written into an output attribute. External – This value is automatically set for Charge Set Attributes that are currently calculated by CPQ Quoting but will in future be calculated by Pricing Engine. For now these attributes form part of the schema definition for Charge Set attributes in CPQ Commerce. This value cannot be selected when created new custom Pricing Attributes. The In/Out parameter can be set to Input, Output, or Internal for new custom Pricing Attributes. Charge Attributes are automatically set to Output.
8	Type indicates if the Charge Attribute is standard of custom.
9	Status indicates if the Charge Attribute is active of inactive.
10	Click Edit to modify editable charge attribute fields. The fields that are editable are dependent on the charge attribute Type and Data Type.
11	Visibility identifies if the charge attribute is visible in other CPQ modules. Administration: CPQ administrator UIs, for example, Pricing Portal, Product Launch Administration must be visible to display an attribute in Price Model > Pricing Data. Runtime: Buy-side UIs, for example, quoting & configuration buy-side.
12	Selected Value: Key, Required, or Negotiable.
13	Click Edit to add, reorder, and delete attribute mappings. Click Manage Columns to manage displayed columns.
14	Mapped Data Sources

Standard Pricing Attributes

CPQ provides the following standard Pricing Attributes with predefined mapping for frequently used attributes. Standard Pricing Attributes and mappings cannot be deleted or inactivated.

Standard Pricing Attributes

Pricing Entity	Name	Description	Variable Name	Data Type	Lookup	In/Out	Visibility
Header	Buying Account ID	Buying account ID. Default to the customer ID of the current transaction if attribute mapping is not defined. Pricing Engine uses this attribute to locate price agreements for a customer.	_buyingAccountId	String		Input
Header	Currency Code	The currency code of the sales transaction. Default to the system currency preference (_system_current_document_currency_pref) of the commerce transaction if attribute mapping is not defined.	_currencyCode	String		Input
Header	Customer ID	Customer ID. Default to Customer ID (_customer_id) of the commerce transaction if attribute mapping is not defined.	_customer_id	String		Input
Header	Price As Of	Price as of date. When empty, the current timestamp at the pricing execution is used.	_priceAsOf	Date		Input
Line	BOM Item Variable Name	Variable Name of the BOM item definition for a BOM item. It is empty for a part item.	_bomItemVariableName	String		Input
Line	Line Price As Of	Price as of date for a line. When empty, the header price as of date is used.	_linePriceAsOf	Date		Input
Line	Part Number	Part number of a line item.	_partNumber	String		Input
Line	Quantity	The exploded line quantity used in Pricing Engine. For example, in a product hierarchy with 2 child products per root product and 3 grandchild parts per child product, this value will be '6' for the grandchild product when the root quantity is '1 and 12 when the root quantity is '2'. This attribute implicitly maps to the Quantity (_price_quantity) attribute in the quote line Price Attribute Set, but the default can be overridden by explicitly defining a different mapping.	_quantity	Integer		Input
Line	Requested Agreement Number	The price agreement that will be applied to the line if applicable. Note if the supplied agreement number is not applicable. then a default agreement will be applied.	_requestedAgreementNumber	String		Input
Line	Requested Rate Plan Number	Rate Plans provide a way for vendors to provide pricing-related options to their customers. For example, the same product (or quote line) can be sold either with a one time sale price, OR the customer could elect to pay for it via a recurring charge per month for 3 years (i.e. with subscription billing). Rate Plans are setup in both CPQ Pricing Engine/Portal and Oracle Subscriptions Management then are available for selection by sales representatives or self service users using CPQ quoting. Note that Rate Plans may contain one or many charges. Note: Beginning in Oracle CPQ 25A the ‘Available Rate Plans’ attribute is no longer used in Standard Process logic. It is changed to a non-standard attribute, but is not removed from existing standard processes upon upgrade to Oracle CPQ 25A. Beginning in Oracle CPQ 25A, during the CPQ quoting or ordering process, a default Rate Plan is applied initially on the quote line to the Applied Rate Plan attribute, and the user is presented with listings of the Rate Plans available for their selection from the Requested Rate Plans attribute. When the user selects a Rate Plan from the Requested Rate Plan drop-down on the Line Item Grid, it is captured in the UI but the line is NOT repriced until a SAVE action occurs. At that point the pricing on the quote line will reflect the selected Rate Plan as the Applied Rate Plan. Refer to Applying Rate Plans for more information	_requestedRatePlanNumber	String		Input
Line	Service Duration	The duration to service a product, measured in the unit of Service Duration Period. Only applicable to a product that fulfills a service contract.	_serviceDuration	Integer		Input
Line	Service Duration Period	The time period unit in which a product is service, e.g., month or year. Only applicable to a product that fulfills a service contract.	_serviceDurationPeriod		Service Duration Periods	Input
Charge	Calculation Information	A JSON array of the Price Models used in calculating this charge's price.	calculationInfo	Text Area		Output	Runtime
Charge	Charge Definition	The display label of the charge definition. This attribute is only available when Charge Definitions are enabled.	chargeDefinition	Text		Output	Administration Runtime
Charge	Charge Definition Code	The code of the charge definition. This attribute is only available when Charge Definitions are enabled.	chargeDefinitionCode	Text		Output	Runtime
Charge	Charge Definition Integration ID	The charge definition code in the integrated order management system. This attribute is only available when Charge Definitions are enabled.	chargeDefinitionIntegrationId	Text		Output	Runtime
Charge	Charge Type	The classification of a charge associated with the price for a product or service. This attribute differentiates the purpose of charges with the same price type and price period. For example, the sale of a network device may have both a one-time purchase price (with charge type of 'Purchase Price') and a one-time installation price (with charge type of 'Installation Fee').	chargeType	String	Charge Types	Output	Administration Runtime
Charge	Discount Amount	The extended custom discount amount per period for this charge. Typically this represents the unit discount x quantity.	discountAmount	Currency		Output	Runtime
Charge	Discount Type	The type of custom discount applied to this charge. Typically this may be an override price, a discount value or a discount percentage.	discountType	String	Discount Types	Output	Runtime
Charge	Discount Value	The numeric value for a custom discount associated with the discount type for this charge. For example, if the Discount Type is Override, this value with be the override price for this charge.	discountValue	Decimal		Output	Runtime
Charge	Dynamic Pricing Type	The type of dynamic pricing used to define this charge: static, tiered, volume, rate card, advanced.	dynamicPricingType	String		Output	Runtime
Charge	Extended List Amount	The extended price of a line item. This is the line unit price multiplied by the quantity.	extendedListAmount	Currency		Output	Runtime
Charge	Net Amount	The extended net price or amount per period that will be paid for this charge. Typically this represents the unit price x quantity.	netAmount	Currency		Output	Runtime
Charge	Net Price	The unit price net of all discounts for this charge. The Net Price is the unit price that the customer will be invoiced.	netPrice	Currency		Output	Runtime
Charge	Price Period	The time period, frequency, or recurrence with which the price or charge is levied.	pricePeriod	String	Price Periods	Output	Administration Runtime
Charge	Price Type	The basis on which a price or charge is levied, whether one time, on a periodic basis or based on usage.	priceType	String	Price Types	Output	Administration Runtime
Charge	Rate Card	Display label for the Rate Card applied in calculating this charge's price.	rateCard	String		Output	Runtime
Charge	Rate Card in HTML	The HTML-formatted rate card data.	rateCardinHTML	Text Area		Output	Runtime
Charge	Rate Card Structure	The rate card used to calculate this charge's price.	rateCardStructure	Text Area		Output	Runtime
Charge	Rate Card Variable Name	Variable Name for the Rate Card applied in calculating this charge's price.	rateCardVariableName	String		Output	Runtime
Charge	Tax Calculation	A JSON array of the additional tax information like tax amount, net price excluding tax, and net amount excluding tax.	taxCalculationInfo	Text Area		External	Runtime
Charge	Tax Price	Tax to be paid for each unit of the line item.	taxPrice	Currency		External	Runtime
Charge	Total Amount Including Tax	Total amount to be paid for the line item, including taxes.	totalAmountIncludingTax	Currency		External	Runtime
Charge	Total Price Including Tax	Total price to be paid for each unit of the line item, including taxes.	totalPriceIncludingTax	Currency		External	Runtime
Charge	Total Prorated Order Discount	Total order-level discount prorated for this charge.	totalProratedOrderDiscount	Currency		External	Runtime
Charge	Unit Price	The unit price to be paid by the customer for this charge.	unitPrice	Currency		Output	Runtime
Charge	Unit Prorated Order Discount	Per unit order-level discount prorated for this charge.	unitProratedOrderDiscount	Currency		External	Runtime
Charge	Usage UOM	The unit of measure of usage for usage charges, which may differ from the unit of measure used for the parent product.	usageUOM	String	Usage UOMs	Output	Administration Runtime

Standard Pricing Attribute Mapping

Pricing Entity	Name	Variable Name	Data Source	Source Attribute Name	Source Attribute Name	Source Entity
Header	Customer ID	_customerId	Quoting : All Processes	Customer Id	_customer_id	Header
Line	Bom Item Variable Name	_bomItemVariableName	BOM Item Attributes	Variable Name	variableName	BOM Item
Line	Part Number	_partNumber	Item Attributes	Part Number	part_number	Part
Line	Quantity	_quantity	Item Attributes	Quantity	quantity
Line	Requested Rate Plan Number	_requestedRatePlanNumber	Quoting : All Processes	Requested Rate Plan	_requestedRatePlan	Line
Charge	Calculation Information	calculationInfo	Quoting : All Processes	Calculation Information	_price_calculation_info	Line
Charge	Calculation Information	calculationInfo	Quoting : All Processes	Calculation Information	calculationInfo	Charge Set
Charge	Charge Definition	chargeDefinition	Quoting : All Processes	Charge Definition	chargeDefinition	Charge Set
Charge	Charge Definition Code	chargeDefinitionCode	Quoting : All Processes	Charge Definition Code	chargeDefinitionCode	Charge Set
Charge	Charge Definition Integration ID	chargeDefIntegrationId	Quoting : All Processes	Charge Definition Integration ID	chargeDefIntegrationId	Charge Set
Charge	Charge Type	chargeType	Quoting : All Processes	Charge Type	chargeType	Charge Set
Charge	Dynamic Pricing Type	dynamicPricingType	Quoting : All Processes	Dynamic Pricing Type	dynamicPricingType	Charge Set
Charge	Extended List Amount	extendedAmount	Quoting : All Processes	Extended List Amount	extendedAmount	Charge Set
Charge	Price Period	pricePeriod	Quoting : All Processes	Price Period	_price_period	Line
Charge	Price Period	pricePeriod	Quoting : All Processes	Price Period	pricePeriod	Charge Set
Charge	Price Type	priceType	Quoting : All Processes	Price Type	_price_type	Line
Charge	Price Type	priceType	Quoting : All Processes	Price Type	priceType	Charge Set
Charge	Rate Card	rateCardName	Quoting : All Processes	Rate Card	rateCardName	Charge Set
Charge	Rate Card Structure	rateCardStructure	Quoting : All Processes	Rate Card Structure	rateCardStructure	Charge Set
Charge	Rate Card Variable Name	rateCardVariableName	Quoting : All Processes	Rate Card Variable Name	rateCardVariableName	Charge Set
Charge	Unit Price	unitPrice	Quoting : All Processes	Unit Price	_price_unit_price_each	Line
Charge	Unit Price	unitPrice	Quoting : All Processes	Unit Price	unitPrice	Charge Set
Charge	Usage UOM	usageUOM	Quoting : All Processes	Usage UOM	usageUOM	Charge Set

Pricing Attribute Enhancements

Oracle CPQ 24D combined Charge Attributes with Pricing Attributes. The Pricing Attributes module supports all previous Charge Attribute fields and functionality.
Oracle CPQ 24D also introduced the In/Out parameter for Pricing and Charge Attributes to identify if an attribute is a Pricing Engine input, output, internal, or external. Each Pricing Attribute can have only one of the following values:
- Input – This option defines attribute values that are used as inputs to pricing calculations.
- Output – This option defines attribute values that will be written as outputs from pricing into Commerce.
- Internal - This option defines attributes that are used only inside the Pricing Engine. For example, a customer segment attribute can be used internally within the Pricing Engine to determine pricing. It could be used in matrix-based pricing, pricing rule conditions, price model conditions, or BML scripts, but never be written into an output attribute.
- External – This value is automatically set for Charge Set Attributes that are currently calculated by CPQ Quoting but will in future be calculated by Pricing Engine. For now these attributes form part of the schema definition for Charge Set attributes in CPQ Commerce. This value cannot be selected when created new custom Pricing Attributes.
The In/Out parameter can be set to Input, Output, or Internal for new custom Pricing Attributes. New custom Charge-type Pricing Attributes are automatically set to Output.
Oracle CPQ 24C introduced the Line Price As Of attribute to expand price effectivity to honor a 'price as of' date for each quote line when pricing is re-evaluated.
Lookups for Pricing Attributes - Oracle CPQ 24B enables text type Pricing Attributes to be mapped to Lookups so that valid domains of values are presented for selection by the pricing administrator and product manager. Valid domains of values can be defined in Lookups.
Oracle CPQ 23B introduced the BOM Item Variable Name Attribute Pricing Attribute to automatically supports BOM item product pricing in the Pricing Engine without requiring a pricing administrator to set up this attribute and its mapping.

Administration

Add a Custom Pricing Attribute

Add a Custom Charge Attribute

Synchronize Charge Array Set

Enable Apply context-dependent data source in Pricing Attribute Mapping

Pricing Engine Quantity Attribute

Reorder Mapped Pricing Attributes

Notes

Caution: A header Pricing Attribute should not be mapped to a Configuration attribute, unless pricing is executed only for recommended items in Configuration. In all other scenarios, the Pricing Attribute can have an invalid value during runtime execution, for example at quoting, or for BOM items in Configuration. If you'd like to map to a Configuration attribute, consider using a line Pricing Attribute instead.

Notes:

By default, CPQ Pricing Engine uses a standard natural key for the Charge object including Price Type, Charge Type, and Price Period.
Mapping a Text Area type Charge Attribute to a Commerce Text attribute may cause truncated data.
Oracle Order Management requires that each Charge for an item has a unique combination of Price Type and Charge Type. If you are integrating Oracle CPQ with Oracle Order Management you will need to define a different Charge Type to distinguish Charges with the same Price Type but different Price Periods.
The maximum number of custom Pricing/Charge Attributes is 75. Submit a Service Request (SR) on My Oracle Support to change the maximum number.

Pricing and Charge Attributes

Overview

Pricing Attribute Pages

Standard Pricing Attributes

Pricing Attribute Enhancements

Administration

Notes

Related Topics