Commerce Integration Attribute Mapping

Overview

The Attribute Mapping page that allows administrators to customize their Oracle Sales integration without the use of XSL. This page provides a user-friendly interface to map attributes. It supports text based searches to find attributes and drag and drop functionality to add attributes. CPQ attributes are grouped by Transaction and Transaction Line levels. Transaction attributes are displayed first and have a blue sidebar. Transaction Line attributes are displayed after Transaction attributes and have a lavender sidebar.

The Attribute Mapping page displays the CPQ attributes on the left side of the page and the Oracle Sales attributes on the right side. The mapped attributes are displayed in the middle. Icons identify the attribute type and the attribute variable name is displayed when hovering over an attribute name. Administrators can add new attribute mappings and edit or delete existing attribute mappings.

ClosedView Attribute Mapping Page Example

Attribute Mapping page


ClosedSupported Attribute Mapping Data Types

Oracle Sales   CPQ Commerce Attribute Notes
Icon Data Type Icon Data Type
Boolean icon boolean Boolean icon Boolean Only supports "true" and "false" values.
Values are not case sensitive.
Date icon date Date icon Date Only supports ISO format
Date Time icon Date Time Only supports ISO format
Text icon Text  
Text Area icon Text Area  
Date Time icon datetime Date icon Date Only supports ISO format
Date Time icon Date Time Only supports ISO format
Text icon Text  
Text Area icon Text Area  
Integer icon integer Integer icon Integer

Only supports -2,147,483,648 to 2,147,483,647 integer value range.

Text icon Text  
Text Area icon Text Area  
Integer icon

Group Sequence Number

 
Integer icon

Sequence Number

 
Number icon number Currency icon Currency  
Number icon Float  
Integer icon Integer Only supports -2,147,483,648 to 2,147,483,647 integer value range.
Text icon Text  
Text Area icon Text Area  
Text Area icon

string

Boolean icon Boolean Only supports "true" and "false" values.
Values are not case sensitive.
Currency icon Currency  
Date icon Date Only supports ISO format
Date Time icon DateTime Only supports ISO format
Number icon Float  
Integer icon Integer

Only supports -2,147,483,648 to 2,147,483,647 integer value range.

Text Area icon Rich Text  
Menu icon Single Select Menu Oracle Sales value must match CPQ's menu variable value.
Text icon Text  
Text Area icon Text Area  
Menu icon Commerce Dynamic Menus Oracle Sales value must match CPQ's menu variable value.

ClosedSort and Reorder Mapped Attribute Rows

Beginning in Oracle CPQ 22B, administrators can to sort and reorder mapped rows on the Commerce Integration Attribute Mapping page. The mapped rows can be sorted by the CPQ Attribute or the Mapped Attribute column in ascending or descending order. Sorting rows by the CPQ Attribute allows administrators to easily identify all attributes that are conditionally mapped to the same target attribute.

Sort Mapped Attribute Rows

The following image displays attribute mapping without sorting. Notice that the highlighted conditionally mapped rows are not grouped together.

Attribute mapping Rows without Sorting

When the administrator sorts the attribute mappings by the CPQ Attribute, the conditionally mapped rows are grouped together. This makes it easier to quickly identify Oracle Oracle Sales attributes that are mapped to the same CPQ attribute. Administrators need to click Save to retain the sorted attribute order.

Sorted Attribute Mapping

Reorder Attribute Mapping Rows Using Drag and Drop

Administrators can also drag and drop attributes to reorder the mapped rows. Sorting rows by allows administrators to easily identify all attributes that are conditionally mapped to the same target attribute. Additionally, administrators can drag and drop items to reorder mapped rows in the order they prefer. Sorting rows by allows administrators to easily identify all attributes that are conditionally mapped to the same target attribute. Additionally, administrators can drag and drop items to reorder mapped rows in the order they prefer.

In the following image, the CPQ Parent Asset Key attribute was selected, and then dragged and dropped below the CPQ Instance ID attribute.

  • When mapping row is in edit mode, it cannot be dragged and dropped.
  • If you sort after dragging and dropping an attribute, the reordered attribute position will be lost.
  • Administrators need to click Save to retain the reordered attribute position, which could have been arrived at by a combination of sort and manual resequencing.

Reorder Attribute Mapping Rows

Reorder Attribute Mapping Rows Using Drag and Drop

Administrators can also drag and drop attributes to reorder the mapped rows. In the following image, the CPQ Parent Asset Key attribute was selected, and then dragged and dropped below the CPQ Instance ID attribute.

  • When mapping row is in edit mode, it cannot be dragged and dropped.
  • If you sort after dragging and dropping an attribute, the reordered attribute position will be lost.
  • Administrators need to click Save to retain the reordered attribute position, which could have been arrived at by a combination of sort and manual resequencing.

Drag and Drop Attribute Mapping Rows


ClosedConditional Mapping for REST Integrations

Beginning in Oracle CPQ 22A administrators can define conditional logic for the import of sub-document Commerce REST integration mappings. Conditional mapping allows the mapping of two source attributes to the same target attribute. When two source attributes are mapped to one target attribute, conditions must be defined to determine which of the source attributes to use. When conditions for the primary source attribute are not met, the secondary (default) mapping will be used.

The predefined response attribute mapping for the REST Import Revenue Lines Integration contains conditional mapping for several attributes. When two source attributes are mapped to the same target attribute, the conditional mapping icon is displayed for both mappings.

As shown in the following image, there are four instances where two Oracle Sales attributes (i.e. source attributes) are mapped to the same CPQ attribute (i.e. target attribute). The mappings with conditional mapping are outlined in blue, and the conditional mapping icon is outlined in red. Since both mapped attributes have the same condition, you can click on either conditional mapping icon to view the conditional mapping for the target attribute.

Conditional Mapping

Edit Conditions Dialog for Conditional Mapping

To access the conditional logic for mapped items, click on the conditional mapping icon. The following image displays the conditional mapping for the CPQ Model Segment Variable Name attribute:

Edit Conditions Dialog

  • Select one of the two attribute mappings from the Conditional Attribute Mapping drop-down.

    The selected mapping is used when the Condition is satisfied (e.g. Model Segment Variable Name = Product Group Model Family).

  • Action based on: The action can be based on All Conditions, Any Conditions, or Complex Conditions.
  • A "Condition" is defined by selecting the Attribute, Operator, and Value.

    (e.g. Product Type is equal to "Group")

    • Attribute: Select a Oracle Sales attribute for the condition (e.g. Product Type)
    • Operator: Available operators are based on the selected attribute type.
    • Value: Enter a value for the condition
  • Click Add New Condition to define additional conditions.
  • The Else – Default is automatically set to attribute mapping that isn't selected for the If Condition.

    (e.g. Model Segment Variable Name = Product Model Family)


ClosedMissing CX Attributes in Imported Revenue Line Conditional Mappings

Beginning in Oracle CPQ 22B, the Attribute Mapping page will highlight missing attributes that are used in mappings as well in conditions and provide an error message when the administrator double clicks on the highlighted attribute. Informing CPQ administrators of missing Oracle Sales attributes prevents errors when an integration is run.

Missing CX Attributes

The Edit Conditions dialog will also provide an error message about which Oracle Sales attribute used in the condition has been deleted. For example, when a deleted CX attribute causes an invalid condition, the condition rule editor will denote which attribute has been deleted.

Edit Conditions dialog with Errors


 

Administration

ClosedEdit Attribute Mapping for Oracle Sales Quote Line Integration

New customers will have these mappings defined as part of the provisioned reference implementation. Existing customers will have a migration package to create this standard integration. Administrators can complete the following steps to add new attribute mappings or edit the existing attribute mappings.

  1. Log in to Oracle CPQ and open the Admin Home page.
  2. Click Process Definition, in the Commerce and Documents section.
  3. Select Integrations from the Navigation drop-down menu for the applicable process, and then click List.
  4. Click on the REST Integration name.
  5. Click Edit next to Request Mapping.
  6. Click the Add Row icon Add row icon or drag and drop an attribute to create a new attribute mapping row.
    1. Select the appropriate CPQ attribute on the left side.
    2. Select the appropriate Oracle Sales attribute on the right side.
    3. Click on the Apply icon or click outside the row to register the mapping.

      Register mapping

  7. To delete an attribute mapping, click on the delete icon.
  8. To edit an existing attribute mapping, click on the edit icon.
  9. Click Save to save changes, or Finish to save changes and exit the page.

ClosedPredefined Attribute Mapping for Oracle Sales REST Integrations

CPQ provides new customers with predefined Oracle Sales integrations. Existing customers can import a migration package to implement the predefined integration content. The following the predefined attribute mappings are available for Oracle Sales REST Integrations.

ClosedSync Quote Lines - REST Export Lines

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


ClosedREST Import Opportunity - REST Import

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 ID

opportunityID_t

Text

Arrow Left

Opportunity ID

OptyId

Opportunity Name

opportunityName_t

Text

Arrow Left

Name

Name

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 Upsert Quote - REST Export

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


ClosedREST Line Sync Complete - REST Export

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

Response Mapping

None defined


ClosedREST Import Revenue Lines - REST Import

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


 

Notes

Notes

  • A Commerce REST – Export Lines Integration for Oracle Sales must be created prior to editing attribute mapping.
  • If the Attribute Mapping UI is open when new Commerce attributes are added, the Attribute Mapping UI has to be refreshed to show the new attributes.

  • Administrators should note that Oracle Sales Integer attributes with long values may not work as expected when mapped to Oracle CPQ Integer attributes. The integrations may not set the Oracle Sales attribute value to the Oracle CPQ attribute and the Import or Export integration could potentially fail.

    To be more specific, Oracle CPQ Integer attributes only accept values in the -2147483648 to 2147483647 range.

Refer to Commerce Integrations for more information about Commerce REST integration.

 

Related Topics

Refer to the following documents for more information focused on Oracle Sales to Oracle CPQ integration implementation.

Related Topics Link IconSee Also