Configuration Integrations

Overview

Admins can create Configuration Integrations for each Product Family to send Configuration data to a partner system when an Integration action is invoked on a Configurator within the Product Family.

A Configuration integration can be created with a partner system that requires Oracle CPQ Configuration data and meets one of the following requirements:

This Configuration integration will be accomplished through an Http Post integration. See the Http Post Integration section for more information.

This Configuration integration will be accomplished through a Custom integration. See the Custom Integration section for more information.

ClosedUse Case: Oracle Commerce On Premise Integration

A Custom Configuration integration is used in CPQ’s integration with Oracle Commerce On Premise (Commerce). In this eCommerce scenario, when an eCommerce customer clicks the Add to Cart Integration action on the Oracle CPQ Configurator, an integration is triggered and the Oracle CPQ configXML file is sent to a Commerce Web Service, which uses the data to add the configured product to a Commerce shopping cart. A redirect URL is also defined within the Configuration integration so that the eCommerce customer is taken to the Commerce shopping cart page when the integration is triggered.

See the topic Oracle Commerce On Premise Integration for more information on the CPQ-Commerce integration.


Administration

ClosedAccessing the Configuration Edit Integration Page

  1. Click Admin to go to the Admin Home Page.
  2. Click Catalog Definition in the Products section.

    The Supported Products page opens.

  3. Confirm that Product Families is selected in the Navigation drop-down menu and click List.

    The  Supported Product Families page opens.

  4. For the Product Family with the integration you want to edit, select Integrations from the Navigation drop-down menu and click List.

    The Edit Integration page opens.


ClosedIntegration Types

The Integration Type selected determines if the integration is active, how the integration is executed, and what options appear on the Edit Integration page.

Integration Type selector

The following options can be selected for Integration Type:

Integration Type Description
None The integration is inactive. Nothing will be sent to a partner system when the Integration action is invoked. The Edit Integration page can still hold values for an Http Post integration, but the integration will not be active unless Http Post is selected for Integration Type.
Http Post A SOAP message (generated by the SOAP Generator XSL that is uploaded by the admin) will be sent to the endpoint URL of the CRM system that Oracle CPQ is integrated with. Oracle CPQ will parse the response from the CRM using the Result Parser XSL file that is uploaded by the admin.
Custom A REST or SOAP payload containing the configXML file of the current Configuration is sent to the partner system’s endpoint URL (defined within a Data Table, see the section Defining the Custom Integration Partner Endpoint URL section for more information) when the Integration action is invoked.

Client-side

This integration type enables the sharing of data between Oracle CPQ and a partner site (e.g. this integration type can be used to enable "Add to Cart" functionality for Oracle CX Commerce).


ClosedHttp Post Integration

Http Post Configuration integrations use SOAP calls to send and receive data with the partner CRM system.

Edit Integration page

The following properties are available on the Edit Integration page when Http Post is selected for Integration Type:

Property Description
Name The displayed name of the Integration action’s button in the Configurator.
Variable Name The variable name of the Integration action that will be used by the system when needed.
Hide in Reconfiguration

Determines whether or not the Integration action will be present on the Configurator during reconfiguration of the product.

  • Yes: The Integration action will be present during reconfiguration of the product.
  • No: The Integration action will be hidden from the user during reconfiguration of the product.
Description An optional description of the integration for admin reference.
ID Field

If Oracle CPQ is integrated with Salesforce, the ID Field must hold the variable name of the Configuration attribute in the Product Family that will map to the Salesforce Opportunity ID.

Note: If Oracle CPQ is integrated with a CRM other than Salesforce, the ID Field will not be on the Edit Integration page.

SOAP Generator XSL The XSL file that will generate the SOAP call sent to the partner system when the Integration action is invoked.
Endpoint URL

The SOAP API Endpoint of the CRM system where the SOAP call will be sent when the Integration action is invoked.

The Endpoint URL for an Http Post Configuration Integration is the same Endpoint URL that is defined for an integration between CPQ’s Commerce module and the CRM system.

To change the Endpoint URL, open a ticket on My Oracle Support.

Result Parser XSL The XSL file that will parse the SOAP response from the CRM.


ClosedCustom Integration

Custom Configuration integrations can use either REST or SOAP calls to send and receive data with the partner system.

Edit Integration page

In the table below, the Endpoint URL field refers to the where the user will be redirected to when the integration is invoked.

The Partner URL, which is added to an Oracle CPQ Data Table, is the literal Partner Endpoint URL where the REST payload will be sent when the integration is invoked.

The terms “Partner URL” and “Endpoint URL” cannot be used interchangeably when discussing custom Product Family integrations.
Property Description
Name The displayed name of the Integration action’s button in the Configurator.
Variable Name The variable name of the Integration action that will be used by the system when needed.
Hide in Reconfiguration

Determines whether or not the Integration action will be present on the Configurator during reconfiguration of the product.

  • Yes: The Integration action will be present during reconfiguration of the product.
  • No: The Integration action will be hidden from the user during reconfiguration of the product.
Description An optional description of the integration for admin reference.
Action

Determines whether or not the integration is active or inactive, and , and what the success and error messages will be for the integration.

  • None: The integration is inactive. Nothing is sent to the Partner URL when the Integration action is invoked. If an Endpoint URL is defined, the destination redirect will still occur when the Integration action is invoked.
  • Define Advanced Function: The integration is active and Oracle CPQ will send a REST or SOAP payload to the partner URL when the Integration action is invoked. The admin must define a BML function to invoke the REST/SOAP payload via urldatabypost (in most cases) and to define the success/error messages of the integration.
Endpoint URL

The location where the user will be directed to after invoking the Integration action in the Configurator.

  • Simple: The admin can define a static URL destination.
  • Define Advanced Function: The admin can define a BML function to determine the URL destination.




ClosedClient-side

Administrators can configure a “Client-side” integration to add the Add to Cart button on a Oracle CX Commerce site. The “Client-side” integration enables the sharing of data between Oracle CPQ and Oracle CX Commerce.

Client-side integration

Property Description
Name The displayed name of the Integration action’s button, e.g. Add to Cart.
Variable Name The variable name of the Integration action that will be used by the system when needed.
Hide in Reconfiguration

Determines whether or not the Integration action will be present on the Configurator during reconfiguration of the product.

  • Yes: The Integration action will be present during reconfiguration of the product.
  • No: The Integration action will be hidden from the user during reconfiguration of the product.

    For Oracle CX Commerce integrations select No
Description An optional description of the integration for admin reference.
Action

Determines whether or not the integration is active or inactive, and , and what the success and error messages will be for the integration.

  • None: The integration is inactive. Nothing is sent to the Partner URL when the Integration action is invoked. If an Endpoint URL is defined, the destination redirect will still occur when the Integration action is invoked.
  • Define Advanced Function: The integration is active and Oracle CPQ will send a REST or SOAP payload to the partner URL when the Integration action is invoked. The admin must define a BML function to invoke the REST/SOAP payload via urldatabypost (in most cases) and to define the success/error messages of the integration.

    For Oracle CX Commerce integrations select Define Advanced Function.
    Click Define Function and use the sample BML to add the Add to Cart button to the Oracle CX Commerce site. Sample BML for Add to Cart button
Endpoint URL

The location where the user will be directed to after invoking the Integration action in the Configurator.

  • Simple: The admin can define a static URL destination.

    For Oracle CX Commerce integrations select Simple.
    Enter the URL of the Oracle CX Commerce site to integrate with CPQ. The value entered should include the basic URL or Oracle CX Commerce’s storefront and administration pages. Administrators can add multiple Oracle CX Commerce sites for a single integration by listing each site delimited by the pipe delimiter (|) character. For example:
    http://cc-store.oracle.com|http://cc-admin.oracle.com|http://second-store.oracle.com|http://second-admin.oracle.com
  • Define Advanced Function: The admin can define a BML function to determine the URL destination.

Notes:

  • The “Add To Cart” BML lists the top-level price as the model price. If administrators want the price to roll-up the prices of all child level items, uncomment lines 85 ( priceTotal = bomTotalPrice + priceTotal; ) and 165 ( priceTotal = priceTotal + atof(sPrice0); )
  • The “Add To Cart” BML references File Manager locations. Administrators must modify the BML on a per site basis.
  • Refer to the Integrating Oracle CX Commerce and Oracle CPQ Implementation Guide for detailed instructions.

Related Topics

Related Topics Link IconSee Also