Standard Process Commerce Integrations
Overview
Beginning in Oracle CPQ 23B, the Standard Process provides predefined REST integrations to simplify setup for integrations between Oracle 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.
BML Type Integrations
|
Name |
Description |
|---|---|
| Cancel Renewed Subscription | Cancels the draft renewal subscription in the external system. |
|
Cancel SO From CPQ |
Cancels the entire order or the specific lines in the external system. |
|
Get SO Status From FOM |
Gets Order status and Line status from an external system. |
|
Update Asset |
Performs asset creation in CPQ Cloud local repository and updates Fulfillment Status. |
|
Update Fulfillment Line Status |
Updates the fulfillment status and updates the asset for the line items in the external system. |
| Process Create Order Response | Processes REST response from Create Order ICS Integration and applies it to the transaction. |
| Publish And Notify Quote | Publishes the quote and notifies the buyer that the quote is ready for review. |
| TCA Account Integration | Retrieves Bill To, Sold To and Ship To customer information. |
| Update Asset | Performs asset creation in CPQ Cloud local repository and updates Fulfillment Status. |
| Update Customer Status And Visibility | Updates Customer Status and Customer Visibility Identifier based on current step for buyer/customer's view. |
| Update Fulfillment Line Status | Updates the fulfillment status and updates the asset for the line items in the external system. |
REST Type Integrations
This integration imports revenue lines from an Oracle Sales opportunity and creates related quote lines on a CPQ transaction.
- Type: REST - Import Revenue Lines
- Timeout: 20000
- ID Field:
transaction.opportunityNumber_t - Endpoint URL:
/crmRestApi/resources/11.13.18.05/opportunities/{opty_number}/child/ChildRevenue - MetaData URL:
/crmRestApi/resources/11.13.18.05/opportunities/describe - Child Resource: ChildRevenue
- Query Parameters:
- Key:
q - Value:
SplitTypeCode!=DETAILCHILDSPLIT,RecurTypeCode!=CHILDRECUR
- Key:
- Batch Size: 500
- Document: Sub Document
Response Mapping
Note: The model_name attribute only retains the Oracle Sales mapping at the time of import. Once configuration and quoting take place it may be overwritten with the Oracle CPQ product information.
This integration updates the "Last Synchronized" date for an Oracle Sales quote and sales order header object to trigger upsert of opportunity revenue lines.
- Type: REST - Import
- Timeout: 100000
- ID Field:
transaction.opportunityNumber_t - Endpoint URL:
/crmRestApi/resources/11.13.18.05/opportunities/{optyNumber} - MetaData URL:
/crmRestApi/resources/11.13.18.05/opportunities/describe - Document: Main Document
Response Mapping
| CPQ Attribute | Mapping | Oracle Sales Attribute | |||
|---|---|---|---|---|---|
| Name | Variable Name | Type | Display Name | Variable Name | |
|
Business Unit ID |
businessUnitId_t |
Text |
|
Business Unit ID |
PrimaryOrganizationId |
|
Contact Email Address |
contactEmailAddress_t |
Text |
|
Primary Contact Email |
PrimaryContactEmailAddress |
|
Contact Name |
contactName_t |
Text |
|
Primary Contact |
PrimaryContactPartyName |
|
Contact Party Number |
_transaction_s_contactPartyName_t |
Text |
|
Primary Contact Party Number |
PrimaryContactPartyNumber |
|
Opportunity Amount |
opportunityAmount_t |
Currency |
|
Amount |
Amount_c |
|
Opportunity ID |
opportunityID_t |
Text |
|
Opportunity ID |
OptyId |
|
Opportunity Name |
opportunityName_t |
Text |
|
Name |
Name |
|
Opportunity Win Probability |
opportunityWinProbability_t |
Integer |
|
Win Probability |
WinProb |
|
Owner Resource Party ID |
oRCL_SFA_OwnerResourcePartyID_t |
Text |
|
Owner |
OwnerResourcePartyId |
| Primary Org ID |
oRCL_SFA_PrimaryOrgID_t |
Text |
|
Business Unit ID |
Primary OragnizationId |
|
Revenue Category |
_transaction_revenueCategory_t |
Menu |
|
Opportunity Type |
OpportunityTypeCode |
This integration exports transaction level data from CPQ to the Oracle Sales quote and sales order header object.
- Type: REST - Export
- Timeout: 20000
- ID Field:
transaction.none - Endpoint URL:
/crmRestApi/resources/11.13.18.05/salesOrders - MetaData URL:
/crmRestApi/resources/11.13.18.05/salesOrders/describe - Document: Main Document
This integration imports the opportunity header information from Oracle Sales to a CPQ transaction.
- Type: REST Export
- Timeout: 20000
- ID Field:
- Standard Process:
transaction.none - Oracle Sales Reference Application:
transaction.oRCL_OSC_TransactionID_t
- Standard Process:
- Endpoint URL:
/crmRestApi/resources/11.13.18.05/salesOrders - MetaData URL:
/crmRestApi/resources/11.13.18.05/salesOrderLines/describe - Integration Request Headers:
Upsert-Mode:true - Document: Main Documen
Request Mapping
| CPQ Attributes | Mapping | Oracle Sales Attribute | |||
|---|---|---|---|---|---|
| Name | Variable Name | Type | Display Name | Variable Name | |
| Contract End Date |
contractEndDate_t |
Date |
|
Contract End Date |
ContractEndDate |
| Contract Start Date |
contractStartDate_t |
Date |
|
Contract Start Date |
ContractStartDate |
| Current Document Currency Preference |
_system_current_document_currency_pref |
Text |
|
Currency |
CurrencyCode |
| Current Process Name |
_system_process_name |
Text |
|
CPQ Process Name |
ExternalProcessName |
| Current Unique Buy-Side ID |
_system_buyside_id |
Text |
|
Reference Number |
ExternalReferenceNumber |
| Customer ID |
_transaction_customer_id |
Text |
|
Customer ID |
SoldCustomerPartyId |
| Opportunity ID |
opportunityID_t |
Text |
|
Opportunity ID |
OptyId |
| Opportunity Win/Loss Status |
oRCL_SFA_Status_t |
Text |
|
Win Status |
WinStatusCode |
| Owner |
owner_t |
Text |
|
Owner |
Owner |
| Partner Transaction ID |
oRCL_SFA_TransactionID_t |
Text |
|
ID |
OrderHeaderId |
| Price Expiration Date |
priceExpirationDate_t |
Date |
|
Valid To Date |
ExpirationDate |
| Proposal Exists |
proposalExists_t |
Boolean |
|
Proposal |
ProposalExistFlag |
| Renewal Process |
renewalProcess_t |
Menu |
|
Renewal Process |
RenewalProcess |
| Revenue Category |
_revenueCategory_t |
Menu |
|
Quote Type Category |
QuoteTypeCategory |
| Status |
status_t |
Text |
|
Status |
Status |
| Supplier's Company Name |
_system_supplier_company_name |
Text |
|
External Host Name |
ExternalHostName |
| Total (Net) |
totalOneTimeNetAmount_t |
Currency |
|
Total Nonrecurring Revenue |
TotalNonRecurringRevenue |
| Total (Net) Per Month |
totalMonthlyNetAmount_t |
Currency |
|
Total Monthly Recurring Revenue |
TotalMonthlyRecurringRevenue |
| Total Contract Value (Net) |
totalContractValue_t |
Currency |
|
Total Contract Value |
OrderTotal |
| Total MUR (Net) |
totalMonthlyUsageRev_t |
Currency |
|
Total Monthly Usage Revenue |
TotalMonthlyUsageRevenue |
| Total Recurring Revenue (Net) |
totalRecurRevenue_t |
Currency |
|
Total Recurring Revenue |
TotalRecurringRevenue |
| Total Usage Revenue (Net) |
totalUsageRevenue_t |
Currency |
|
Total Usage Revenue |
TotalUsageRevenue |
| Transaction Name |
transactionName_t |
Text |
|
Name |
Name |
| Transaction Number |
transactionID_t |
Text |
|
Quote ID |
ExternalQuoteNumber |
| Transaction Source System |
transactionSourceSystem_t |
Text |
|
Reference Code |
ExternalSystemReferenceCode |
| Version Number |
version_number_versionTransaction_t |
Text |
|
Version |
VersionNumber |
Response Mapping
| CPQ Attribute | Mapping | Oracle Sales Attribute | |||
|---|---|---|---|---|---|
| Name | Variable Name | Type | Display Name | Display Name | |
| Partner Transaction ID |
oRCL_SFA_TransactionID_t |
Text |
|
ID |
OrderHeaderId |
This integration synchronizes quote lines from CPQ to Oracle Sales.
- Type: REST Export Lines
- Timeout: 20000
- ID Field:
- Standard Process:
transaction.oRCL_SFA_TransactionID_t - Oracle Sales Reference Application:
transaction.oRCL_OSC_TransactionID_t
- Standard Process:
- Endpoint URL:
/crmRestApi/resources/11.13.18.05/salesOrders - MetaData URL:
/crmRestApi/resources/11.13.18.05/salesOrderLines/describe - Integration Request Headers:
Upsert-Mode:true - Line Type Filter: All Lines
- Batch Size: 500
- Document: Sub Document
Request Mapping
| CPQ Attribute | Mapping | Oracle Sales Attribute | |||
|---|---|---|---|---|---|
| Name | Variable Name | Type | Name | Variable Name | |
|
Contract End Date |
contractEndDate_l |
Date |
|
Line Contract End Date |
ContractEndDate |
|
Contract Start Date |
contractStartDate_l |
Date |
|
Line Contract Start Date |
ContractStartDate |
|
Contract Value (Net Rollup) |
contractValueRollup_l |
Currency |
|
Line Contract Value |
ContractValue |
|
Contract Value (Net Summable) |
contractValue_l |
Currency |
|
Contract Value Detail |
SummableContractAmount |
|
Contracted Periods (Rollup) |
contractedPeriodsRollup_l |
Integer |
|
Line Contract Periods |
ContractPeriods |
|
Currency |
currency_t |
Menu |
|
Line Currency |
CurrencyCode |
|
Discount Percent (Rollup) |
discountPercentRollup_l |
Float |
|
Line Discount |
DiscountPercentage |
|
Document Number |
_document_number |
Text |
|
External Line Number |
ExternalOrderLineNumber |
|
Instance ID |
itemInstanceId_l |
Text |
|
External Asset Key |
ExternalAssetKey |
|
Inventory Item ID |
oRCL_SFA_InventoryItemID_l |
Text |
|
Inventory Item ID |
InventoryItemId |
|
Line Type |
lineType_l |
Menu |
|
Item Type |
ItemTypeCode |
|
List Price (Rollup) |
listPriceRollup_l |
Currency |
|
Unit List Price |
UnitListPrice |
|
MRR (Rollup) |
monthlyRecurRevRollup_l |
Currency |
|
Monthly Recurring Revenue |
MonthlyRecurringRevenue |
|
MUR (Rollup) |
monthlyUsageRevRollup_l |
Currency |
|
Monthly Usage Revenue |
MonthlyUsageRevenue |
|
Net Amount (Rollup) |
netAmountRollup_l |
Currency |
|
Net Amount |
Amount |
|
Net Price (Rollup) |
netPriceRollup_l |
Currency |
|
Net Price |
Price |
|
Non-Recurring Revenue (Rollup) |
nonRecurRevRollup_l |
Currency |
|
Nonrecurring Revenue |
NonRecurringRevenue |
|
Non-Recurring Revenue (Summable) |
nonRecurRevSummable_l |
Currency |
|
Nonrecurring Revenue Detail |
SummableNonRecurringRevenue |
|
Opportunity Win/Loss Status |
oRCL_SFA_Status_l |
Text |
|
Line Win Loss Status |
WinLossStatusCode |
|
Order Number |
oRCL_ERP_OrderNumber_l |
Text |
|
Order Number |
OrderNumber |
|
Order Date |
orderDate_t |
Date |
|
Line Order Date |
OrderDate |
|
Parent Asset Key |
parentAssetKey_l |
Text |
|
External Parent Asset Key |
ExternalParentAssetKey |
|
Parent Document Number |
_parent_doc_number |
Text |
|
Parent External Line Number |
ParentExternalOrderLineNumber |
|
Partner Organization ID |
oRCL_SFA_InventoryOrgID_l |
Text |
|
Inventory Organization ID |
InventoryOrgId |
|
Partner Transaction ID |
oRCL_SFA_TransactionID_t |
Text |
|
Order Header ID |
OrderHeaderId |
|
Price Recurrence Frequency (Rollup) |
priceRecurFrequencyRollup_l |
Menu |
|
Line Price Period |
PricePeriodCode |
|
Price Type (Rollup) |
priceTypeRollup_l |
Menu |
|
Line Price Type |
PriceTypeCode |
|
Quantity |
requestedQuantity_l |
Integer |
|
Quantity |
Quantity |
|
Recurring Revenue (Rollup) |
recurRevRollup_l |
Currency |
|
Recurring Revenue |
RecurRevenue |
|
Recurring Revenue (Summable) |
recurringRevSummable_l |
Currency |
|
Recurring Revenue Detail |
SummableRecurringRevenue |
|
Request Date |
requestDate_l |
Date |
|
Line Request Date |
RequestDate |
|
Revenue Category |
_revenueCategory_l |
Menu |
|
Revenue Type Category |
RevenueTypeCategory |
|
Revenue ID |
_revenue_id |
Text |
|
Revenue Id |
RevnId |
|
Root Asset Key |
rootAssetKey_l |
Text |
|
External Root Asset Key |
ExternalRootAssetKey |
|
Root Line |
rootLine_l |
Menu |
|
Root Line |
RootLine |
|
Status |
status_l |
Menu |
|
Line Status |
LineStatusCode |
|
Subscription Id |
subscriptionId_l |
Text |
|
Subscription Id |
SubscriptionId |
|
Subscription Line Id |
subscriptionLineId_l |
Text |
|
Subscription Line Id |
SubscriptionLineId |
|
Unit of Measure |
requestedUnitOfMeasure_l |
Menu |
|
UOM |
UOMCode |
|
Usage Revenue (Rollup) |
usageRevRollup_l |
Currency |
|
Usage Revenue |
UsageRevenue |
|
Usage Revenue (Summable) |
usageRevSummable_l |
Currency |
|
Usage Revenue Detail |
SummableUsageRevenue |





