Commerce Standard Process

Overview

The Standard Process standardizes the quote object with seeded and systemized functional logic making it much easier for customers to adopt new commerce features and provides a unified solution for Oracle CX Sales, Subscription, and Order Management.

The Standard Process is delivered for new Oracle CX Sales integrated site installations and is the default process when creating a new Commerce process. There is no change to existing Commerce process definitions. New and existing customers will have the ability to create a new Standard Process that is automatically populated with documents, attributes, actions, rules, library functions, layouts, data columns, Commerce integrations, and workflow steps.

Standard Process Upgrade Support - Beginning in 23C, all new functionality for controlled entities added to the Standard Commerce Process will be automatically available to existing customers as part of the product release upgrades.

ClosedView Standard Process Upgrade Summary

Release Type Description Details
24A Commerce Library Function

Update system_calculation_process

For usage products and usage charges, made changes to set net amount, list amount, cost amount, and discount amount to "0" to exclude usage charges and usage products from line and header rollup calculations.

24A Commerce Library Functions

Update system_calculation_process library function

Made changes to consider charge's price type and price period only for contractedPeriods_l calculation.

For other calculations, line's price type and line's price period should be considered

24A FOM Integrations

Include line item type attribute in XML for FOM integrations

Deselect _line_item_type "Exclude From XML" option (by default) to include attribute in XML sent to FOM integration.

24A Main Document and Sub-Document Attributes

Default values for Contract start date & End date

  • Set default defaultRequestDate_t value to current date
  • Set default contractStartDate_t value to defaultRequestDate_t
  • If present, set default contractStartDate_l value to contractStartDate_t
  • If present, set value contractEndDate_l value to contractEndDate_t
24A Main Document Attributes and Workflow Steps

Support subscription renewals

  • Add new Renew Draft Subscription Number (renewDraftSubscriptionNumber_t) main document attribute - Subscription Management contract ID for the draft subscription used in the renewal process.

  • Set the opportunityID_t, opportunityName_t, and opportunityNumber_t attribute Read/Write value to truein the "Start" workflow step for "Admin" and "Sales User".

24A Salesforce Integrations

New Salesforce related Commerce integrations

 

Added the following Commerce SOAP integrations:

  • Opportunity Import (SOAP - Import) Salesforce: Imports the Opportunity details and populates the corresponding attribute values on the Transaction.
  • User Import (SOAP - Import) Salesforce: Imports the User details and populates the corresponding attribute values on the Transaction.
  • Quote Import (SOAP - Import) Salesforce: Imports the Oracle Quote details and populates the corresponding attribute values on the Transaction.
  • Quote Upsert (SOAP - Export) Salesforce: Creates an Oracle Quote record if one does not exist, otherwise it updates the existing one. Also sets the flag that tells the Oracle CPQ Connector that an upsert operation has begun.
  • Line Item Upsert 200 (SOAP - Export) Salesforce: Creates or updates Oracle Quote Line Items on the Oracle Quote that are associated with the Lines on the Transaction and populates the corresponding fields. This upserts the first batch of 200 lines.
  • Quote Upsert Complete (SOAP - Export) Salesforce: Updates the flag on the Oracle Quote that lets the Oracle CPQ Connector know that the upsert is complete. This triggers all the Salesforce-side updates to the Oracle Quote and Opportunity.
24A Sub-Document Rule

New Coverage support Validation rule

Add a new sub-document Validation rule to validate that _s_coverageOrderNumber and  _s_coverageLineNumber are not empty when the _is_Coverage is true.

24A Sub-Document Attributes

New attributes to support Rate Plan selection

  • Available Rate Plans menu attribute allows sales users to see the applicable Rate Plans and to select the desired Rate Plan from the available list. When a new Rate Plan is selected, the charges are updated with the selected Rate Plan values.

  • Added the Available Rate Plan Set array set to capture the list of Rate Plans for a given product. The Available Rate Plan Set array set contains the following attributes:

    • Available Rate Plan Name
    • Available Rate Plan Number
    • Available Rate Plan Integration Id
24A Sub-Document Attributes

New Coverage attribute and default sub-document mapping

Added the _is_coverage sub-document attribute to indicate whether the product is of coverage type. The default BML function for this attribute is:

flag = false; if((isnull(_part_sales_product_type)<>true) and (find(upper(_part_sales_product_type),"COVERAGE") >= 0)) { flag = true; } return flag;

When the sub-document " Enable Coverage Service Quoting" option is set to Yes, the following default mapping fields are set:

  • Coverage Order Number Mapping: _s_coverageOrderNumber
  • Coverage Line Number Mapping: _s_coverageLineNumber
  • UOM Mapping: requestedUnitOfMeasure_l
  • Quantity Mapping: _price_quantity
  • Order Number Mapping: oRCL_ERP_OrderNumber_t
  • Customer Id Mapping: _customer_id
24A Sub-Document System Attributes

New Transaction Line attribute

Added the _transactionLine_id sub-document system attribute uniquely identify a line item across transactions for a given Commerce Process. Deleted _s_transactionLineId_l sub-document attribute since it was no longer being used.
24A Transaction UI

Label update

"Update Opportunity" action label changed to "Update SFA" on the Commerce Transaction UI.

23D FOM Integrations Allow override of sub-document UOM
  • Updated "system_calculations_process" Commerce Library Functions to allow override of the sub-document "requestedUnitOfMeasure_l" attribute.
  • When empty default to "_part_default_uom" (if it has a value) OR "_part_units" (if it has a value) OR default to "Ea", in that order.
23D FOM Integrations Populate price type for Price Models with Product Price
  • Added "_price_type" and "_price_period" sub-document attributes as inputs to " system_calculations_convertQuoteToObj" Library Function and added them to sub-document dictionary object.
  • Updated logic in Commerce Library "system_calculations_process" to populate sub-document attributes "priceType_l" and "pricePeriod_l" to pricing engine's price type and price period respectively, when pricing engine price type and price period are not null or empty.
23D FOM Integrations Support Rate Plans
  • Added new "_s_oRCL_chargeDefIntegrationId" Text type attribute to the sub-document "oRCL_charges" array set.
  • Updated "oRCL_fOM_populateCharges" Commerce Library Function to populate the sub-document "oRCL_charges" array set.
23D FOM Integrations Added 'Sold To" attributes to support Rate Plans

Added the following main document Text attributes:

  • _s_customerPartySiteID_t
  • _s_soldToPartyID_t
  • _s_soldToPartySiteID_t
  • _s_invoiceToPartySiteID_t
  • _s_shipToPartyID_t
  • _s_shipToPartySiteID_t
  • _s_soldToCustomerAccountID_t
23D FOM Integrations Display an error in CPQ when an order with unassociated subscriptions is canceled.

Added CLOSED status to "cancelOrder" Commerce Library Function.

23D Main Document and Sub-Document Attributes

Populate attributes when creating a quote from an opportunity with an account.

Replaced the following integer type attributes with text attributes:

Main document attributes:

  • "accountContactNumber_t" replaced with "_s_accountContactNumber"
  • "accountPartyId_t" replaced with "_s_accountPartyId_t"
  • "accountPartyNumber_t" replaced with "_s_accountPartyNumber_t"
  • "contractID_t" replaced with "_s_contractID_t"
  • "contactNumber_t" replaced with "_s_contactNumber_t"
  • "contactPartyNumber_t" replaced with "_s_contactPartyNumber_t"
  • "contractTypeID_t" replaced with "_s_contractTypeID_t"
  • "subscriptionId_t" replaced with "_s_subscriptionId_t"

Sub-document attribute:

  • "partID_l" replaced with "_s_partID_l"
23D Main Document Attribute Added price type menu options. Added "One Time", "Recurring", and "Usage" menu options to main document "priceType_t" attribute.
23D Sub-Document Action Maintain BOM structures in the Line Item Grid when navigating back from a sub-document.

Replaced the sub-document "back_l" Modify type action with the sub-document "_s_back_l" Back type action

23D Sub-Document Attributes

Enable population of "requestDate_l" value from "transactionDate" value.

Updated the following sub-document attributes:

  • Removed the "return defaultRequestDate_t" default value from the "requestDate_l" sub-document attribute
  • Removed "M1" default value from the "fulfillmentOrganizationCode_l" sub-document attribute
23D Sub-Document Attributes Support coverage products

Added the following sub-document Text type attributes:

  • _s_coverageOrderNumber
  • _s_coverageLineNumber
23D Sub-document Charge Array Set Support Rate Plans in Document Designer
  • Added new sub-document Charge Array Set "_chargeSet_rateCardInHTML" Rich Text type attribute.

    If there is an existing sub-document Charge Array Set "_chargeSet_rateCardInHTML" Text Area type, it will be changed to a Rich Text type attribute.

  • Add new "generateRateCardHTML" Commerce Library Function.
  • Update "system_calculations_process" Commerce Library Function
  • Update "_update_line_items" action.
23C Commerce Library Functions Remove BML print statements

Removed print statements from "standard_process_calculations" Commerce Library Function

23C FOM and Oracle CX Sales Integrations Updated "system_calculations_process" Commerce Library Function

Default value of "Ea" should only be added to "requestedUnitOfMeasure_l" sub-document attribute when the line is a "PART" and when "_part_default_uom" and "_part_units" are empty or null.

23C FOM Integrations Sub-document Charge Set Attributes and Populate Charges Commerce Library Function
  • Delete existing "oRCL_chargeType" menu attribute from the sub-document "oRCL_charges" array
  • Add new "_s_oRCL_chargeType" text attribute to the sub-document "oRCL_charges" array
  • Updated "oRCL_fOM_populateCharges" Commerce Library Function to replace all references of "oRCL_chargeType" with " _s_oRCL_chargeType"
23C FOM Integrations Updates to support charges in FOM integrations
  • Updated " system_calculations_convertQuoteToObj" Commerce Library Function to add " _chargeSetControl to line dictionary object.
  • Added new attributes to the sub-document "oRCL_charges" array set: "_s_oRCL_priceType", "_s_oRCL_pricePeriod", "_s_oRCL_priceUOM", and "_s_oRCL_customDiscountType".
  • Updated " oRCL_fOM_populateCharges" Commerce Library Functions to support new sub-document "oRCL_charges" array set attributes.

23C Main Document Rules New constraint rule for line status

Added new "_s_validateLineStatusValuesForCancelOrderValidate"main document constraint rule to ensure line status cannot be Awaiting Billing when performing Cancel Order

23C Sub-Document Attributes Charge Set Attributes

Added Synchronize Charge Array Set action the Sub-Document Attribute List page synchronize the sub-document Charge Array Set with the pricing charge schema. If the sub-document Charge Array Set doesn’t exist, it will be created when the Synchronize Charge Array Set action is invoked.

23C Sub-Document Attributes Replace Transaction Line ID integer attribute with text attribute
  • Deleted existing "tranactionLineID_l" sub-document integer attribute.
  •  Added new "_s_transactionLineId_l" sub-document text attribute and set default value to _system_buyside_id + "_" + _document_number
23C Sub-Document Rules New hiding rule for Contracted Periods (Rollup)

Added " _s_hideContractedPeriodsRollupHide" sub-document hiding rule for Contracted Periods (Rollup) when Price Type (Rollup) is equal to One Time.

23C Sub-Document Rules Validate Contract End Date is not empty for subscription items.

Added "_s_validateContractEndDate" sub-document constraint rule to

validate Contract End Date is not empty for subscription items.

Standard Process Items

The following table lists Standard Process items and describes controlled behavior, uncontrolled properties, and controlled properties.

Controlled Entity

Controlled Behavior

Uncontrolled Properties

Controlled Properties

Comments

Commerce Process

Deletion allowed

All properties

None

 

Main & Sub-Documents

No deletions, No type change

Translations

All other properties

 

Main & Sub-Document Attributes

No deletions, No type change

Translations, Document Views, Mapping

All other properties

Charge Attribute Array is Read-only

Process Actions

Main & Sub-Document Actions

No deletions, No type change

Translations, Document Views, Integrations

All other properties

 

Main & Sub-Document Rules

No deletions, No type change

Translations, Status, Name, Description

All other properties

 

Commerce Libraries (BML)

No deletions

Name, Description

All other properties

 

Main & Sub-Document JET Responsive Layouts

No deletions

All properties

No controlled properties

Legacy and Mobile layouts are not supported

Steps

Deletion allowed

All properties

No controlled properties

 

Data Columns

Deletion allowed

All properties

No controlled properties

 

Commerce Integrations

Deletion allowed

All properties

No controlled properties

 

Shopping Cart

Not Applicable

All properties

No controlled properties

The Shopping Cart is delivered disabled, but can be enabled.

Formulas

Not Applicable

All properties

No controlled properties

No Formulas are provided in the Standard Process. Previous formulas were moved to BML

ClosedStandard Process Documents

The Standard Process documents come with predefined functional logic that is ready for customers' use. If required, seeded logic can be overridden by administrators to incorporate their customization logic. The standard main and sub-documents are Transaction and Transaction Line, respectively.

To override a default value, check the applicable override option, click Apply, and then define the new function. To quickly return to the standard function, simply uncheck the applicable override option, and then click Apply.

Standard Process Document Overrides

To view a pre-defined function in read-only mode, click View Function.


ClosedStandard Process Attributes

Commerce attributes are the foundation for input fields to collect data such as billing, shipping, parts, pricing, and revenue information. The Standard Process attributes have been rationalized to remove redundant attributes and to streamline and simplify Commerce integrations.

The following attributes have been removed from the Standard Process sub-document Price Attribute Set:

  • _price_subtotal
  • _price_discount_percent
  • _price_total_discount
  • _price_net_price
  • _price_override_price
  • _price_override_discount
  • _price_discount_comment
  • _price_override_quantity

Note: This change only impacts new sites and newly created Standard Processes. These attributes will not be removed from existing Commerce processes.

Standard Process attributes cannot be deleted or reordered, but default values and modify actions can be overridden. To quickly return to the standard default values, simply uncheck the applicable override option, and then click Apply.

Standard Process Attribute Default Override

Default modify actions, functions, and settings can also be overridden and reverted.

Standard Process Attribute Modify tab

ClosedStandard Process Transaction Attributes

  Name   Variable Name   Type   Description   Standard Component
Account Address Element Attribute 1

accountAddressElementAttribute1_t

Text Account AddressElementAttribute1 Yes
Account Address Element Attribute 2

accountAddressElementAttribute2_t

Text Account AddressElementAttribute2 Yes
Account Address Element Attribute 3

accountAddressElementAttribute3_t

Text Account AddressElementAttribute3 Yes
Account Address Element Attribute 4

accountAddressElementAttribute4_t

Text Account AddressElementAttribute4 Yes
Account Address Element Attribute 5

accountAddressElementAttribute5_t

Text Account AddressElementAttribute5 Yes
Account Address Line 1

accountAddressLine1_t

Text First line of the account address Yes
Account Address Line 2

accountAddressLine2_t

Text Second line of the account address Yes
Account Address Line 3

accountAddressLine3_t

Text Third line of the account address Yes
Account Address Line 4

accountAddressLine4_t

Text Fourth line of the account address Yes
Account Address Type

addressType_t

Menu Address type of the account address Yes
Account City

accountCity_t

Text City of the account Yes
Account Contact Number

_s_accountContactNumber_t

Text Contact number of the account. Yes
Account Country

accountCountry_t

Text Country of the account Yes
Account Email Address

accountEmailAddress_t

Text Email address of the account Yes
Account First Name

accountFirstName_t

Text First Name of the Account Contact Yes
Account Last Name

accountLastName_t

Text Last Name of the Account Contact Yes
Account Middle Name

accountMiddleName_t

Text Middle Name of the Account Contact Yes
Account Name

accountName_t

Text The attribute which captures the name of the Account Yes
Account Name Suffix

accountNameSuffix_t

Text Name suffix of the Account contact Yes
Account Party Number

_s_accountPartyNumber_t

Text Identifier for the type of the account under the party. Yes
Account Party Id

_s_accountPartyId_t

Text The CDM integration provides the value for this field based on the Customer Company Name Yes
Account Postal Code

accountPostalCode_t

Integer Postal Code of the account Yes
Account Province

accountProvince_t

Text Province of the account Yes
Account State

accountState_t

Text State of the account Yes
Account Type

accountType_t

Menu Type of the customer account (Billing, Sales, etc.) Yes
Account Unique Name

accountUniqueName_t

Text Unique identifier for the Account contact Yes
Annual Contract Discount

totalAnnualDiscount_t

Currency The total value each year of the discounts on recurring charges for the transaction. Yes
Annual Contract Value (List)

annualContractListValue_t

Currency The total of contract extended values at list price within the first year, including only recurring pricing. Yes
Annual Contract Value (Net)

totalAnnualValue_t

Currency The total value of recurring charges each year. Yes
Annual Cost

totalAnnualCostAmount_t

Currency The total of recurring extended costs each year for the transaction. Yes
Annual Margin

totalAnnualMarginAmount_t

Currency The total of recurring extended margins each year for the transaction. Yes
Bill To Site Use Id

billToSiteUseId_t

Text CDM integration will provide value to this field based on Customer company name Yes
Billing Frequency

oRCL_billingFrequency_t

Menu Determines the billing frequency for a subscription. Yes
Business Unit ID

businessUnitId_t

Text Customer business unit identifier. Yes
Business Unit Name

businessUnitName_t

Text Customer business unit name. Yes
Cancel Explanation

cancelExplanation_t

Text Area A detailed, free-form explanation of why the customer canceled the sales order. This supplements the Cancel Reason selected by the sales user. Yes
Cancel Reason

cancelReason_t

Menu The reason expressed by the customer for canceling this order. The reason is selected by the sales user from a list of standard values for the site. Yes
Contact Address Element Attribute 1

contactAddressElementAttribute1_t

Text Contact AddressElementAttribute1 Yes
Contact Address Element Attribute 2

contactAddressElementAttribute2_t

Text Contact AddressElementAttribute2 Yes
Contact Address Element Attribute 3

contactAddressElementAttribute3_t

Text Contact AddressElementAttribute3 Yes
Contact Address Element Attribute 4

contactAddressElementAttribute4_t

Text Contact AddressElementAttribute4 Yes
Contact Address Element Attribute 5

contactAddressElementAttribute5_t

Text Contact AddressElementAttribute5 Yes
Contact Address Line 1

contactAddressLine1_t

Text First line of the contact address Yes
Contact Address Line 2

contactAddressLine2_t

Text Second line of the contact address Yes
Contact Address Line 3

contactAddressLine3_t

Text Third line of the contact address Yes
Contact Address Line 4

contactAddressLine4_t

Text Fourth line of the contact address Yes
Contact City

contactCity_t

Text City of the contact Yes
Contact Country

contactCountry_t

Text Country of the contact Yes
Contact Email Address

contactEmailAddress_t

Text Email address of the contact Yes
Contact First Name

contactFirstName_t

Text First Name of the Contact Yes
Contact Last Name

contactLastName_t

Text Last Name of the Contact Yes
Contact Middle Name

contactMiddleName_t

Text Middle Name of the Contact Yes
Contact Name Suffix

contactNameSuffix_t

Text Name suffix of the contact Yes
Contact Number

_s_contactNumber_t

Text Contact number of the contact. Yes
Contact Party Number

_s_contactPartyNumber_t

Text Identifier for the type of the contact under the party. Yes
Contact Postal Code

contactPostalCode_t

Text Postal Code of the contact Yes
Contact Province

contactProvince_t

Text Province of the contact Yes
Contact State

contactState_t

Text State of the contact Yes
Contact Type

contactType_t

Menu Type of the customer contact (Billing, Sales, etc.) Yes
Contact Unique Name

contactUniqueName_t

Text Unique identifier for the Account contact Yes
Contact Name

contactName_t

Text The attribute which captures the Contact Name of the Account Yes
Contract End Date

contractEndDate_t

Date Date that the customer stops receiving all of the products and services on the quote. Used when all services are co-terminated at the quote level. Yes
Contract ID

_s_contractID_t

Text The identifier of the CLM contract Yes
Contract Name

contractName_t

Text The attribute which captures the name of the CLM contract Yes
Contract Start Date

contractStartDate_t

Date Date that the customer starts to receive all of the products and services on the quote. Used when all services are co-terminated at the quote level. Yes
Contract Type ID

_s_contractTypeID_t

Text The identifier for the CLM contract Type. Yes
Contract Type Name

contractTypeName_t

Text The attribute which captures the contract type name of the CLM contract Yes
Contracted Periods

contractedPeriods_t

Integer Number of periods the customer has contracted to receive the transaction. Yes
Cover Letter

coverLetter_t

Rich Text The cover letter to be attached to the proposal document for this transaction. Yes
Create Order Rest Response

createOrderRestResponse

Text Area This attribute holds the rest response of create order Yes
Created By

createdBy_t

Text The person that created the transaction. Yes
Created Date

createdDate_t

Date The date when the transaction was created. Yes
Currency

currency_t

Menu The currency used to price and invoice this transaction. Yes
Current Step

currentStepForTesting_tempDisplay_t

Text This attribute is exposed only to the Administrator to assist in debugging modifications to the Commerce Process Steps and Transition Rules. Yes
Customer Id

_customer_id

Customer Id This is the special Customer ID (with attribute type = Customer ID) used in CPQ-platform-supplied CRM integrations. This attribute is associated with the automatically-created Autofill, Browse, Select Alternate Address, and View Actions. Yes
Customer Party Site ID

_s_customerPartySiteID_t

Text The ID for the Party Site or Address of the CRM Customer. Yes
Default Request Date

defaultRequestDate_t

Date The date on which the user requests that fulfillment occur for this transaction. Yes
File Attachment

fileAttachment_t

File Attachment The file attachment containing the Proposal Document. Yes
Freeze Price Flag

freezePriceFlag_t

Boolean Determines whether the external system should use CPQ Pricing or not. If set to true, the external system will use CPQ Pricing. Yes
Fulfillment Status

fulfillmentStatus_t

Menu This is the most advanced fulfillment status for any line on the transaction. The value for this attribute is derived from that supplied for each line by the fulfillment system after the transaction is submitted as a sales order. Yes
Has Recurring Pricing

hasRecurringPricing_t

Boolean Indicates whether this transaction uses recurring pricing. This is used to hide the recurrence period column in the line item grid. Yes
Invoice To Party ID

invoiceToPartyID_t

Text The Party ID for the Invoice To Customer. This attribute is used when a generalized Party object is used to identify customer parties. The Invoice To Party may differ from the CRM Customer and Sold To Parties. Yes
Invoice To Party Site ID

_s_invoiceToPartySiteID_t

Text The ID for the Party Site or Address of the Invoice To party. Yes
Last Opportunity Sync

oRCL_SFA_SyncTime_t

Text The date and time on which the transaction was last synced to SFA. Yes
Last Priced

lastPricedDate_t

Date The date and time that this transaction was last re-priced. Yes
Last Updated

lastUpdatedDate_t

Date The date and time the transaction was last updated. Yes
Last Updated By

lastUpdatedBy_t

Text The person that last updated this transaction. Yes
Opportunity ID

opportunityID_t

Text The identifier of the parent opportunity. Yes
Opportunity Name

opportunityName_t

Text The name of the parent opportunity. Yes
Opportunity Number

opportunityNumber_t

Text The user or public identifier for the opportunity associated to this transaction. Yes
Opportunity Win/Loss Status

oRCL_SFA_Status_t

Text The current status of this transaction as it relates to SFA. This will differ from the other statuses of the transaction. The mapping of SFA status values to the statuses used in CPQ Cloud is administered in the Status data table. Yes
Order Date

orderDate_t

Date The date and time the order was placed for fulfillment. Yes
Order ID

oRCL_ERP_OrderID_t

Text The Order ID assigned by the external ERP system to this transaction. Yes
Order Key

orderKey_t

Text Value that uniquely identifies the sales order. Yes
Order Number

oRCL_ERP_OrderNumber_t

Text The order number assigned by the external Order Management and ERP system. Yes
Ordered By

orderPlacedBy_t

Text Records the Current User when the Create Order Action is triggered Yes
Owner

owner_t

Text The person that owns this transaction. Yes
Owner Resource Party ID

oRCL_SFA_OwnerResourcePartyID_t

Text The SFA Party ID for the person owning this transaction. Yes
Partial Ship Allowed

oRCL_ERP_PartialShipAllowed_t

Boolean Indicates whether partial shipment of the requested quantity is acceptable to the customer. Yes
Partial Ship Allowed Flag

partialShipAllowedFlag_t

Boolean Indicates whether partial shipment of the requested quantity is acceptable to the customer. Yes
Partner Transaction ID

oRCL_SFA_TransactionID_t

Text The ID generated by SFA to identify this transaction. Yes
Payment Terms

paymentTerms_t

Menu The payment terms the customer will receive on their invoice. Yes
PO Number

purchaseOrderNumber_t

Text The purchase order number provided by the customer. Yes
Price Expiration Date

priceExpirationDate_t

Date The date the price quote will expire. Yes
Price Score

priceScore_t

Integer The total calculated price score for this transaction, based on an average weighted price score on each line based upon total Contract Value at List price. Yes
Price Type

priceType_t

Menu Indicates whether the amount on this transaction is charged once or periodically. Yes
Price Within Policy

priceWithinPolicy_t

Boolean Indicates whether the prices in this transaction are all within their discount authority. Yes
Primary Flag

primaryFlag_t

Boolean Indicates that this quote is used as the basis for updating revenues on an associated opportunity. Yes
Primary Org ID

oRCL_SFA_PrimaryOrgID_t

Text The primary organization in SFA associated with this transaction or owner. Yes
Proposal Exists

proposalExists_t

Boolean Indicates whether the transaction has Proposal Document that can be viewed within the CRM or other integrated system. Yes
Reject Explanation

rejectExplanation_t

Text Area A detailed, free-form explanation of why the customer rejected the deal. Yes
Reject Reason

rejectReason_t

Menu The reason expressed by customer for rejecting this deal. The reason is selected by the sales user from a list of standard values for the site. Yes
Renew Draft Subscription Number

renewDraftSubscriptionNumber_t

 

Text

Subscription Management contract ID for the draft subscription used in the renewal process.

Yes

Renewal Error Email Address

renewalErrorEmailAddress_t

Text The email address to be used to report an error in the automated renewal process. A distribution list email should be used if a department or group is to be notified. Yes
Renewal Process

renewalProcess_t

Menu The renewal process to be followed for a subscription billing-related transaction (i.e. automatic, manual, etc.). For non-subscription billing-related transactions, this value will be null. Yes
Renewal Process Used

renewalProcessUsed_t

Menu The renewal process used in creating this subscription billing-related transaction. Yes
Require Approval If Checked

requireApprovalIfChecked_temporary_t

Boolean This attribute is exposed only to the Administrator to assist in debugging of approval flows. Checking and unchecking the attribute allows the Administrator to more easily test flows requiring or not requiring approvals. Yes
Revenue Category

_revenueCategory_t

Revenue Category Identifies the category of revenue for this sales transaction (E.g. renewal vs new business). Yes
Sales Channel

salesChannel_t

Menu The channel that originated the transaction. Yes
Ship To Party ID

_s_shipToPartyID_t

Text The Party ID for the Ship To Customer. This attribute is used when a generalized Party object is used to identify customer parties. The Invoice To Party may differ from the CRM Customer, Sold To, and Invoice To Parties. Yes
Ship To Party Site ID

_s_shipToPartySiteID_t

Text The ID for the Party Site or Address of the Ship To party. Yes
Sold To Customer Account ID

_s_soldToCustomerAccountID_t

Text The unique internal identifier for the Sold To Customer Account used for credit checking and collections. The Sold To Customer Account is typically mastered in an external ERP or Financials system and referenced when CPQ integrates sales orders to these systems. A Sold To Customer Account is typically associated to a Bill To address but may be associated with more than one. Yes
Sold To Party ID

_s_soldToPartyID_t

Text The Party ID for the Sold To Party / ERP Customer. This attribute is used when a generalized Party object is used to identify customer parties. The Sold To Party / ERP Customer may differ from the CRM Customer Party. Yes
Sold To Party Site ID

_s_soldToPartySiteID_t

Text The ID for the Party Site or Address of the Sold To party. Yes
Status

status_t

Menu The most advanced milestone reached by lines of this transaction. Yes
Subscription ID

_s_subscriptionId_t

Text The identifier of the subscription contract. Yes
Subscription Status

subscription_Status_t

Text The status of the subscription order Yes
Subscription Profile Id

subscriptionProfileId_t

Text Customer subscription profile identifier to be used in subscription management to specify subscription contract preferences. Yes
Total (List)

totalOneTimeListAmount_t

Currency The total of all one-time charges on the lines. Yes
Total (List) Per Month

totalMonthlyListAmount_t

Currency The total of all monthly recurring list amounts on the lines. Yes
Total (Net)

totalOneTimeNetAmount_t

Currency The total one time net charge. Yes
Total (Net) Per Month

totalMonthlyNetAmount_t

Currency The total of all monthly recurring net amounts on the lines. Yes
Total Contract Cost

totalContractCostAmount_t

Currency The total of all contract extended costs for this transaction over the duration of the contract, including all one-time and recurring costs. Yes
Total Contract Discount

totalContractDiscount_t

Currency The total discount on this transaction including discounts on all one-time, recurring and shipping charges for the duration of the contract. Yes
Total Contract Margin

totalContractMarginAmount_t

Currency The total of all contract extended margins for this transaction over the duration of the contract, including all one-time and recurring values. Yes
Total Contract Value (List)

totalContractListValue_t

Currency The total of all contract extended values at list price for this transaction over the duration of the contract, including all one-time and recurring pricing. Equal to the Transaction Total (List). Yes
Total Contract Value (Net)

totalContractValue_t

Currency The total value of this transaction including all one-time, recurring and shipping charges over the duration of the contract. Yes
Total Discount

totalOneTimeDiscount_t

Currency The total of all extended discount amounts for one time pricing/charges. Yes
Total Discount %

transactionTotalDiscountPercent_t

Float The percentage of the Total Transaction (List) that is discounted off of the transaction. One-time and recurring pricing for the specified contract duration are included. Yes
Total Discount Per Month

totalMonthlyDiscount_t

Currency The total of discounts off monthly recurring charges. Yes
Total Monthly Cost

totalMonthlyCostAmount_t

Currency The total of extended costs for all monthly recurring charges for the transaction. This is the total cost incurred each month. Yes
Total Monthly Margin

totalMonthlyMarginAmount_t

Currency The total of extended margins for all monthly recurring charges for the transaction. Yes
Total MUR (Net)

totalMonthlyUsageRev_t

Currency The total of all monthly usage revenues net of all discounts for this transaction. Yes
Total One-Time Cost

totalOneTimeCostAmount_t

Currency The total of extended costs for all one-time charges for the transaction. Yes
Total One-Time Margin

totalOneTimeMarginAmount_t

Currency The total of extended margins for all one-time charges for the transaction. Yes
Total Recurring Revenue (Net)

totalRecurRevenue_t

Currency The total recurring revenues net of all discounts for this transaction. Yes
Total Transaction Margin %

transactionMarginPercent_t

Float The percentage of the total list price for which this transaction's margin accounts. Yes
Total Usage Revenue (Net)

totalUsageRevenue_t

Currency The total usage revenues net of all discounts for this transaction. Yes
Transaction Description

transactionDescription_t

Text Description of the CPQ Transaction. Yes
Transaction Internal ID

bs_id

Text Current Unique Buy-side ID. This is the internal identifier for a transaction within a CPQ site. Yes
Transaction Name

transactionName_t

Text Attribute which captures the user entered Transaction Name Yes
Transaction Number

transactionID_t

Text The number or public unique identifier of the transaction. Yes
Transaction Source System

transactionSourceSystem_t

Text The code used to identify CPQ as the source for this transaction. Yes
Transaction Total (Net)

_transaction_total

Currency The Transaction Total. The total value of this transaction including all one-time, recurring and shipping charges over the duration of the contract. Synonymous with the Total Contract Value. Yes
Transaction Version User Key

userKey_t

Text The transaction ID and version number concatenated together to make a single user key value or Number that uniquely identifies this transaction version. Yes
Trigger Update Asset for Line Status

triggerUpdateAssetForLineStatus_t

Text List of line.status_l values which indicate that line has finished processing on FOM and is ready to move to asset in CPQ(pending other line’s status within same root). Yes
Version

version_t

Integer The transaction ID combined with the version number are the unique key for the document. When a transaction is versioned this number is incremented. This is the Commerce Process-defined Version that defaults to the CPQ-Platform-created Version Number (version_number_versionTransaction). Yes
Win/Loss Status

winLossStatus_t

Menu The determining status of whether the transaction represents a won or a lost sale. This can be used in Deal Management analysis. Yes

ClosedStandard Process Transaction Attribute Sets

Customer Attributes (Additional Address Set)

Name

Variable Name

Type

Description

Customer First Name

_customer_t_first_name

Text

First Name of the contact person for the buying organization linked from the CRM System. This is functionally equivalent to the Sold To contact information linked from the ERP System.

Customer Last Name

_customer_t_last_name

Text

Last Name of the contact person for the buying organization linked from the CRM System. This is functionally equivalent to the Sold To contact information linked from the ERP System.

Customer Company Name

_customer_t_company_name

Text

Company Name of the buying organization for this transaction linked from the CRM System. This is functionally equivalent to the Sold To company.

Customer Company Name 2

_customer_t_company_name_2

Text

Secondary Company Name of the buying organization for this transaction linked from the CRM System. This is functionally equivalent to the Sold To company.

Customer Address

_customer_t_address

Text

First Line for the Address of the buying organization for this transaction linked from the CRM System. This is functionally equivalent to the Sold To company.

Customer Address 2

_customer_t_address_2

Text

Second Line for the Address of the buying organization for this transaction linked from the CRM System. This is functionally equivalent to the Sold To company.

Customer City

_customer_t_city

Text

City of the buying organization for this transaction linked from the CRM System. This is functionally equivalent to the Sold To company.

Customer State

_customer_t_state

State

State or Province of the buying organization for this transaction linked from the CRM System. This is functionally equivalent to the Sold To company.

Customer Zip

_customer_t_zip

Zip

Zip Code of the buying organization for this transaction linked from the CRM System. This is functionally equivalent to the Sold To company.

Customer Country

_customer_t_country

Country

Country of the buying organization for this transaction linked from the CRM System. This is functionally equivalent to the Sold To company.

Customer Phone

_customer_t_phone

Phone

Phone Number for the contact person for the buying organization linked from the CRM System. This is functionally equivalent to the Sold To contact information linked from the ERP System.

Customer Fax

_customer_t_fax

Phone

Fax Number for the contact person for the buying organization linked from the CRM System. This is functionally equivalent to the Sold To contact information linked from the ERP System.

Customer Email

_customer_t_email

Text

Email Address of the contact person for the buying organization linked from the CRM System. This is functionally equivalent to the Sold To contact information linked from the ERP System.

Invoice To Attributes (Additional Address Set)

  Name

  Variable Name

  Type

  Description

Invoice To First Name

_invoiceTo_t_first_name

Text

First Name of the contact person for the organization being billed for this transaction.

Invoice To Last Name

_invoiceTo_t_last_name

Text

Last Name of the contact person for the organization being billed for this transaction.

Invoice To Company Name

_invoiceTo_t_company_name

Text

Company Name of the organization being billed for this transaction.

Invoice To Company Name 2

_invoiceTo_t_company_name_2

Text

Secondary Company Name of the organization being billed for this transaction.

Invoice To Address

_invoiceTo_t_address

Text

First Line for the Address of the organization being billed for this transaction.

Invoice To Address 2

_invoiceTo_t_address_2

Text

Second Line for the Address of the organization being billed for this transaction.

Invoice To City

_invoiceTo_t_city

Text

City of the organization being billed for this transaction.

Invoice To State

_invoiceTo_t_state

State

State or Province of the organization being billed for this transaction.

Invoice To Zip

_invoiceTo_t_zip

Zip

Zip Code of the organization being billed for this transaction.

Invoice To Country

_invoiceTo_t_country

Country

Country of the organization being billed for this transaction.

Invoice To Phone

_invoiceTo_t_phone

Phone

Phone Number for the contact person for the organization being billed for this transaction.

Invoice To Fax

_invoiceTo_t_fax

Phone

Fax Number for the contact person for the organization being billed for this transaction.

Invoice To Email

_invoiceTo_t_email

Text

Email Address of the contact person for the organization being billed for this transaction.

Invoice To Attributes (Additional Address Set)

  Name

  Variable Name

  Type

  Description

Ship To First Name

_shipTo_t_first_name

Text

First Name of the contact person for the organization to which this order will be shipped.

Ship To Last Name

_shipTo_t_last_name

Text

Last Name of the contact person for the organization to which this order will be shipped.

Ship To Company Name

_shipTo_t_company_name

Text

Company Name of the organization where this transaction will be shipped.

Ship To Company Name 2

_shipTo_t_company_name_2

Text

Secondary Company Name of the organization where this transaction will be shipped.

Ship To Address

_shipTo_t_address

Text

First Line of the Address of the organization where this transaction will be shipped.

Ship To Address 2

_shipTo_t_address_2

Text

Second Line of the Address of the organization where this transaction will be shipped.

Ship To City

_shipTo_t_city

Text

City of the organization where this transaction will be shipped.

Ship To State

_shipTo_t_state

State

State or Province of the organization where this transaction will be shipped.

Ship To Zip

_shipTo_t_zip

Zip

Zip Code of the organization where this transaction will be shipped.

Ship To Country

_shipTo_t_country

Country

Country of the organization where this transaction will be shipped.

Ship To Phone

_shipTo_t_phone

Phone

Phone Number for the contact person for the organization to which this order will be shipped.

Ship To Fax

_shipTo_t_fax

Phone

Fax Number for the contact person for the organization to which this order will be shipped.

Ship To Email

_shipTo_t_email

Text

Email Address for the contact person for the organization to which this order will be shipped.

Ship To Attributes (Additional Address Set)

  Name

  Variable Name

  Type

  Description

Ship To First Name

_shipTo_t_first_name

Text

First Name of the contact person for the organization to which this order will be shipped.

Ship To Last Name

_shipTo_t_last_name

Text

Last Name of the contact person for the organization to which this order will be shipped.

Ship To Company Name

_shipTo_t_company_name

Text

Company Name of the organization where this transaction will be shipped.

Ship To Company Name 2

_shipTo_t_company_name_2

Text

Secondary Company Name of the organization where this transaction will be shipped.

Ship To Address

_shipTo_t_address

Text

First Line of the Address of the organization where this transaction will be shipped.

Ship To Address 2

_shipTo_t_address_2

Text

Second Line of the Address of the organization where this transaction will be shipped.

Ship To City

_shipTo_t_city

Text

City of the organization where this transaction will be shipped.

Ship To State

_shipTo_t_state

State

State or Province of the organization where this transaction will be shipped.

Ship To Zip

_shipTo_t_zip

Zip

Zip Code of the organization where this transaction will be shipped.

Ship To Country

_shipTo_t_country

Country

Country of the organization where this transaction will be shipped.

Ship To Phone

_shipTo_t_phone

Phone

Phone Number for the contact person for the organization to which this order will be shipped.

Ship To Fax

_shipTo_t_fax

Phone

Fax Number for the contact person for the organization to which this order will be shipped.

Ship To Email

_shipTo_t_email

Text

Email Address for the contact person for the organization to which this order will be shipped.

Sold To Attributes (Additional Address Set)

  Name

  Variable Name

  Type

  Description

Sold To First Name

_soldTo_t_first_name

Text

First Name of the contact person for the buying organization linked from the ERP System. This is functionally equivalent to the Customer contact information linked from the CRM System.

Sold To Last Name

_soldTo_t_last_name

Text

Last Name of the contact person for the buying organization linked from the ERP System. This is functionally equivalent to the Customer contact information linked from the CRM System.

Sold To Company Name

_soldTo_t_company_name

Text

Company Name of the buying organization for this transaction linked from the ERP System. This is functionally equivalent to the Customer contact information.

Sold To Company Name 2

_soldTo_t_company_name_2

Text

Secondary Company Name of the buying organization for this transaction linked from the ERP System. This is functionally equivalent to the Customer contact information.

Sold To Address

_soldTo_t_address

Text

First Line of the Address of the buying organization for this transaction linked from the ERP System. This is functionally equivalent to the Customer contact information.

Sold To Address 2

_soldTo_t_address_2

Text

Second Line of the Address of the buying organization for this transaction linked from the ERP System. This is functionally equivalent to the Customer contact information.

Sold To City

_soldTo_t_city

Text

City of the buying organization for this transaction linked from the ERP System. This is functionally equivalent to the Customer contact information.

Sold To State

_soldTo_t_state

State

State or Province of the buying organization for this transaction linked from the ERP System. This is functionally equivalent to the Customer contact information.

Sold To Zip

_soldTo_t_zip

Zip

Zip Code of the buying organization for this transaction linked from the ERP System. This is functionally equivalent to the Customer contact information.

Sold To Country

_soldTo_t_country

Country

Country of the buying organization for this transaction linked from the ERP System. This is functionally equivalent to the Customer contact information.

Sold To Phone

_soldTo_t_phone

Phone

Phone Number for the contact person for the buying organization linked from the ERP System. This is functionally equivalent to the Customer contact information linked from the CRM System.

Sold To Fax

_soldTo_t_fax

Phone

Fax Number for the contact person for the buying organization linked from the ERP System. This is functionally equivalent to the Customer contact information linked from the CRM System.

Sold To Email

_soldTo_t_email

Text

Email Address for the contact person for the buying organization linked from the ERP System. This is functionally equivalent to the Customer contact information linked from the CRM System.

Submit Attributes (Submit Attribute Set)

  Name

  Variable Name

  Type

  Description

My Approval [Submit]

approve_reject_icon_submit_t

Text

This attribute lists all approval currently pending for current logged in user. This is not available as rule input.

Approval Status [Submit]

approval_status_submit_t

Text Area

This attribute lists all currently pending active approvals for a transaction.

Approval History [Submit]

approval_history_submit_t

Text Area

This attribute records approval history of a transaction. If a reason is reset, it is erased from the approval history.

Approval Revision [Submit]

approval_revision_submit_t

Integer

This attribute tracks the number of times a quote has been revised

Remote Approval Process Id [Submit]

_remote_approval_id_submit_t

Text

This attribute stores the corresponding process id in the remote approval system

Version Transaction Version Attributes (Version Attribute Set)

  Name

  Variable Name

  Type

  Description

Version Number

version_number_versionTransaction_t

Text

This Attribute Lists the Version Number for a document.

Parent Transaction Id [Version Transaction]

parent_transaction_id_versionTransaction_t

Text

This Attribute contains the parent transaction id.

eSignature Attribute Set eSignature (Attributes eSignature Set)

  Name

  Variable Name

  Type

  Description

eSignature File Attachment [eSignature Attribute Set]

_eSignatureAttributeSet_esig_file_attachment

File Attachment

The File Attachment attribute holds the documents to be sent to the eSignature Vendor

eSignature Recipients [eSignature Attribute Set]

_eSignatureAttributeSet_esig_recipients

Text Area

The Recipients holds the emails and names of the intended recipients

eSignature Date Modified [eSignature Attribute Set]

_eSignatureAttributeSet_esig_date_modified

Date

The Date Modified field contains the date of the most recently performed action on this document

eSignature Envelope ID [eSignature Attribute Set]

_eSignatureAttributeSet_esig_envelope_id

Text

The Envelope ID is a hidden field that is sent along with the document to the eSignature Vendor

eSignature Status [eSignature Attribute Set]

_eSignatureAttributeSet_esig_status

Menu

The Status field contains the current status of this document


ClosedTransaction Line Attributes

Name Variable Name Type   Description Standard Component
Action Code

oRCL_ABO_ActionCode_l

Menu Indicates the changes required by the transaction line. Yes
Amount (Discount)

discountAmount_l

Currency The discount amount for this line. Yes
Amount (List)

listAmount_l

Currency The extended list amount for this line. Yes
Amount (Net)

netAmount_l

Currency The extended list amount minus any discounts for this line. Yes
Annual Cost

annualCost_l

Currency The extended cost for recurring pricing on this transaction line. Yes
Annual Discount

annualDiscount_l

Currency The annual discount on the recurring charges on this line. Yes
Annual Margin

annualMargin_l

Currency The extended margin for recurring pricing on this transaction line. Yes
Annual Value (List)

annualListValue_l

Currency The extended value at list price for recurring pricing on this transaction line over the duration of the contracted periods. Yes
Annual Value (Net)

annualValue_l

Currency The annual contract value of the recurring charges on this line. Yes
Associated Line Id

associatedLineId_l

Text Document number to be associated with the subscription line. Yes
Associated Order Id

associatedOrderId_l

Text Source order Id associated with the subscription line Yes

Available Rate Plans

_availableRatePlans

Menu This menu attribute is populated with the list of available rate plans. Yes
Cancel Reason

cancelReason_l

Menu The reason why the customer canceled this line. Yes
Change Code

changeCode_l

Menu A single select menu to handle all the possible codes to close a subscription. Yes
Change Reason

changeReason_l

Menu A single select menu to handle all the possible reasons for closing a subscription. Yes
Charge Set Control

_chargeSetControl

Integer   Yes
Component Attributes

oRCL_ABO_ComponentAttributes_l

Text Area A comma separated collection of key / value pair attributes that define the configuration of this asset / component plus an action code indicating whether the attribute has changed. Yes
Config Extra Info

_config_extra_info

Text Area Configuration Extra Information. Yes
Configuration ID

_configuration_id

Text Configuration id for integrations. Yes
Contract Cost

contractCost_l

Currency The total of all contract extended costs for this line, including one-time and recurring costs. Yes
Contract Discount

contractDiscount_l

Currency The total discount of this line including all one-time and recurring charges. Yes
Contract End Date

contractEndDate_l

Date Date that the customer stops to receive the service. Yes
Contract Margin

contractMargin_l

Currency The total of all contract extended margins for this line, including one-time and recurring values. Yes
Contract Start Date

contractStartDate_l

Date Date that the customer starts to receive the service. Yes
Contract Value (List Rollup)

contractListValueRollup_l

Currency Contract list value on this line or for the root model lines, the sum of all contract list values for all the child lines. Yes
Contract Value (List)

contractListValue_l

Currency The total of all contract list value of this line, including all one-time and recurring charges. Yes
Contract Value (Net Rollup)

contractValueRollup_l

Currency Contract value on this line or for the root model lines, the sum of all contract revenues for all the child lines. Yes
Contract Value (Net Summable)

contractValue_l

Currency The total contract value of this line including all one-time and recurring charges. Yes
Contracted Periods

contractedPeriods_l

Integer Number of periods the customer has contracted to receive the item. Yes
Contracted Periods (Rollup)

contractedPeriodsRollup_l

Integer Number of periods the customer has contracted to receive the item or for the root model rolled up to include all child values. Yes
Cost Amount

costAmount_l

Currency The total cost of this line. Yes
Coverage Line Number

_s_coverageLineNumber

Text Source line number of the coverage line for OM Integration. Yes
Coverage Line Number

_s_coverageLineNumber

Text Source line number of the coverage line for OM Integration. Yes
Coverage Order Number

_s_coverageOrderNumber

Text Source order number of the coverage line for OM Integration. Yes
Coverage Order Number

_s_coverageOrderNumber

Text Source order number of the coverage line for OM Integration. Yes
Created By

createdBy_l

Text The person that created the transaction line. Yes
Created Date

createdDate_l

Date The date when the transaction line was created. Yes
Custom Discount Amount

customDiscountAmount_l

Currency The amount by which to adjust the list price because of a custom discount. Yes
Discount

customDiscountValue_l

Float Used to capture the numeric value associated with the discount type. This might be an override price, amount off or percentage. Yes
Discount %

discountPercent_l

Float The percentage of the Contract Value (List) that is discounted off of the transaction line. Yes
Discount Percent (Rollup)

discountPercentRollup_l

Float The percentage of the Contract Value (List) that is discounted off of the transaction line or for the root model rolled up to include all child values. Yes
Discount Type

customDiscountType_l

Menu The type of custom discount to apply to this line. Yes
Document Number

documentNumber_l

Text Document number of the line. Yes
Fulfillment Line Id

fulfillmentLineId_l

Text Value that uniquely identifies the fulfillment line. Yes
Fulfillment Organization Code

fulfillmentOrganizationCode_l

Text Abbreviation that identifies the organization that ships the shipment. Yes
Fulfillment Status

fulfillmentStatus_l

Menu The status for this line supplied by the fulfillment system after the transaction is submitted as a sales order. Yes
Group Sequence Number

_group_sequence_number

Group Sequence Number Attribute Group sequence number for the sub-document. Yes
Instance ID

itemInstanceId_l

Text The unique, invariant, internal identifier of this instance of a product. It is used to link sales order lines to the assets they change in an asset based order and as the key stored in a sales order line association. This ID is assigned when the product instance is created in either an external federated asset repository or in CPQ when a sales order line is created. Yes
Instance Name

itemInstanceName_l

Text The public identifier of the instance of a product. For goods this is typically the serial #. For services it might be another identifier such as the telephone #. This does not have to be unique across all product instances (e.g. a cell phone # may be reallocated over time). It is one of the primary attributes for searching for a product instance. Yes
Inventory Item ID

oRCL_SFA_InventoryItemID_l

Text The inventory item id of the sales product in SFA. Yes

Is Coverage Product

_is_coverage

Boolean Indicates whether the product is of coverage type Yes
Last Updated

lastUpdatedDate_l

Date The date and time the transaction line was last updated. Yes
Last Updated By

lastUpdatedBy_l

Text The person that last updated this transaction line. Yes
Line BOM Effective Date

_line_bom_effective_date

Date System attribute to be stored in model line effective date to drive date effectivity in all BOM mappings. Yes
Line BOM Item Quantity

_line_bom_item_quantity

Integer The BOM item line quantity. This is the unexploded line quantity, whereas _price_quantity stores the exploded quantity. Yes
Line BOM Level

_line_bom_level

Integer The BOM item depth (level) in the quote. Yes
Line BOM Name

_line_bom_name

Text The name of the BOM item Yes
Line BOM Part Number

_line_bom_part_number

Text The part number of the BOM item. Only applicable to the model line. Yes
Line BOM Variable Name

_line_bom_variable_name

Text The variable name of the BOM item Yes
Line Display Name

_line_display_name

Text Display name attribute for line items. Yes
Line Item BOM Attributes

_line_bom_attributes

Text Area BOM attributes, stored as a JSON string. Yes
Line Item BOM ID

_line_bom_id

Text The BOM item instance id. Yes
Line Item Type

_line_item_type

Text Type attribute for line items. Yes
Line Number

lineNumber_l

Integer Line number in a line item grid is a sequential number assigned to each row or line of the grid. This is used to sort lines on the screen and in documents. Yes
Line Type

lineType_l

Menu The type of a transaction line whether it represents a model or a part. Yes
List Price (Rollup)

listPriceRollup_l

Currency The list price of the item or for the root model rolled up to include all child values. Yes
Margin

unitMargin_l

Currency The margin for a single unit of this transaction line. Yes
Margin %

marginPercent_l

Float The percentage of the List price for which this transaction line's margin accounts. Yes
Margin Amount

marginAmount_l

Currency The margin for all quoted units of this transaction line. Yes
MRR (Rollup)

monthlyRecurRevRollup_l

Currency Monthly recurring revenue on this line or for the root model lines, the sum of monthly recurring revenues for all the child lines. Yes
MRR (Summable)

monthlyRecurRevSummable_l

Currency Monthly recurring revenues net of all discounts for this line. Yes
MUR (Rollup)

monthlyUsageRevRollup_l

Currency Monthly usage revenue on this line or for the root model lines, the sum of monthly usage revenues for all the child lines. Yes
MUR (Summable)

monthlyUsageRevSummable_l

Currency Monthly usage revenues net of all discounts for this line. Yes
Net Amount (Rollup)

netAmountRollup_l

Currency The extended list amount minus any discounts for this line or for the root model rolled up to include all child values. Yes
Net Price (Rollup)

netPriceRollup_l

Currency The price paid by the customer for the individual item or for the root model rolled up to include all child values. Yes
Non-Recurring Revenue (Rollup)

nonRecurRevRollup_l

Currency One-time revenue on this line or for the root model lines, the sum of one-time revenues for all the child lines. Yes
Non-Recurring Revenue (Summable)

nonRecurRevSummable_l

Currency One-time revenue net of all discounts for this line. Yes
Opportunity Win/Loss Status (Line)

oRCL_SFA_Status_l

Text The SFA status of the transaction line. This value may differ from the transaction status for CPQ. Initially, there is no internal logic setting this value. Yes
Order Date

orderDate_l

Date The date and time the order was placed for fulfillment. Yes
Order Number

oRCL_ERP_OrderNumber_l

Text The order number assigned by the external Order Management and ERP system. Yes
Owner Resource ID

ownerResourceId_l

Text The owner of the associated Opportunity Revenue Line. Yes
Parent Asset Key

parentAssetKey_l

Text The identifier for the corresponding parent asset in an external asset repository. Used only for asset-related lines. Yes
Parent Doc Number

parentDocNumber_l

Text Document number of the parent line item. Yes
Parent Line Item BOM ID

_line_bom_parent_id

Text The parent BOM item instance id. Yes
Part ID

_s_partID_l

Text Part number from the Items table. Yes
Partner Organization ID

oRCL_SFA_InventoryOrgID_l

Text The inventory organization in SFA used for sales products. Yes
Payment Terms

paymentTerms_l

Menu Payment terms to apply to collect payment. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Receivables Payment Terms task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source. Yes
Period

pricePeriod_l

Menu The period of service purchased at this price. Yes
Price (List)

listPrice_l

Currency The list price of the item. Yes
Price (Net)

netPrice_l

Currency The price paid by the customer for the item. Yes
Price Recurrence Frequency

priceRecurFrequency_l

Menu The periodicity or frequency of this pricing. Derived from the pricePeriod_l. Yes
Price Recurrence Frequency (Rollup)

priceRecurFrequencyRollup_l

Menu The periodicity or frequency of this pricing or for the root model rolled up to include all child values. Yes
Price Score

priceScore_l

Integer The calculated price score for this transaction line, based on the line item's List and Net pricing. Yes
Price Type

priceType_l

Menu Indicates whether the amount on this line is charged once or periodically. Yes
Price Type (Rollup)

priceTypeRollup_l

Menu Indicates whether the amount on this line is charged once or periodically. For Root model lines, this will represent a rollup of values for all child lines. Yes
Price Within Policy

priceWithinPolicy_l

Boolean Flag which indicates if line price is within requesting user's defined pricing limits Yes
Recurring Revenue (Rollup)

recurRevRollup_l

Currency Recurring revenue on this line or for the root model lines, the sum of recurring revenues for all the child lines. Yes
Recurring Revenue (Summable)

recurringRevSummable_l

Currency Recurring revenue net of all discounts for this line. Yes
Renew Date

renewDate_l

Date Renewal date of a subscription service. Yes
Request Date

requestDate_l

Date The date on which the user requests that fulfillment occur for this transaction line. Yes
Request Ship Date

requestShipDate_l

Date The requested ship date for the order line. Yes
Resume Date

resumeDate_l

Date Resuming date of a subscription service Yes
Rollup Flag

rollupFlag_l

Boolean Specifies a charge component as a rollup value or aggregate value for the element code of the charge component price. Yes
Root Line

rootLine_l

Menu Indicates whether the line is a root line. Root lines include only root model lines and standalone part lines. Yes
RootAssetKey

rootAssetKey_l

Text   Yes
Sales Channel

salesChannel_l

Menu   Yes
Sequence Number

_sequence_number

Sequence Number Attribute Sequence number for the sub-document. Yes
Status

status_l

Menu The status of this line. Yes
Subscription Id

subscriptionId_l

Text The unique identifier for the subscription. Used only for subscription billing-related transactions. Yes
Subscription Line Id

subscriptionLineId_l

Text The unique identifier for the subscription line. Used only for subscription billing-related transactions. Yes
Suspend Date

suspendDate_l

Date Suspension date of a subscription service Yes
Transaction Internal ID

transactionID_l

Text The parent transaction's internal ID. Yes
Transaction Line ID

_transactionLine_id

Text Unique identifier for this sub-document. Similar to the existing BS_ID for transactions, the Transaction Line ID uniquely identifies a line item across transactions for a given Commerce Process. Yes
Transaction Line ID

_s_transactionLineId_l

Text A unique identifier for transaction line. Yes
Unit Cost

unitCost_l

Currency The unit cost of the item. Yes
Unit of Measure

requestedUnitOfMeasure_l

Menu The unit of measure of the item requested by the customer (e.g. "Each"). Yes
Usage Revenue (Rollup)

usageRevRollup_l

Currency Usage revenue on this line or for the root model lines, the sum of usage revenues for all the child lines. Yes
Usage Revenue (Summable)

usageRevSummable_l

Currency Usage revenue net of all discounts for this line. Yes
Win/Loss Status

winLossStatus_l

Menu The determining status of whether the transaction line represents a won or a lost sale. This can be used in Deal Management analysis. Yes

ClosedTransaction Line Array & Attribute Sets

Available Rate Plan Set

The Available Rate Plan Set array set captures the list of Rate Plans for a given product.

  Name

  Variable Name

  Type

  Description

Available Rate Plan Name

_availableRatePlanSet_rate_plan_name

Text

The name of the Rate Plan

Available Rate Plan Number

_availableRatePlanSet_rate_plan_number

Text

The number of the Rate Plan

Available Rate Plan Integration Id

_availableRatePlanSet_rate_plan_integration_id

Text

The Integration ID for the Rate Plan

Charge Array Set

The Transaction Line Charge Array Set allows customers to synchronize the pricing charge schema with Commerce to enable multiple charges for transaction line items. The pricing charge schema is defined by standard and extensible custom charge attributes. The Synchronize Charge Array Set action allows administrators to synchronize the Transaction Line Charge Array Set with the pricing charge schema. The Charge Array Set contains the following read-only attributes:

Name Variable Name Type Description

Calculation Information

_chargeSet_calculationInfo

Text Area

A JSON array of the Price Models used in calculating this charge's price.

Charge Definition

_chargeSet_chargeDefinition

Text

The display label of the charge definition.

Charge Definition Code

_chargeSet_chargeDefinitionCode

Text

The code of the charge definition.

Charge Definition Integration ID

_chargeSet_chargeDefinitionIntegrationId

Text

The charge definition code in the integrated order management system.

Charge Type

_chargeSet_chargeType

Menu

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').

Discount Amount

_chargeSet_discountAmount

Currency

The extended custom discount amount per period for this charge.

Discount Type

_chargeSet_discountType

Menu

The type of custom discount applied to this charge. Typically this may be an override price, a discount value, or a discount percentage.

Discount Value

_chargeSet_discountValue

Float

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 unit price for this charge.

Net Amount

_chargeSet_netAmount

Currency

The extended net price or amount per period that will be paid for this charge.

Net Price

_chargeSet_netPrice

Currency

The unit price net of all discounts for this charge. The Net Price is the unit price that the customer will be invoiced.

Price Period

_chargeSet_pricePeriod

Menu

The time period, frequency, or recurrence with which the price or charge is levied.

Price Type

_chargeSet_priceType

Menu

The basis on which a price or charge is levied, whether one time, on a periodic basis or based on usage.

Rate Card

_chargeSet_rateCard

String

Display label for the Rate Card applied in calculating this charge's price.

Rate Card in HTML

_chargeSet_rateCardinHTML

Text Area

The HTML-formatted rate card data.

Rate Card Structure

_chargeSet_rateCardStructure

Text Area

The rate card used to calculate this charge's price.

Rate Card Variable Name

_chargeSet_rateCardVariableName

String

Variable Name for the Rate Card applied in calculating this charge's price.

Unit Price

_chargeSet_unitPrice

Currency

The unit price to be paid by the customer for this charge.

Usage UOM

_chargeSet_usageUOM

Menu

The unit of measure of usage for usage charges, which may differ from the unit of measure used for the parent product.

Notes:

  • To enable multiple charges for transaction line items, refer to Synchronize Charge Array Set.
  • If the Transaction Line Charge Array Set doesn’t exist, it will be created when the Synchronize Charge Array Set action is invoked.
  • Refer to Pricing Portal > Charge Attributes for more information about pricing charge attributes.

Config Attribute Set

Configuration Attributes store the configuration parameters that were used to create this transaction. It consists of the display text and value of the attributes.

  Name

  Variable Name

  Type

  Description

Config Attributes

_config_attributes

Composite Attribute

Configurable Attribute is a composite attribute. This attribute is always read only. However Reconfigure action may be used to modify the values.

Config Attribute Text

_config_attr_text

Composite Attribute

Configurable Attribute Text format is similar Configurable Attribute. The only difference is that the values correspond to the display text of the attributes.

Config Attribute Information

_config_attr_info

Composite Attribute

Configurable Attribute Information is populated with variable name, attribute name, data type and menu type information.

Config Attribute Values

_config_attr_values

Text Area

Stores configurable attributes values in a user-friendly JSON format that are passed in from the CRM partner at the time of quote creation. These values are used as a starting point when creating quote lines from opportunity revenue lines and are not updated by subsequent reconfiguration. Usage should be limited to a small number of attributes to assure performance. Only simple configuration attribute data types are supported.

Delta Price Attribute Set

Delta Price attributes are created together and removed together. Also any delta Price attribute can be created only once in a document.

  Name

  Variable Name

  Type

  Description

Delta Price

_delta_price

Currency

Displays the price difference for the updated line item.

Prior Price

_prior_price

Currency

Displays the prior price for the updated line item.

Rollup Delta Price

_rollup_delta_price

Currency

Displays the model level price difference of all child items for the updated model.

Model Attribute Set

Model attributes are created together and removed together. Also any model attribute can be created only once in a document.

  Name

  Variable Name

  Type

  Description

Model Name

_model_name

Text

Name of the model

Model Segment Name

_model_segment_name

Text

Segment to which the model belongs

Model Segment Variable Name

_model_segment_var_name

Text

Segment to which the model belongs

Model Product Line Name

_model_product_line_name

Text

Product Line to which the model belongs

Model Product Line Attributes

_model_product_line_attributes

Composite Attribute

Product Line Attributes of Product Line to which the model belongs

Model Base Price

_model_base_price

Currency

Base price of the model

Model Attributes

_model_attributes

Composite Attribute

Placeholder for all model attributes

Model Supplier Company Name

_model_supplier_company_name

Text

Model supplier company name

Model BOM

_model_bom

Link to a Dialog Window

Model BOM Link

Model Variable Name

_model_variable_name

Text

Variable name of the model

Model Product Line Variable Name

_model_product_line_var_name

Text

Variable name of the product line that the model belongs to.

Is Model Valid

_model_is_valid

Boolean

Check if model is configured or unconfigured

Model Partner Entity Id

_model_partner_entity_id

Text

Partner entity id for the model

Model Partner Organization Id

_model_partner_organization_id

Text

partner organization id for the model

Part Attribute Set

Part attributes can be created or removed individually except the Part Number and Part Display Number. Also, any part attribute can be created only once in a document.

  Name   Variable Name   Type   Description   Standard Component
Company Associations _part_company_associations Text Area Company Associations Yes
Default UOM Code _part_default_uom Text Default unit of measure Yes
Direct Buy _part_direct_buy Text Direct Buy Yes
Drawing Position _part_drawing_position Text Drawing Position Yes
Eligible for Service _part_serv_req_enabled Text Eligible for service Yes
Eligible to Sell _part_sale_enabled Text Eligible to sell or order Yes
Enable Customer Self-Service _part_css_enabled Text Customer Self-service enabled flag Yes
External Key 1 _part_external_key1 Text External system's key Yes
External Key 2 _part_external_key2 Text External system's key Yes
Number of Price Periods _part_default_periods Text Default number of price periods Yes
Part Base Price _part_base_price Currency Price of the part Yes
Part Description _part_desc Text Area Description of the part Yes
Part Display Number _part_display_number Text Part Display Number Yes
Part Extended Description 1 _part_extended_desc_1 Link to a Dialog Window Extended description of the part Yes
Part Extended Description 2 _part_extended_desc_2 Link to a Dialog Window Extended description of the part Yes
Part Lead Time _part_lead_time Text Lead time Yes
Part Number _part_number Text Part Number Yes
Part Price Period _part_default_periodicity Text Default Price Periodicity Yes
Part Price Type _part_default_price_type Text Default Price Type Yes
Part Supplier Company Name _part_supplier_company_name Text Name of the part supplier company Yes
Part Units _part_units Text Units of the part Yes
Partner Entity Id _partner_entity_id Text Area Partner Entity Id Yes
Partner Organization Id _partner_organization_id Text Area Partner Organization Id Yes
Sales Product Type _part_sales_product_type Text ProductTypeCode Valid values comes from a lookup. E.g Goods, Included Warranty etc. Yes
Service Duration _part_service_duration Text Service Duration No *
Service Duration Period _part_service_duration_period_code Text Service Duration Period No *
Service Duration Type _part_service_duration_type_code Text Service Duration Type No *

Note: * Service Duration attributes are added to sites that are integrated with Oracle CX Sales

Price Attribute Set

Price attributes are created together and removed together. Also any price attribute can be created only once in a document.

  Name

  Variable Name

  Type

  Description

Applied Agreement Integration ID

_price_applied_agreement_integrationid

Text The integration ID for the applied price agreement
Applied Agreement Name

_price_applied_agreement_name

Text The name of the applied price agreement.
Applied Agreement Number

_price_applied_agreement_number

Text The number of the applied price agreement
Applied Rate Plan

_price_applied_ratePlan

Text The name of the applied rate plan
Applied Rate Plan Integration ID

_price_applied_ratePlan_integrationId

Text The integration ID for the applied rate plan
Applied Rate Plan Number

_price_applied_ratePlan_number

Text The number of the applied rate plan

Calculation Information

_price_calculation_info

Text Area

JSON array of aggregated calculation information returned from advanced pricing profiles

Component Prices

_price_component_prices

Composite Attribute

Additional prices based on configuration

Configurable Price

_price_configurable_price

Currency

Original price as per catalog (inclusive of discount and premium)

Item Price

_price_item_price_each

Currency

The starting price. For Parts it will be the base price or price book price. For models it may be the base model price or the pricing rule or attribute value prices.

List Price

_price_list_price_each

Currency

Will usually be the same value as the Item Price, unless a recommended item price applies.

Pricing Rule Price

_pricing_rule_price_each

Currency

Currently the customer level pricing. (Not applicable for Models)

Quantity

_price_quantity

Integer

Quantity

Unit Price

_price_unit_price_each

Currency

Will usually be the same value as the List Price, unless a contract price applies.

Prices Array Set

The Prices Array Set (oRCL_charges) is present in line level it is used to hold the prices and charges information of an item.

This array set is used in OIC mappings to generate the payload for Oracle Order Management integration. Commerce library “oRCL_fOM_populateCharges” included in the Commerce Standard Process is used to populate this array set with all the applicable charges defined for an item in the pricing portal.

  Name   Variable Name   Type   Description
Apply To

oRCL_applyTo

Text Indicates which type of price it is applied.
Charge Definition Integration ID

_s_oRCL_chargeDefIntegrationId

Text The charge definition code in the integrated order management system.
Charge Name

oRCL_chargeName

Text Name of the charges. Example Values: Sale Price, Recurring Sale Price.
Charge Type

_s_oRCL_chargeType

Text

Charge Type of the item.

Introduced in CPQ 23C. Replaced oRCL_chargeType attribute.

oRCL_chargeType

Text Removed in CPQ 23C. Replaced with _s_oRCL_chargeType.
Contract Discount Amount

oRCL_contractDiscountAmount

Float The total discount of this line including all one-time and recurring charges.
Contract List Value

oRCL_contractListValue

Float The total of all contract list value of this line, including all one-time and recurring charges.
Contract Net Value

oRCL_contractNetValue

Float The total contract value of this line including all one-time and recurring charges.
Custom Discount Amount

oRCL_customDiscountAmount

Float The type of custom discount applied to this charge. Typically this may be an override price, a discount value or a discount percentage.
Custom Discount Type

_s_oRCL_customDiscountType

Text The type of custom discount applied to this charge. Typically this may be an override price, a discount value or a discount percentage. Introduced in CPQ 23C.
Discount Amount

oRCL_discountAmount

Float The discount amount for this line.
List Amount

oRCL_listAmount

Float The extended list amount for this line.
List Price

oRCL_listPrice

Float List Price of the item.
Net Amount

oRCL_netAmount

Float The extended list amount minus any discounts for this line.
Net Price

oRCL_netPrice

Float The price paid by the customer for this item.
Price Period

_s_oRCL_pricePeriod

Text The time period, frequency or recurrence with which the price or charge is levied. Introduced in CPQ 23C.
Price Type

_s_oRCL_priceType

Text Indicates whether the amount on this line is charged once or periodically. Introduced in CPQ 23C.
Price Unit of Measure

_s_oRCL_priceUOM

Text Indicates whether the amount on this line is charged once or periodically. Introduced in CPQ 23C.
Primary Charge

oRCL_primaryCharge

Boolean Primary charge is used to determine whether the charge is primary or not.
Sequence Number

oRCL_chargeSequenceNumber

Integer Sequence number of the charges.

 

Revenue Attribute Set

Revenue Attributes store aggregate revenue values and other information used for financial analysis and forecasts.

  Name

  Variable Name

  Type

  Description

Revenue ID

_revenueId_l

Text

The ID of the Revenue Line Item in the associated opportunity.

Revenue Category

_revenueCategory_l

Menu

Identifies the category of revenue for this line (E.g. renewal vs new business).


ClosedStandard Process Actions

Commerce actions trigger events within documents to occur. Standard Process actions cannot be deleted, but the action functions can be viewed, overridden, and easily returned to their default values. The Standard Process attributes and actions come with predefined functional logic that is ready for customers' use. If required, seeded logic can be overridden by administrators to incorporate their customization logic.

Standard Process Action Overrides

To view a pre-defined function in read-only mode, click View Function.

Standard Process actions come with standard settings and values for advanced modify and the modify tab. These values and settings can also be overridden and returned to the standard values by removing the override.

Standard Process Action Modify tab

For Modify and Add from Catalog actions, the Standard Destination values and options can be overridden if desired. You can quickly return to the standard values and options by removing the override. To view the default values, check to Override Standard Destination option, and then click Apply.

Standard Process Action Destination tab

ClosedProcess Actions

  Action Name

Variable Name

  Navigation

  Type

  Description

Copy

_action_process_resubmit

Sequence List

Copy

Used to copy a process transaction

Email

_action_process_email_print

 

Email

Sends a document via email/fax

Export File Attachments

_action_export_file_attachments

 

Export File Attachments

Exports file attachments via Web Services

Forward

_action_process_forward

 

Forward

Used to forwards documents to other users

Import File Attachments

_action_import_file_attachments

 

Import File Attachments

Imports file attachments via Web Services

Move

_action_process_move

 

Move

Used to move documents between folders

New Transaction

_action_new_transaction

Access Rights

New Transaction

Used to create a new transaction with no line items

Open Transaction

_open_transaction

 

Open Document

Used to open a transaction that was previously saved to the system.

Print

_action_process_print

 

Print

Generates documents in printer friendly format

Unlock

_action_process_unlock

Access Rights

Unlock

Used to unlock all selected Transactions in a Commerce process that are locked for editing.


ClosedTransaction Actions

  Action Name

  Action Variable Name

  Type

  Description

  Related Rules

Add Line Item

addLineItem_t

Add From Catalog

Displays the Parts Search UI to enable users to add parts to the transaction.

 

Back To Transaction Manager

back_to_transactionmanager_t

Back

Navigates back to the Transaction Manager.

 

Browse

_browse_action

Browse

Action to browse for customer id

 

Cancel Order

cancelOrder

Modify

Cancels order or lines in external system.

Hide Cancel Order Button

Cancel Transaction

order_cancel

Modify

Sets the transaction status and the Commerce Step for this transaction to Canceled.

 

Change Currency

_change_currency

Change Currency

Change the currency of an existing quote. This feature is not currently supported in the BASE Reference Application but can be enabled via customization.

 

Copy Line Items

copyLineItems_t

Copy Line Items

Copies the selected transaction lines on the current transaction. Prompts the user to select how many copies of each selected line they wish to create.

 

Create Order

order_start

Modify

Creates a sales order for submission to an ERP system.

Associated Order and Line Id, Hide Create SO Action

Customer Assets

oRCL_ABO_DisplayAssets

Add From Catalog

This action is performed when Customer Assets button is clicked.

 

Customer Rejection

order_reject

Modify

Transitions the transaction to the Commerce Step 'Rejected by Customer'.

 

Get Account Details

getAccountDetails

Modify

 

 

Get SO Status from FOM

getSOStatusFromFOM

Modify

Gets Order and Line status from external system.

Hide SO Status Action

Open Transaction Line

_open_transactionLine

Open Document

Displays the Line Details for a specified transaction line.

 

Order Update

order_update

Modify

Dedicated action used by external system

 

Reconfigure

_reconfigure_action

Reconfigure

Allows the user to edit a configuration after its been added to the transaction. The functionality attached to this action will fire before moving to Configuration.

 

Reconfigure Inbound

_reconfigure_inbound_action

Reconfigure Inbound

This action is called when the user returns to the quote after editing a configuration. The functionality attached to this action won't fire until the user has returned to the transaction.

 

Refresh Address

_auto_fill_action

Auto Fill

Action to autofill address information from customer id

 

Remove Transaction Line

_remove_transactionLine

Remove

Default Remove Item Action

 

Return to SFA

oRCL_SFA_Return

Modify

Navigates the user back to the SFA opportunity (if one is associated), to the SFA Account (if no opportunity is associated but an account is), or to the SFA Sales homepage (if neither an opportunity or an account are associated to the transaction).

 

Save

cleanSave_t

Modify

Saves the current state of the transaction (which may have been edited in the UI) to the database.

Discount Percentage Validate Line Status Values for Asset Creation

Select An Alternate Address

_select_alternate_address_action

Select Address

Brings up a pop-up window with alternate account address records.

 

Submit

submit_t

Submit

Submits the transaction for approval. If no approvals are defined or triggered for the transaction, the status will move directly to the approved step.

Discount Percentage

Request Approval

request_approval_submit_t

Request For Approval

This action is performed when submit action is clicked and there is at least one reason to approve.

Discount Percentage

Reject

reject_submit_t

Reject

This action is performed when a reason is rejected by the approver.

Discount Percentage

Approve

approve_submit_t

Approve

This action is performed when a reason is approved by the approver.

Discount Percentage

Cancel Approvals

revise_submit_t

Revise

This action is performed when Revise button is clicked.

Discount Percentage

Update Asset

updateAsset

Modify

Performs asset creation in CPQ Cloud local repository and updates Fulfillment Status.

Validate Line Status Values for Asset Creation

Update Line Items

_update_line_items

Update Line Item

Default action to update Line Items

 

Update Opportunity

oRCL_SFA_UpdateOpportunity

Modify

Synchronizes the lines on the CPQ transaction to the associated SFA opportunity.

 

Version Save

versionSave_t

Modify

Special Save action for purposes of Version Transaction action.

 

Version Transaction

versionTransaction_t

Version

Creates a new version of the subject transaction and displays this new version for editing.

 

View Next Step

nextStep

Modify

This action displays the Next Step for a transaction. This action aids in debugging of modifications to Commerce Process Steps and is exposed only to administrators.

 

View Previous Step

previousStep

Modify

This action displays the Previous Step for a transaction. This action aids in debugging of modifications to Commerce Process Steps and is exposed only to administrators.

 

View...

_view_crm_action

View Account Profile

Action to view accounts information in a new window

eSignature Action Set

  Action Name

  Action Variable Name

  Action Type

  Action Description

Request Signature

_action_esig_send

eSignature Send

Use this action to send the document to recipients.

Cancel Signature Request

_action_esig_cancel

eSignature Cancel

Use this action to cancel pending signature requests.

Details

_action_esig_details

eSignature Details

Use this action to connect to Docusign and view document details

Receive

_action_esig_receive

eSignature Receive

This action is automatically invoked to receive a rejection or a signed document from the eSig Vendor.


ClosedTransaction Line Actions

  Action Name

  Action Variable Name

  Type

  Description

Back

back_l

Modify

Returns the user to the main transaction page.

Close

save_l

Modify

Saves the current state of the line item (which may have been edited in the UI) to the database and returns you to the parent page.

Create Follow-On Order

oRCL_ABO_CreateFollowOnOrder

Add From Catalog

 

Order Update Line

order_update_line

Modify

Dedicated line action used by external system

Recalculate

_calculate_price_action

Calculate Price

Applies any pricing changes made on the line to the Price Attributes.

Reconfigure

_reconfigure_action

Reconfigure

Allows the user to edit a configuration after its been added to the transaction. The functionality attached to this action will fire before moving to Configuration.

Reconfigure Inbound

_reconfigure_inbound_action

Reconfigure Inbound

Called when the user returns to the quote after editing a configuration. The functionality attached to this action won't fire until the user has returned to the transaction.

Save

saveChanges_l

Modify

Saves the current state of the line item (which may have been edited in the UI) to the database and remains in the same page.


ClosedStandard Process Rules

The Standard Process provides a converged set of generic rules sourced from existing Oracle CPQ reference applications. The Standard Process rules cannot be deleted or modified, but they can be inactivated. For Validation type rules Linked Actions can be updated.

Access Rules

  Name

Document Level

  Variable Name   Status   Condition Type   Action Type   Components to Hide   Description
Recurring Attributes (Transaction)

Transaction

recurringAttributes_t

Active Simple Simple Contracted Periods, Annual Value (Net), Annual Discount, Annual Value (List), Period Hides all totals attributes related to Recurring Pricing if no such line items exist on the quote.
Hide Create SO Action

Transaction

hideCreateSOAction

Active Advanced Simple Create Order  
Hide Cancel Order Button

Transaction

hideCancelOrderButton

Active Simple Simple Cancel Order, Cancel Reason Hides cancel order & reason when there is no order key
Hide SO Status Action

Transaction

hideSOStatusAction

Active Simple Simple Get SO Status from FOM Hides the get sales order status when there is no order key
Periodicity

Transaction Line

periodicity

Active Simple Simple Period, Contracted Periods Hides all line item columns relating to Recurring Pricing if there are no such lines on the transaction.
Hide Price Score when List Price is zero

Transaction Line

hidePriceScoreWhenListPriceIsZero

Active Simple Simple Price Score Hides Price Score when Price (List) is zero
Hide Contracted Periods Rollup

Transaction Line

_s_hideContractedPeriodsRollup

Active Simple Simple Contracted Periods (Rollup) Hide Contracted Periods (Rollup) when Price Type (Rollup) is equal to One Time.

Constraint Rules

  Name

Document Level

  Variable Name   Status   Condition Type   Action Type   Components to Constrain   Description
Contracted Periods

Transaction Line

contractedPeriods

Active Simple Simple Contracted Periods Contracted Periods must be populated and greater than 0 for Recurring and Usage pricing

Validation Rules

  Name

Document Level

  Variable Name   Status   Linked Actions   Condition Type   Action Type   Components to Validate   Description
Validate Line Status Values for Asset Creation

Transaction

validateLineStatusValuesForAssetCreation

Active Save, Update Asset Always True Simple Trigger Update Asset for Line Status Validates that the Trigger Update Asset for Line Status is not empty
Validate Line Status Values for Cancel Order

Transaction

validateLineStatusValuesForCancelOrder

Active Cancel Order Always True Simple Status Validates that Cancel Order is not allowed when Status is Awaiting Billing
Discount Percentage

Transaction Line

discountPercentage

Active Approve, Request Approval, Save, Submit Simple Simple Discount Percentage

Validates that Discount amount is <100 if discount type is "Percent Off"

Associated Order and Line Id

Transaction Line

associatedOrderAndLineId

Active Create Order Simple Simple Associate Line Id, Associate Order Id Validates that Associate Line Id & Order Id are not empty
Validate Contract End Date

Transaction Line

_s_validateContractEndDate

Active Create Order, Save Simple Simple Contract End Date

Validates that Contract End Date is not empty for subscription items

Validate Coverage Order and Line Id

Transaction Line

_s_ValidateCoverageOrderAndLineId

Active Create Order, Save Simple Simple Coverage Order Number, Coverage Line Number

Validates that a covered product is associated with the coverage service.


ClosedStandard Process Data Columns

CPQ uses Data Columns to define attributes in order to report, search or query transaction or transaction line data. The following Data Columns are provided in the Standard Process:

  Element

  Document Level

  Attribute Name

  Attribute Variable Name

  Search Label

  Report Label

Commerce Attribute

Transaction

Owner

owner_t

Owner

Owner

Commerce Attribute

Transaction

Created Date

createdDate_t

Created Date

Created Date

Commerce Attribute

Transaction

Transaction Number

transactionID_t

Transaction ID

Transaction ID

Commerce Attribute

Transaction

Customer Company Name

_customer_t_company_name

Customer Company Name

Customer Company Name

Commerce Attribute

Transaction

Last Updated

lastUpdatedDate_t

Last Updated

Last Updated

Commerce Attribute

Transaction

Transaction Name

transactionName_t

Transaction Name

Transaction Name

Commerce Attribute

Transaction

Status

status_t

Status

Status

Commerce Attribute

Transaction

Total Contract Value

totalContractValue_t

Total Contract Value

Total Contract Value

Commerce Attribute

Transaction

Annual Contract Value

totalAnnualValue_t

Annual contract Value

Annual contract Value

Commerce Attribute

Transaction

Total Discount

totalOneTimeDiscount_t

Total Discount

Total Discount

Commerce Attribute

Transaction

Total

totalOneTimeListAmount_t

Total (List)

Total (List)

Commerce Attribute

Transaction

Total

totalOneTimeNetAmount_t

Total (Net)

Total (Net)

Commerce Attribute

Transaction

Total

totalMonthlyListAmount_t

Total (List) Per Month

Total (List) Per Month

Commerce Attribute

Transaction

Total

totalMonthlyNetAmount_t

Total (Net) Per Month

Total (Net) Per Month

Commerce Attribute

Transaction

Total Discount Per Month

totalMonthlyDiscount_t

Total Discount Per Month

Total Discount Per Month

Commerce Attribute

Transaction

Last Priced

lastPricedDate_t

Last Priced

Last Priced

Commerce Attribute

Transaction

Price Within Policy

priceWithinPolicy_t

Price Within Policy

Price Within Policy

Commerce Attribute

Transaction Line

Status

status_l

Line Item Status

Line Item Status

Commerce Attribute

Transaction Line

Contracted Periods

contractedPeriods_l

Contracted Periods

Contracted Periods

Commerce Attribute

Transaction Line

Discount

customDiscountValue_l

Discount

Discount

Commerce Attribute

Transaction Line

Custom Discount Amount

customDiscountAmount_l

Custom Discount Amount

Custom Discount Amount

Commerce Attribute

Transaction Line

Discount Type

customDiscountType_l

Discount Type

Discount Type

Commerce Attribute

Transaction Line

Amount

netAmount_l

Amount (Net)

Amount (Net)

Commerce Attribute

Transaction Line

Price

netPrice_l

Price (Net)

Price (Net)

Commerce Attribute

Transaction Line

Price

listPrice_l

Price (List)

Price (List)

Commerce Attribute

Transaction Line

Amount

listAmount_l

Amount (List)

Amount (List)

Commerce Attribute

Transaction Line

Transaction Internal ID

transactionID_l

Transaction ID

Transaction ID

Commerce Attribute

Transaction

Version Number

version_number_versionTransaction_t

Version Number

Version Number

Commerce Attribute

Transaction

Version

version_t

Version

Version

Commerce Attribute

Transaction

Customer Id

_customer_id

First Customer ID

First Customer ID

Commerce Attribute

Transaction Line

Action Code

oRCL_ABO_ActionCode_l

Action Code

Action Code

Commerce Attribute

Transaction Line

Part Number

_part_number

Part Number

Part Number

Commerce Attribute

Transaction Line

Request Date

requestDate_l

Line Request Date

Line Request Date

Commerce Attribute

Transaction Line

Instance ID

itemInstanceId_l

Item Instance Id

Item Instance Id

Commerce Attribute

Transaction Line

Fulfillment Status

fulfillmentStatus_l

Fulfill Status

Fulfill Status


ClosedStandard Process Commerce Integrations

Beginning in Oracle CPQ 23B, the Standard Process provides predefined REST integrations to simplify setup for integrations between Oracle CX Sales and Oracle CPQ. Additionally, it provides several predefined BML integrations for order and subscription management. The Standard Process will include the Oracle integrations by default. Customers can add additional integrations in the Commerce Process and delete they can delete integrations that are not needed.

  Name

  Type

  ID Field

  Description

Sync Quote Lines

REST - Export Lines

transaction.oRCL_SFA_TransactionID_t

Creates, updates or deletes the SFA quote lines object.

REST Import Opportunity

REST - Import

transaction.opportunityNumber_t

Imports the opportunity header information from SFA for this transaction.

REST Upsert Quote

REST - Export

transaction.none

Creates or updates the SFA quote and sales order header object with summary information about the CPQ transaction.

REST Line Sync Complete

REST - Export

transaction.none

Updates the sync date on the SFA quote and sales order header object to trigger upsert of opportunity revenue lines.

Import Revenue Lines

REST - Import

transaction.opportunityNumber_t

Imports Revenue lines from SFA opportunity and creates related quote lines on the CPQ transaction.

Get SO Status From FOM

BML

 

Gets Order status and Line status from an external system.

Cancel SO From CPQ

BML

 

Cancels the entire order or the specific lines in the external system.

Update Fulfillment Line Status

BML

 

Updates the fulfillment status and updates the asset for the line items in the external system.

Update Asset

BML

 

Performs asset creation in CPQ Cloud local repository and updates Fulfillment Status.


ClosedStandard Process Workflow Steps

The Standard Process contains several steps to manage quote approvals and order management. Standard Workflow Steps are automatically created when a new Standard Process is created.

Step #

  Transition From Step Name

  Transition From Step Variable Name

  Participant Profile

  Membership in Participant Profile

  Action

  Transition Rule Name

  Transition to Step Name

  Description

1

Start

start_step

Admin

Bus Admin, Tech Admin

Save

 

In Progress

The transaction has been created but not yet saved.

1

Start

start_step

Admin

Bus Admin, Tech Admin

View Next Step

Next

In Progress

The transaction has been created but not yet saved.

1

Start

start_step

Admin

Bus Admin, Tech Admin

View Previous Step

Previous

In Progress

The transaction has been created but not yet saved.

1

Start

start_step

Sales User

Sales User

Save

Save -> In Progress

In Progress

The transaction has been created but not yet saved.

2

In Progress

pending_process

Admin

Bus Admin, Tech Admin

Alternate Order

Alternate Order: Pending -> Alternate

Alternate Version Ordered

The transaction is being edited prior to sending to the customer or ordering.

2

In Progress

pending_process

Admin

Bus Admin, Tech Admin

Delete Transaction

Delete Transaction

Deleted

The transaction is being edited prior to sending to the customer or ordering.

2

In Progress

pending_process

Admin

Bus Admin, Tech Admin

Request Approval

submit - approval needed

Waiting for Approval

The transaction is being edited prior to sending to the customer or ordering.

2

In Progress

pending_process

Admin

Bus Admin, Tech Admin

Save

Saved Transaction

In Progress

The transaction is being edited prior to sending to the customer or ordering.

2

In Progress

pending_process

Admin

Bus Admin, Tech Admin

Submit

submit - no approval needed

Approved

The transaction is being edited prior to sending to the customer or ordering.

2

In Progress

pending_process

Admin

Bus Admin, Tech Admin

View Next Step

Next

Waiting for Approval

The transaction is being edited prior to sending to the customer or ordering.

2

In Progress

pending_process

Admin

Bus Admin, Tech Admin

View Previous Step

Previous

Start

The transaction is being edited prior to sending to the customer or ordering.

2

In Progress

pending_process

Sales User

Sales User

Alternate Order

Alternate Order: Pending -> Alternate

Alternate Version Ordered

The transaction is being edited prior to sending to the customer or ordering.

2

In Progress

pending_process

Sales User

Sales User

Cancel Transaction

Cancel Transaction

Canceled

The transaction is being edited prior to sending to the customer or ordering.

2

In Progress

pending_process

Sales User

Sales User

Customer Rejection

Customer Rejected

Rejected by Customer

The transaction is being edited prior to sending to the customer or ordering.

2

In Progress

pending_process

Sales User

Sales User

Delete Transaction

Delete Transaction

Deleted

The transaction is being edited prior to sending to the customer or ordering.

2

In Progress

pending_process

Sales User

Sales User

Request Approval

submit - approval needed

Waiting for Approval

The transaction is being edited prior to sending to the customer or ordering.

2

In Progress

pending_process

Sales User

Sales User

Save

Saved Transaction

In Progress

The transaction is being edited prior to sending to the customer or ordering.

2

In Progress

pending_process

Sales User

Sales User

Submit

submit - no approval needed

Approved

The transaction is being edited prior to sending to the customer or ordering.

3

Waiting for Approval

waitingForInternalApproval

Admin

Bus Admin, Tech Admin

Alternate Order

Alternate Order: Waiting for Approval -> Alternate

Alternate Version Ordered

The transaction is locked awaiting approval from management.

3

Waiting for Approval

waitingForInternalApproval

Admin

Bus Admin, Tech Admin

Cancel Approvals

revise (submit) waiting for approval -> pending

In Progress

The transaction is locked awaiting approval from management.

4

Waiting for Approval

waitingForInternalApproval

Admin

Bus Admin, Tech Admin

Reject

Reject: Waiting for Approval -> In Progress

In Progress

The transaction is locked awaiting approval from management.

5

Waiting for Approval

waitingForInternalApproval

Admin

Bus Admin, Tech Admin

Submit

Submit: Waiting for Approval -> Approved

Approved

The transaction is locked awaiting approval from management.

3

Waiting for Approval

waitingForInternalApproval

Admin

Bus Admin, Tech Admin

View Next Step

Next

Approved

The transaction is locked awaiting approval from management.

3

Waiting for Approval

waitingForInternalApproval

Admin

Bus Admin, Tech Admin

View Previous Step

Previous

In Progress

The transaction is locked awaiting approval from management.

3

Waiting for Approval

waitingForInternalApproval

Sales User

Sales User

Alternate Order

Alternate Order: Waiting for Approval -> Alternate

Alternate Version Ordered

The transaction is locked awaiting approval from management.

3

Waiting for Approval

waitingForInternalApproval

Sales User

Sales User

Cancel Approvals

revise (submit) waiting for approval -> pending

In Progress

The transaction is locked awaiting approval from management.

3

Waiting for Approval

waitingForInternalApproval

Sales User

Sales User

Cancel Transaction

Cancel Transaction

Canceled

The transaction is locked awaiting approval from management.

3

Waiting for Approval

waitingForInternalApproval

Sales User

Sales User

Customer Rejection

Customer Rejected

Rejected by Customer

The transaction is locked awaiting approval from management.

4

Approved

approved

Admin

 

Alternate Order

Alternate Order: Approved -> Alternate

Alternate Version Ordered

The transaction has all necessary internal approvals.

4

Approved

approved

Admin

 

Cancel Approvals

revise (submit): approved -> In Progress

In Progress

The transaction has all necessary internal approvals.

4

Approved

approved

Admin

 

Cancel Transaction

Cancel Transaction

Canceled

The transaction has all necessary internal approvals.

4

Approved

approved

Admin

 

Request Signature

Request Signature

Waiting for Signature

The transaction has all necessary internal approvals.

4

Approved

approved

Admin

 

View Next Step

Next

Waiting for Signature

The transaction has all necessary internal approvals.

4

Approved

approved

Admin

 

View Previous Step

Previous

Waiting for Approval

The transaction has all necessary internal approvals.

4

Approved

approved

Sales User

Sales User

Alternate Order

Alternate Order: Approved -> Alternate

Alternate Version Ordered

The transaction has all necessary internal approvals.

4

Approved

approved

Sales User

Sales User

Cancel Approvals

revise (submit): approved -> In Progress

In Progress

The transaction has all necessary internal approvals.

4

Approved

approved

Sales User

Sales User

Cancel Transaction

Cancel Transaction

Canceled

The transaction has all necessary internal approvals.

4

Approved

approved

Sales User

Sales User

Create Order

Create Order

Ordered

The transaction has all necessary internal approvals.

4

Approved

approved

Sales User

Sales User

Customer Rejection

Customer Rejected

Rejected by Customer

The transaction has all necessary internal approvals.

4

Approved

approved

Sales User

Sales User

Request Signature

Request Signature

Waiting for Signature

The transaction has all necessary internal approvals.

5

Waiting for Signature

waitingForSignature

Default

 

Add Signature

add signature: waiting for signature -> signed

Signed

The transaction is awaiting customer approval before being ordered.

5

Waiting for Signature

waitingForSignature

Default

 

Alternate Order

Alternate Order: Waiting for Signature

Waiting for Signature

The transaction is awaiting customer approval before being ordered.

5

Waiting for Signature

waitingForSignature

Default

 

Customer Rejection

reject: waiting for signature -> rejected

Rejected by Customer

The transaction is awaiting customer approval before being ordered.

5

Waiting for Signature

waitingForSignature

Default

 

View Next Step

Next

Signed

The transaction is awaiting customer approval before being ordered.

5

Waiting for Signature

waitingForSignature

Default

 

View Previous Step

Previous

Approved

The transaction is awaiting customer approval before being ordered.

6

Signed

signed

Default

 

Alternate Order

Alternate Order: Signed -> Alternate

Alternate Version Ordered

The customer has signed the contract.

6

Signed

signed

Default

 

Create Order

Create Order: signed -> ordered

Ordered

The customer has signed the contract.

6

Signed

signed

Default

 

View Next Step

Next

Ordered

The customer has signed the contract.

6

Signed

signed

Default

 

View Previous Step

Previous

Waiting for Signature

The customer has signed the contract.

7

Ordered

orderedBeingFulfilled

Admin

Bus Admin, Tech Admin

View Next Step

Next

Being Changed / Canceled

The order has been sent to the fulfillment system.

7

Ordered

orderedBeingFulfilled

Admin

Bus Admin, Tech Admin

View Previous Step

Previous

Signed

The order has been sent to the fulfillment system.

7

Ordered

orderedBeingFulfilled

Sales User

Sales User

Cancel Transaction

Cancel: Order -> Canceled

Canceled

The order has been sent to the fulfillment system.

7

Ordered

orderedBeingFulfilled

Sales User

Sales User

Change Order

Change Order

Being Changed / Canceled

The order has been sent to the fulfillment system.

7

Ordered

orderedBeingFulfilled

Sales User

Sales User

Customer Rejection

Customer Rejected

Rejected by Customer

The order has been sent to the fulfillment system.

7

Ordered

orderedBeingFulfilled

Sales User

Sales User

Fulfill Order

Fulfill Order

Fulfilled

The order has been sent to the fulfillment system.

8

Being Changed / Canceled

beingChangedCanceled

Admin

 

View Next Step

Next

Fulfilled

This is a copy of a transaction that is currently being fulfilled that the customer wants to change. NOTE that transitions, validations, and logic for this step are incomplete in this Ref App image.

8

Being Changed / Canceled

beingChangedCanceled

Admin

 

View Previous Step

Previous

Ordered

This is a copy of a transaction that is currently being fulfilled that the customer wants to change. NOTE that transitions, validations, and logic for this step are incomplete in this Ref App image.

8

Being Changed / Canceled

beingChangedCanceled

Sales User

 

Alternate Order

 

Alternate Version Ordered

This is a copy of a transaction that is currently being fulfilled that the customer wants to change. NOTE that transitions, validations, and logic for this step are incomplete in this Ref App image.

8

Being Changed / Canceled

beingChangedCanceled

Sales User

 

Cancel Transaction

 

Canceled

This is a copy of a transaction that is currently being fulfilled that the customer wants to change. NOTE that transitions, validations, and logic for this step are incomplete in this Ref App image.

8

Being Changed / Canceled

beingChangedCanceled

Sales User

 

Customer Rejection

 

Rejected by Customer

This is a copy of a transaction that is currently being fulfilled that the customer wants to change. NOTE that transitions, validations, and logic for this step are incomplete in this Ref App image.

8

Being Changed / Canceled

beingChangedCanceled

Sales User

 

Request Approval

 

Waiting for Approval

This is a copy of a transaction that is currently being fulfilled that the customer wants to change. NOTE that transitions, validations, and logic for this step are incomplete in this Ref App image.

8

Being Changed / Canceled

beingChangedCanceled

Sales User

 

Submit

 

Approved

This is a copy of a transaction that is currently being fulfilled that the customer wants to change. NOTE that transitions, validations, and logic for this step are incomplete in this Ref App image.

9

Fulfilled

closedFulfilled

None

 

None

 

None

The order has been fulfilled and no further changes are possible.

10

Canceled

canceled

Admin

 

Delete Transaction

Delete Transaction

Deleted

The entire order has been canceled.

11

Canceled

canceled

Sales User

 

Delete Transaction

Delete Transaction

Deleted

The entire order has been canceled.

11

Rejected By Customer

rejectedByCustomer

None

 

None

 

None

The customer decided not to move forwards with the proposed transaction. NOTE that transitions, validations, and logic for this step are incomplete in this Ref App image.

12

Alternate Version Ordered

alternateVersionOrdered

None

 

None

 

None

The customer chose to move forwards with a different version of the same proposal. This version is closed. NOTE that transitions, validations, and logic for this step are incomplete in this Ref App image.

13

Deleted

deleted

None

 

None

 

None

The transaction has been deleted


 

Notes

Notes:

  • You cannot migrate Standard Process override properties from one to another Standard Process with the same variable name.
  • Even though Legacy and Mobile Layouts are displayed when migrating granular differences for a Standard Process, Legacy and Mobile Layouts are not available in the Standard Process.
  • The Oracle CPQ-Subscription Management integration package is not supported with the Standard Process. All orders must go through the Oracle CX Sales/Fusion Order Management integration including if the order only contains subscription products.

  • Price Score Attributes - Commerce Standard Process supports the price score line-level attribute and rollup value updates when using the Advanced Calculation price score method. Administrators can choose to keep the seeded attributes for the price score calculation, or update the attributes selection as per their requirements (see Price Score for detailed instructions).

Related Topics

Related Topics Link IconSee Also