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

ClosedImport Revenue Lines

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
  • Batch Size: 500
  • Document: Sub Document
Response Mapping
CPQ Attribute Mapping Oracle Sales Attribute
Name Variable Name Type Display Name Variable Name

Config Attribute Values

_config_attr_values

Text Area

Arrow Left

Product Model Attributes

ProductModelConfigAttributes

Arrow Left

Product Group Model Attributes

ProdGroupModelConfigAttributes

Contract End Date

contractEndDate_l

Date

Arrow Left

Contract End Date

ContractEndDate

Contract Start Date

contractStartDate_l

Date

Arrow Left

Contract Start Date

ContractStartDate

Instance ID

itemInstanceId_l

Text

Arrow Left

External Asset Key

ExternalAssetKey

Model Name

_model_name

Text

Arrow Left

Product Group

ProdGroupName

Arrow Left

Solution

Description

Model Partner Organization ID

model_parner_organization_id'

Text Arrow Left Opportunity Revenue

inventoryOrgId

Model Product Line Variable Name

_model_product_line_var_name

Text

 

Arrow Left

Product Group Model Line

ProdGroupModelLine

Arrow Left

Product Model Line

ProdModelName

Model Segment
Variable Name

_model_segment_var_name

Text

Arrow Left

Product Group Model Family

ProdGroupModelFamily

Arrow Left

Product Model Family

ProdModelFamily

Model Variable Name

_model_variable_name

Text Arrow Left

Product Group Model

ProductGroupModelName

Arrow Left

Product Model

ProductModelName

Parent Asset Key

parentAssetKey_l

Text

Arrow Left

External Parent Asset Key

ExternalParentAssetKey

Partner Entity Id

_partner_entity_id

Text Area

Arrow Left

Product

InventoryItemId

Partner Organization ID

oRCL_SFA_InventoryOrgID_l

Text

Arrow Left

Product

InventoryOrgId

Quantity

_price_quantity

Integer

Arrow Left

Quantity

Quantity

Revenue Category

_revenueCategory_l

Menu

Arrow Left

Revenue Type Category

RevenueTypeCategory

Revenue ID

_revenueId_l

Text

Arrow Left

Revenue Id

RevnId

Root Asset Key

rootAssetKey_l

Text

Arrow Left

External Root Asset Key

ExternalRootAssetKey

Sales Channel

salesChannel_l

Menu

Arrow Left

Sales Channel

SalesChannelCd

Subscription Id

subscriptionId_l

Text

Arrow Left

Subscription Id

SubscriptionId

Subscription Line Id

subscriptionLineId_l

Text

Arrow Left

Subscription Line Id

SubscriptionLineId

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.


ClosedREST Import Opportunity

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

Arrow Left

Business Unit ID

PrimaryOrganizationId

Contact Email Address

contactEmailAddress_t

Text Arrow Left

Primary Contact Email

PrimaryContactEmailAddress

Contact Name

contactName_t

Text Arrow Left

Primary Contact

PrimaryContactPartyName

Contact Party Number

_transaction_s_contactPartyName_t

Text Arrow Left

Primary Contact Party Number

PrimaryContactPartyNumber

Opportunity Amount

opportunityAmount_t

Currency

Arrow Left

Amount

Amount_c

Opportunity ID

opportunityID_t

Text

Arrow Left

Opportunity ID

OptyId

Opportunity Name

opportunityName_t

Text

Arrow Left

Name

Name

Opportunity Win Probability

opportunityWinProbability_t

Integer

Arrow Left

Win Probability

WinProb

Owner Resource Party ID

oRCL_SFA_OwnerResourcePartyID_t

Text

Arrow Left

Owner

OwnerResourcePartyId

Primary Org ID

oRCL_SFA_PrimaryOrgID_t

Text Arrow Left Business Unit ID

Primary OragnizationId

Revenue Category

_transaction_revenueCategory_t

Menu

Arrow Left

Opportunity Type

OpportunityTypeCode


ClosedREST Line Sync Complete

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
Request Mapping
CPQ Attribute Mapping Oracle Sales Attribute
Name Variable Name Type Display Name Variable Name
Current Date

_system_date

Date

Arrow Right

Last Synchronized

LastOptySyncDate

Partner Transaction ID

oRCL_SFA_TransactionID_t

Text

Arrow Right

ID 

OrderHeaderId


ClosedREST Upsert Quote

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
  • 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 Arrow Right Contract End Date

ContractEndDate

Contract Start Date

contractStartDate_t

Date Arrow Right Contract Start Date

ContractStartDate

Current Document Currency Preference

_system_current_document_currency_pref

Text Arrow Right Currency

CurrencyCode

Current Process Name

_system_process_name

Text Arrow Right CPQ Process Name

ExternalProcessName

Current Unique Buy-Side ID

_system_buyside_id

Text Arrow Right Reference Number

ExternalReferenceNumber

Customer ID

_transaction_customer_id

Text Arrow Right Customer ID

SoldCustomerPartyId

Opportunity ID

opportunityID_t

Text Arrow Right Opportunity ID

OptyId

Opportunity Win/Loss Status

oRCL_SFA_Status_t

Text Arrow Right Win Status

WinStatusCode

Owner

owner_t

Text Arrow Right Owner

Owner

Partner Transaction ID

oRCL_SFA_TransactionID_t

Text Arrow Right ID

OrderHeaderId

Price Expiration Date

priceExpirationDate_t

Date Arrow Right Valid To Date

ExpirationDate

Proposal Exists

proposalExists_t

Boolean Arrow Right Proposal

ProposalExistFlag

Renewal Process

renewalProcess_t

Menu Arrow Right Renewal Process

RenewalProcess

Revenue Category

_revenueCategory_t

Menu Arrow Right Quote Type Category

QuoteTypeCategory

Status

status_t

Text Arrow Right Status

Status

Supplier's Company Name

_system_supplier_company_name

Text Arrow Right External Host Name

ExternalHostName

Total (Net)

totalOneTimeNetAmount_t

Currency Arrow Right Total Nonrecurring Revenue

TotalNonRecurringRevenue

Total (Net) Per Month

totalMonthlyNetAmount_t

Currency Arrow Right Total Monthly Recurring Revenue

TotalMonthlyRecurringRevenue

Total Contract Value (Net)

totalContractValue_t

Currency Arrow Right Total Contract Value

OrderTotal

Total MUR (Net)

totalMonthlyUsageRev_t

Currency Arrow Right Total Monthly Usage Revenue

TotalMonthlyUsageRevenue

Total Recurring Revenue (Net)

totalRecurRevenue_t

Currency Arrow Right Total Recurring Revenue

TotalRecurringRevenue

Total Usage Revenue (Net)

totalUsageRevenue_t

Currency Arrow Right Total Usage Revenue

TotalUsageRevenue

Transaction Name

transactionName_t

Text Arrow Right Name

Name

Transaction Number

transactionID_t

Text Arrow Right Quote ID

ExternalQuoteNumber

Transaction Source System

transactionSourceSystem_t

Text Arrow Right Reference Code

ExternalSystemReferenceCode

Version Number

version_number_versionTransaction_t

Text Arrow Right 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 Arrow Left ID

OrderHeaderId


ClosedSync Quote Lines

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
  • 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

Arrow Right

Line Contract End Date

ContractEndDate

Contract Start Date

contractStartDate_l

Date

Arrow Right

Line Contract Start Date

ContractStartDate

Contract Value (Net Rollup)

contractValueRollup_l

Currency

Arrow Right

Line Contract Value

ContractValue

Contract Value (Net Summable)

contractValue_l

Currency

Arrow Right

Contract Value Detail

SummableContractAmount

Contracted Periods (Rollup)

contractedPeriodsRollup_l

Integer

Arrow Right

Line Contract Periods

ContractPeriods

Currency

currency_t

Menu

Arrow Right

Line Currency

CurrencyCode

Discount Percent (Rollup)

discountPercentRollup_l

Float

Arrow Right

Line Discount

DiscountPercentage

Document Number

_document_number

Text

Arrow Right

External Line Number

ExternalOrderLineNumber

Instance ID

itemInstanceId_l

Text

Arrow Right

External Asset Key

ExternalAssetKey

Inventory Item ID

oRCL_SFA_InventoryItemID_l

Text

Arrow Right

Inventory Item ID

InventoryItemId

Line Type

lineType_l

Menu

Arrow Right

Item Type

ItemTypeCode

List Price (Rollup)

listPriceRollup_l

Currency

Arrow Right

Unit List Price

UnitListPrice

MRR (Rollup)

monthlyRecurRevRollup_l

Currency

Arrow Right

Monthly Recurring Revenue

MonthlyRecurringRevenue

MUR (Rollup)

monthlyUsageRevRollup_l

Currency

Arrow Right

Monthly Usage Revenue

MonthlyUsageRevenue

Net Amount (Rollup)

netAmountRollup_l

Currency

Arrow Right

Net Amount

Amount

Net Price (Rollup)

netPriceRollup_l

Currency

Arrow Right

Net Price

Price

Non-Recurring Revenue (Rollup)

nonRecurRevRollup_l

Currency

Arrow Right

Nonrecurring Revenue

NonRecurringRevenue

Non-Recurring Revenue (Summable)

nonRecurRevSummable_l

Currency

Arrow Right

Nonrecurring Revenue Detail

SummableNonRecurringRevenue

Opportunity Win/Loss Status

oRCL_SFA_Status_l

Text

Arrow Right

Line Win Loss Status

WinLossStatusCode

Order Number

oRCL_ERP_OrderNumber_l

Text

Arrow Right

Order Number

OrderNumber

Order Date

orderDate_t

Date

Arrow Right

Line Order Date

OrderDate

Parent Asset Key

parentAssetKey_l

Text

Arrow Right

External Parent Asset Key

ExternalParentAssetKey

Parent Document Number

_parent_doc_number

Text

Arrow Right

Parent External Line Number

ParentExternalOrderLineNumber

Partner Organization ID

oRCL_SFA_InventoryOrgID_l

Text

Arrow Right

Inventory Organization ID

InventoryOrgId

Partner Transaction ID

oRCL_SFA_TransactionID_t

Text

Arrow Right

Order Header ID

OrderHeaderId

Price Recurrence Frequency (Rollup)

priceRecurFrequencyRollup_l

Menu

Arrow Right

Line Price Period

PricePeriodCode

Price Type (Rollup)

priceTypeRollup_l

Menu

Arrow Right

Line Price Type

PriceTypeCode

Quantity

requestedQuantity_l

Integer

Arrow Right

Quantity

Quantity

Recurring Revenue (Rollup)

recurRevRollup_l

Currency

Arrow Right

Recurring Revenue

RecurRevenue

Recurring Revenue (Summable)

recurringRevSummable_l

Currency

Arrow Right

Recurring Revenue Detail

SummableRecurringRevenue

Request Date

requestDate_l

Date

Arrow Right

Line Request Date

RequestDate

Revenue Category

_revenueCategory_l

Menu

Arrow Right

Revenue Type Category

RevenueTypeCategory

Revenue ID

_revenue_id

Text

Arrow Right

Revenue Id

RevnId

Root Asset Key

rootAssetKey_l

Text

Arrow Right

External Root Asset Key

ExternalRootAssetKey

Root Line

rootLine_l

Menu

Arrow Right

Root Line

RootLine

Status

status_l

Menu

Arrow Right

Line Status

LineStatusCode

Subscription Id

subscriptionId_l

Text

Arrow Right

Subscription Id

SubscriptionId

Subscription Line Id

subscriptionLineId_l

Text

Arrow Right

Subscription Line Id

SubscriptionLineId

Unit of Measure

requestedUnitOfMeasure_l

Menu

Arrow Right

UOM

UOMCode

Usage Revenue (Rollup)

usageRevRollup_l

Currency

Arrow Right

Usage Revenue

UsageRevenue

Usage Revenue (Summable)

usageRevSummable_l

Currency

Arrow Right

Usage Revenue Detail

SummableUsageRevenue


Related Topics

Related Topics Link IconSee Also