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

Commerce Integrations

OVERVIEW

Admins can create Commerce Integrations for custom integrations with a CRM product other than those that are supported with a default integration (such as Oracle Sales Cloud, Oracle On Demand, or Salesforce).

For supported integrations, the Commerce Integration is provided for you.

Commerce Integrations are also required for integration with the Integration Cloud Service, or ICS. For more information, see Integration Cloud Service.


ADMINISTRATION

ClosedAdding a Commerce Integration

  1. ClosedNavigate to the Integrations page.
  1. Click Admin to go to the Admin Home Page.
  2. Click Process Definition in the Commerce and Documents section.

    The Processes page appears.

  3. For the Commerce Process you want to integrate, select Integration from the Navigation drop-down menu and click List.

    The Integrations page appears.

  1. Click Add.

    The Select Integration Types page appears.

  2. Select a Type
    • Export: Pushes data from CPQ Cloud into a partner system. As an example, export integrations are frequently to push quote PDFs to corresponding opportunities, every time there is a change made to the quote.
    • Import: Pulls data into CPQ Cloud from a partner system. For example, in transactions, typically data that is imported into is accounts data from the partner site.
      1. Accounts mapping is a type of import integration used for the accounts section. It performs all the functions of a regular import integration operation.
    • Query
    • Delete: Delete data on the partner system.
    • Export Attachment:
    • Integration Cloud Service:
  3. Click Next.

    The Edit Integration page appears.

  4. Complete the fields in the Integration Information section.

    Field Name

    Integration Type

    Description
    Name All Field that contains a name or label for the integration specified by the user.
    Variable Name All Unique identifier that cannot by edited after creation.
    Description All Detailed description field.
    ID Field All Field that defines mapping between the partner entity and the entity. For example, suppose that the integration is being set up to import transaction data from the partner. The ID field must contain the variable name of the transaction field (for example, partner_opportunityid_field) into which the incoming data (for example, opportunity id) has to be populated.
    Integration Type All Shows what was chosen on the previous page.
    SOAP Generator XSL Import, Export, Delete, Query Click Browse to select and load a SOAP Generator XSL based into the integration based on your use case.
    Results Parser XSL Import, Export, Delete Click Browse to select and load a Results Parser XSL based into the integration based on your use case.
    Transaction ID Import, Export Debugger field for the Transaction ID.
    Document Export Menu of main document of the process.
    Document Number Export Debugger field for document number (typically line item document).
    Endpoint URL I, E  

  5. Click Add.

USE CASES

ClosedUse Case: Import Integration

Assume that your company uses Salesforce.com and you are trying to integrate transaction data between the CPQ Cloud and Salesforce. Perform the following steps in CPQ Cloud.

  1. Create a Document Attribute.
    1. ClosedNavigate to the Attribute List page.
    1. Click Admin to go to the Admin Home Page.
    2. Click Process Definition in the Commerce and Documents section.

      The Processes page appears.

    3. For the process you are interested in, confirm that Documents is selected in the Navigation drop-down menu, and click List.

      The Document List page appears.

    4. For the main document, confirm that Attributes is selected in the Navigation drop-down menu, and click List.

      The Attribute List page appears.

    1. Create an attribute to represent a Salesforce opportunity id field in the quote document with a variable name sfOpportunityId_quote.

      Assume that the main document (quote) is integrating with an opportunity in Salesforce.

  2. Create an action to trigger the integration.
    1. ClosedNavigate to the Action List page.
    1. Click Admin to go to the Admin Home Page.
    2. Click Process Definition in the Commerce and Documents section.

      The Processes page appears.

    3. For the process you are interested in, confirm that Documents is selected in the Navigation drop-down menu, and click List.

      The Document List page appears.

    4. For the main document, confirm that Actions is selected in the Navigation drop-down menu, and click List.

      The Action List page appears.

    1. Create an action, called Save and Synch, that will be used to trigger the integration.
  3. Create an integration.
    1. ClosedNavigate to the Integrations page.
    1. Click Admin to go to the Admin Home Page.
    2. Click Process Definition in the Commerce and Documents section.

      The Processes page appears.

    3. For the Commerce Process you want to integrate, select Integration from the Navigation drop-down menu and click List.

      The Integrations page appears.

    1. Click Add.
    2. Select Import (Query Generator and Result Parser) and then click Next.
    3. Enter the name Import Opportunity and the variable name imp_opp for the integration.
    4. In the ID Field field, enter the variable name for the attribute you created in Step 2.
      1. Content in the ID Field field should be in the format <document_var_name>.<att_var_name>. For example: quote.sfOpportunityId_quote.
    5. Click Browse to select and load a SOAP Generator XSL into the integration, based on your use case.

        The partner opportunity id is contained in the transaction’s sfOpportunityId_quote field (ID Field in the integration).

    6. Click Browse to select and load a Result Parser XSL into the integration, based on your use case.

      The result parser converts one XML format into another. If the partner system returns a valid id, then CPQ Cloud populates the transaction field projectname_quote with the name value coming from the partner - sf:Name.

    7. Click Add.
      1. To view the integration, click the Integration name. Preview the SOAP XML by entering a commerce Transaction ID.
  4. Add the integration to the action.
    1. Return to the Commerce action, Save and Synch, and click the Integration tab.
    2. Select Import Opportunity from the Integration List and move it to the Selected Integration list by clicking the right arrow. You can move it above or below other functions.
    3. Click Apply or Update to save changes.
  5. Deploy the Commerce Process.

    A user can trigger the integration for any Transaction on the user-side, by clicking the Save and Synch button.

    1. Clicking Save and Synch must retrieve the opportunity id from the partner and populate the sfOpportunityId field.

TROUBLESHOOTING

ClosedDebugging CRM Integration


NOTES

RELATED TOPICS

Related Topics Link IconSee Also