You are here: Integrating With CPQ Cloud > Integration Guides > Configuration Integrations

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 CPQ Cloud 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 Cloud’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 CPQ Cloud Configurator, an integration is triggered and the CPQ Cloud 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 Oracle Commerce On Premise Integration topic for more information on the CPQ Cloud-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 appears.

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

    The Supported Product Families page appears.

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


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.

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 CPQ Cloud is integrated with. CPQ Cloud 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 Defining the Custom Integration Partner Endpoint URL section for more information) when the integration action is invoked.

ClosedHttp Post Integration

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

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 CPQ Cloud 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 CPQ Cloud 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 Cloud’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.

ClosedDefining SOAP Generator XSL and Result Parser XSL Files

ClosedCustom Integration

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

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 a CPQ Cloud 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 CPQ Cloud 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.

ClosedDefining the Custom Integration Partner Endpoint URL
ClosedDefining an Advanced Function for Action
ClosedDefining an Advanced Function for Endpoint URL

NOTES

RELATED TOPICS

Related Topics Link IconSee Also