Oracle CX Sales SPIM Integration

Overview

Previously, XSL web service calls were used to integrate parts between Oracle CX Sales and Oracle CPQ. Although this approach allowed two-way communication, synchronization was labor intensive because part fields did not match and parts could be maintained in both Oracle CX Sales and Oracle CPQ applications.

Sales Product Information Master (SPIM) integration provides the following enhancements:

ClosedNear Real Time Synchronization

The near real time synchronization for Oracle CX Sales SPIM Integrations provides synchronization of a given product, without waiting for a scheduled batch synchronization to occur. Oracle CX Sales SPIM products and structures can be synchronized to CPQ using the “Upsert Product in CPQ” action when an appropriate Oracle CX Sales Routine trigger occurs. The Oracle CX Sales Integration Maps use pre-defined mapping for Standard Part Attributes and additional mapping can be added for custom attributes. The CPQ Upsert BOM Item List REST API can create, update, or delete CPQ BOM hierarchies using a list format, instead of the hierarchical JSON format.

For example, an Oracle CX Sales product manager creates the PTO Model structure.

Near Real Time Sync

The corresponding structure is added to the CPQ BOM Item Definition data table BOM Item Tree using the Upsert BOM Item List REST API.

BOM Tree


ClosedBatch Synchronization

The product synchronization from the Oracle CX Sales Product Master and CPQ is performed in scheduled batches, typically once every 24 hours. At the scheduled time:

  • CPQ sends a synchronization request to Oracle CX Sales.
  • Oracle CX Sales exports the entire set of records or a delta set of record charges to CPQ.
    Refer to Synchronization Behavior for more information.

  • After receiving the export completion notification, CPQ updates parts in the CPQ application.

Synchronization of Structures and Components/BOMs

Complex structures created in Oracle CX Sales can also be automatically synchronized into Oracle CPQ on a scheduled basis. When the Unified BOM Sync is enabled, this integration will synchronize Oracle CX Sales structures to the Oracle CPQ BOM Item Definition table.

  • The unified BOM synchronization is initiated upon completion of the parts synchronization.
  • The initial BOM sync will be a complete synchronization.
  • The following BOM synchronizations will be delta synchronizations. BOM sync uses Last Sync Date header value to retrieve records during delta synchronization.

Note: By default, the frequency of the parts synchronization is scheduled to occur daily (i.e. every 24 hours) and the batch download size is set to 100,000 exported items. Customers can submit a Service Request (SR) on My Oracle Support to change the synchronization frequency and/or batch download size.


Synchronization Status Details in CPQ

ClosedAccessing Synchronization Details

The Parts Administration page provides integration information and provides access to synchronization details and controls. To access the Parts Administration page navigate to the CPQ to the Admin Home page, and then click Parts in the Products section.

When CPQ is integrated with the Oracle CX Sales Product Master, "UnifiedProducts" is listed as the Item Master on the Parts Administration page.

SPIM Integration Parts Administration

Note: If you don't find the Item Master section on the Parts Search for Admin page, contact My Oracle Support to enable the Oracle CX Sales Product Information Master (SPIM) parts integration. You will need to provide your Oracle CX Sales site URL in the request.

  • CPQ administrators can still import and add new CPQ parts, but parts originated in CPQ are not synchronized with Oracle CX Sales.
  • For parts synchronized from the Oracle CX Sales Product Master, CPQ administrators can only view and provide translations for the integrated items. Synchronized parts can only be modified and deleted in the Oracle CX Sales application.
  • When Oracle CX Sales Product Information Master (SPIM) integration is enabled, existing CPQ parts that have the same part number as an Oracle CX Sales Product Master part will be synchronized, and thus become read-only in CPQ.
  • If a new part is added to the Oracle CX Sales Product Master and the part number matches an existing CPQ part, it will be synchronized, and thus become read-only in CPQ after the next synchronization.

To access synchronization details and controls, click the Integration button on the Parts Administration page. Synchronization details are displayed for both parts/items and BOM hierarchies/structures.


ClosedParts Synchronization Status and Details

The Part Sync section shows the overall part synchronization status and lists details for the last five of part synchronization jobs.

Parts Synchronization Details

Schedule Details

Current Sync Status

Indicates whether the synchronization scheduling is active, complete, or paused.

Sync Frequency

Indicates how often synchronization will occur, the default value is 24 hours.

Sync Status

Indicates whether the previous parts synchronization was successful.

Last Data Sync Date

The date and time when the previous parts synchronization finished.

Part Sync Request

The following details are displayed for the for the last five of part synchronization jobs.

Request Date

The date and time when the applicable parts synchronization job started.

Completion Date

The date and time when the applicable parts synchronization job finished.

Current Status

Indicates whether the applicable parts synchronization job was successful.

Failed Records

The number of parts that failed to synchronize in the applicable parts synchronization job.

  • "0" is displayed when all parts are successfully synchronized.
  • If part synchronization failures occur, administrators can click the applicable log link to view the synchronization log.
  • When enabled, BOM Sync will be initiated after Parts Sync regardless of part synchronization failures.

Log

Provides synchronization details for the applicable synchronization job.

Click the Sync Control Pause button to suspend the currently scheduled synchronization. When the synchronization is resumed:

  • A new part synchronization will begin immediately. Either a full synchronization or delta synchronization will occur.
  • The next part synchronization will initiate after a pre-defined interval, measured from the time the previous synchronization was initiated.

ClosedUnified BOM Synchronization Status and Details

When the Unified BOM Sync is enabled BOM synchronization details and controls are displayed below the part synchronization section on the integration page.

BOM Synchronization Details

If required, Oracle CPQ administrators can click the BOM Sync Request Start button to initiate a synchronization before the scheduled synchronization. If there is an active parts synchronization administrators will be prompted to wait for competition of the current synchronization before initiating a new BOM synchronization.

BOM Sync Request

Sync Status

Indicates whether the previous BOM synchronization was successful.

Last Data Sync Date

The date and time when the previous BOM synchronization finished.

The following details are displayed for the for the last five of BOM synchronization jobs.

Request Date

The date and time when the applicable BOM synchronization job started.

Completion Date

The date and time when the applicable BOM synchronization job finished.

Current Status

Indicates whether the applicable BOM synchronization job was successful.

Failed Records

The number of BOM items that failed to synchronize in the applicable BOM synchronization job.

  • "0" is displayed when all BOM items are successfully synchronized.
  • If BOM synchronization failures occur, administrators can click the log link to view the synchronization log.
  • When enabled, BOM Sync will be initiated after Parts Sync regardless of part synchronization failures.

Log

Provides synchronization details for the applicable synchronization job.


ClosedSynchronization Behavior

Administration

ClosedEstablish Oracle CX Sales SPIM as the Products Source for an Oracle CX Sales – Oracle CPQ Products Integration

The following procedures will establish Oracle CX Sales Product Information Master (SPIM) as the Products Source for an Oracle CX Sales – Oracle CPQ Products Integration.

ClosedView Current Parts Source in Oracle CPQ:

ClosedEnter the Integration User Credentials

ClosedSet Up Unified Products Sync Configuration Options


ClosedCreate and Map CPQ BOM Tables

CPQ BOM tables and mapping are required to enable synchronization of Oracle CX Sales product structures and components to CPQ.

Complete the following procedure to create and map CPQ BOM tables.

  1. Log into Oracle CPQ as a parts administrator or as a Full Access user.

  2. Navigate to Admin > BOM > BOM Tables.

  3. Check the Select All checkbox and click Save.

  4. Complete the following to download each of the table definitions:

    1. Click on the applicable BOM table link.

    2. Click the Download Sample link.

    3. Click Cancel to return to the Bills of Materials Tables page.

  5. Navigate to Admin > Data Tables.

  6. Add a BOM Tables data folder.

    1. From the Admin Toolbar, click on the Add Folder icon.

    2. Enter BOM Tables for the folder Name.

    3. Click inside the Variable Name field.

    4. Click OK.

  7. Complete the following to import and deploy each of the data table definitions downloaded in Step 4:

    1. Select Import from the from the side navigation panel menu drop-down.

    2. Drag the applicable Zip file into the "Drop files here or click to upload .csv .txt or .zip" area.

    3. Select BOM Tables from the Destination Folder drop-down.

    4. Click Import and wait for the Import dialog to close.

    5. Double-click on the newly created data table.

    6. Click on the Schema tab.

    7. Check the Index and Key checkboxes for the VariableName row.

    8. Click Deploy.

    9. Click OK and wait for the Deploy dialog to close.

  8. Navigate to Admin > BOM > BOM Tables.

  9. Complete the following to map each of the BOM data tables imported in Step 7:

    1. Click on the applicable BOM table link.

    2. Select the matching BOM data table from the Table Name drop-down.

    3. If Column Mappings are all automatically mapped, click Save and then click Cancel.

    4. If Column Mappings are not mapped; select the matching data table columns from the unmapped Column Mapping drop-down, click Save and then click Cancel.

  10. Check Select All in the Active column, and then click Save.

ClosedBOM/Structure Attribute Mapping

The following table shows the mapping between Oracle CX Sales and the CPQ BOM Item Definition table fields.

SPIM Attribute

SPIM Example

Mapping Action

CPQ Attribute

CPQ Example/Comments

Hashkey(ComponentPath+ComponentItemNumber)

09335b122d37febe8bff6846eb5d4568e9326d2c5f2e305073ff01f359b18140

Computed

variableName

09335b122d37febe8bff6846eb5d4568e9326d2c5f2e305073ff01f359b18140

Hashkey(ComponentPath)

6feb7dba6dafaad59f919895a403b36f62712b7dc171a32d2a2050a607286145

Computed

parentVariableName

6feb7dba6dafaad59f919895a403b36f62712b7dc171a32d2a2050a607286145

Hashkey(ComponentPath[0])

e01b40ffc191a57f3f3d2efeedb3aed82265ab8f1454f02ef00f44bfc63bfd5c

Computed

rootVariableName

e01b40ffc191a57f3f3d2efeedb3aed82265ab8f1454f02ef00f44bfc63bfd5c

Quantity

 

Mapped

defaultQuantity

 

StartDateTime

2017-07-26

Mapped

effectiveFrom

2017-07-26T00:00:00Z

EndDateTime

2017-07-27

Mapped

effectiveTo

2017-07-27T00:00:00Z

Equivalent PIM attribute does not exist.

 

Not Mapped

isIncludedInBasePrice

Note:This value will be set to “N”.

Equivalent PIM attribute does not exist.

 

Not Mapped

isManufacturingItem

Note:This value will be set to “N”.

OptionalFlag

true / false

Mapped

isOptional

Y/N

Equivalent PIM attribute does not exist.

 

Not Mapped

isRootModel

Note:This value is set to “Y” for Root models, and “N” for all child models.

CustomerOrderEnabledFlag

true / false

Mapped

isSalesItem

Y/N

ComponentItemId

300100545999948

Mapped

itemIdentifier

300100545999948

ComponentStructureItemTypeValue(BomItemType)

Model / Standard / Option Class

Mapped

itemType

Model / Standard / Option Class

(ComponentPath+ComponentItemNumber)

FOS-Home Appliances> Lighting equipment OC> Exhaust Fan

Mapped 

Label

Exhaust Fan

Equivalent PIM attribute does not exist.

 

Not Mapped

modelPath

Note:This value will be left empty.

ComponentItemNumber

Exhaust Fan

Mapped

partNumber

Exhaust Fan

ItemSequenceNumber

10 / 20 / 30

Mapped

sequenceNumber

10 / 20 / 30

Equivalent PIM attribute does not exist.

 

Not Mapped

bomPrice

Note: This value will be set to 0,0


Notes:


 

Notes

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

Note: Refer to Partner Parts Integration for information about Oracle Product Information Management (PIM) integration.

 

Related Topics

Related Topics Link IconSee Also