Third-Party Integrations

Purchases and their updates are automatically pushed to Salesforce.

Incoming purchases will either automatically create a new account or contact in Salesforce, or they will be assigned to an existing account or contact. For this purpose, Cleverbridge applies smart matching algorithms.

Every transaction record has a status. The statuses used in the Cleverbridge system and linked to Salesforce are:

• Awaiting offline payment Offline payment stands for a group of payment options. With the order confirmation, the customer receives a link with information on how to make the payment. Ordered products are delivered as soon as Cleverbridge receives a payment confirmation from the payment provider.
• Paid
• Refunded
• Partially refunded
• Canceled
• Chargeback
• Quote
• Successful test order
• Test order refunded
• Test order partially refunded

The status is updated automatically through purchase events and these updates are pushed to Salesforce.

Price quotes created with the Cleverbridge platform are automatically pushed to Salesforce and will be converted to a paid transaction if the customer accepts the quote.

New and updated partners are automatically pushed to Salesforce.

If a partner signs up using the Cleverbridge signup process, the information about the partner is automatically pushed to Salesforce. In this case, the Cleverbridge system tries to link the partner to an existing account in Salesforce. A new record is created only if it cannot be matched with an existing one.

Cleverbridge offers a system for automatic opportunity management. For every transaction, one opportunity is automatically created and connected to the account.

A second opportunity is created for a product that meets a set of criteria defined in the Cleverbridge system. Example: When a customer purchases a one-year license, the system automatically creates an opportunity for the respective sales person 11 months after the initial purchase. It is the salesperson’s task to convert this opportunity by convincing the customer to renew the license before the existing one expires.

Salesforce Integration Setup is used to configure, view, and edit data for the integration of Salesforce with the Commerce Assistant. To configure the Salesforce Integration Setup, complete the following instructions:

In the main menu, select Setup > Salesforce Integration Setup. Salesforce Integration Setup opens.

Enter information in the following section:

Connection

The Connection section is used to activate the integration and configure the connection between the Cleverbridge platform and Salesforce.

Set up the connection using the fields described below:

Field	Description
Active	Select the checkbox to turn on Salesforce integration. It controls when the integration is actively pushing data. After the configuration, you can stop or resume pushing data at any time with this option.
Username	Enter the Salesforce user's name. This user must have administrative rights in Salesforce.
Password	Enter the Salesforce user's password.
Security token	Enter the user's security token. This is an additional password for accessing the Salesforce API. The token is stored in the user's profile information in Salesforce.
Test connection	Click to verify if the user's credentials are accurately entered. If not, an error message will display and you can try again.
Use sandbox mode	Select to use a secure, replicated testing environment without compromising your production environment.

Synchronization Data

The Synchronization Data section is used to control which types of data are pushed to Salesforce. There are four different options for synchronizing purchases, as well as an option to enable opportunity management and partner synchronization.

1. Select one of the following rules for purchase synchronization:
   • Synchronize all purchases
   • Synchronize purchases that match one of the following conditions:
     • At least one purchased product is from product list
     • Purchase is from a partner
     • Purchase is from a company
   • Do not synchronize purchases
   • Synchronize only test purchases
2. Select to enable opportunity management. When you select this option, an opportunity is created for purchases of products with license expiration dates. This type of opportunity prompts you to remind a customer to renew their license.
3. Select to synchronize accepted partners. When you select this option, all newly accepted partners are pushed to Salesforce.
4. Click Save.

Options

The Options section is used to configure optional currency and pricing information.

1. Select to use a currency type other than the original customer currency type. You can view a different currency type than what the customer sees using this option. Use the drop-down list for currency selections.
2. Select to include the Cleverbridge fee in the client price.
3. Click Save.

Field Mapping

The Field Mapping section is used to define the mapping between Salesforce fields and Cleverbridge fields. The Commerce Assistant offers field mapping tools for six different functional areas. Select from the following sections to set up the field mapping individually for those sections.

• Account
• Contact
• Licensee-expiry opportunity
• Transaction
• Transaction items
• Transaction opportunity

For more information, see One-Way Integration via the Commerce Assistant (Deprecated).

Once you have entered all necessary information, click Save.

To set up field mapping in Salesforce integration setup, complete the following:

1. Click Fetch Object Definitions to populate the fields the first time you connect Salesforce with the Commerce Assistant. This is accomplished by a Cleverbridge API. The fields for data mapping are arranged into two columns:

   Salesforce Field — This column populates with data from Salesforce when you click Fetch Object Definitions. Data are organized into the directory structure used in Salesforce. Highlight these fields to link them to Cleverbridge fields.

   Cleverbridge Field — You fill this column when you select parameters from the Cleverbridge field drop-down list on the right side of the workspace. For more information, see the Field Mapping Details section below.

   

   Note

   The initial synchronization will take up to 30 seconds. Updates to purchase transactions will take up to 120 seconds.

2. Map the fields and their settings.

Enter values for Salesforce fields using the Default value field. You can do this to enter values for Salesforce fields that have no corresponding Cleverbridge fields.

1. Click to highlight a Salesforce field.
2. Select Default value and enter a value in the field. The value you enter populates in the Cleverbridge field column.
3. For fields that have a date format, such as License Expiry, use the Day offset and Month offset drop-down lists to add or subtract days or months from the date.

   

Link Salesforce and Cleverbridge fields using the following steps:

1. Click to highlight a parameter in the Salesforce Field column. In this example, AccountNumber is highlighted in the Salesforce Field column.
2. Select the corresponding Cleverbridge field value from the drop-down list. In this example, CustomerID is selected.

   This merges Cleverbridge fields with Salesforce fields.

   

3. Repeat this process as many times as necessary.

Specify identifying values for fields. Some Salesforce fields have additional field mapping details you can assign values to. For example, the Salesforce field Probability can be set up with Cleverbridge value Quote=75, meaning quotes have a 75% probability for the opportunity.

1. Click to highlight the Salesforce Field for the value assignment.
2. Select the Cleverbridge Field from the drop-down list. The values in this field are used for determining the Salesforce Field values.
3. Click to highlight a Cleverbridge Field Value from the list. In the example below, Quote is selected. Enter a value to assign to this field. In the example below, 75 has been entered. This means opportunities with the status Quote have a 75% probability of conversion.

   

There are two main areas in Salesforce that are linked to the Cleverbridge platform:

Transactions

The Cleverbridge Transactions tab displays a list of recently pushed purchases. Click a transaction to view details.

The transaction detail window displays information about that transaction. You can edit, delete, or clone the transaction from this window.

The individual purchase items display at the bottom of the purchase transaction detail window.

Transaction Items

The Cleverbridge Transaction items tab displays a list of recent purchase items. Click a transaction item to view details.

The transaction item detail window displays information about that transaction item. You can edit, delete, or clone the transaction item from this window.

For more information about transactions in the subscription commerce platform, see Get Transparency about Transactions.

The Cleverbridge dataLayer is added to every page of your checkout process when GTM is enabled. This dataLayer contains information about the cart, session, user, and transaction, all of which you can dynamically insert in your GTM tags. The dataLayer is activated upon every page load, but it can also contain additional information related to certain events. For more information, see Events and the Cleverbridge data Layer.

The following information is available upon every page load of your checkout process if GTM is enabled for your account. The values are inserted dynamically, based on the current user session.

dataLayer = [{
  'transactionId': '51142586',  								// the purchase reference ID
  'transactionAffiliation': 'cleverbridge',					    // source of the purchase
  'transactionTotal': 53.95,									// the total of the transaction revenue
  'transactionTax': 8.61,										// the VAT of the transaction
  'transactionShipping': 0, 									// the shipping cost of the transaction
  'transactionCurrency':  'EUR', 								// the transaction currency ID
  'transactionProducts': [{
    'id' : '2417',												// the Cleverbridge product ID
    'sku' : 'my internal sku',									// your internal SKU
    'category' : 'Software', 									// the product category
    'name' : 'Anti-Malware+%5b2+Years%5d',  					// the product name
    'price' : '53.95',  										// the product price, gross or net
    'quantity' : '1' 											// the product item quantity
  }],
  'customerCurrency':  'EUR',									// the transaction currency ID
  'languageCountry': 'en-DE',									// the customer’s locale
  'coupons' : 'OFF50',										    // coupon code (optional)
  'cleverbridgePage' : 'confirmation.successInstantDelivery',	// page name and detail
  'paymentStatus': 'paid ',									    // the status of the purchase (*)
  'random' : 'rmgP9A3fUMNxANgeuHi8',							// a unique hash per session
  'configParameterName' : 'default',							// the value of cfg= parameter
  'paymentType' : 'CCA_VIS ',									// the payment type (*)
  'x-parameter' : [{											// an array of custom x-parameters
    'x-parameter' : 'customValue'
  }]
}];

* paymentStatus — Possible values are paid, waiting for payment, quote, or test purchase.

* paymentType — For possible values, see Payment Result.

To access the dataLayer values in your GTM tags, you must create a new user-defined variable in your GTM account for each field you want to track. For more information, see User-defined variables.

In certain situations, events containing additional data are added to the dataLayer. You can use these event occurrences as GTM tag triggers. Currently, the following events are available for GTM integration:

cartOpen

This event is triggered when the customer enters the checkout process for the first time.

dataLayer.push({
  'event': 'cartOpen',
  'ecommerce': {
    'currencyCode': 'EUR',
    'add': {
      'actionField': {
        'affiliation': 'cleverbridge',
        'step': 1
      }
      'products': [ {
        'id': '2417',
        'name': 'Anti-Malware+%5b2+Years%5d',
        'price': '53.95',
        'brand': 'brandValue',
        'category': 'categoryValue',
        'variant': 'variantValue',
        'quantity': 1,
        'list': 'listName'
      }],
      'impressions': [ {
        'id': "71028",
        'name': "Recommended Professional",
        'price': "12.95",
        'category': "Consumer Support",
        'variant': "variantValue",
        'position': 1,
        'list': "listName"
      }]
    }
  }
});

checkout

This event is triggered when the customer continues in the checkout process.

dataLayer.push({
  'event': 'checkout',
  'ecommerce': {
    'currencyCode': 'EUR',
    'checkout': {
      'actionField': {
        'step': 1
      },
      'products': [ {
        'id': '2417',
        'name': 'Anti-Malware+%5b2+Years%5d',
        'price': '53.95',
        'brand': 'brandValue',
        'category': 'categoryValue',
        'variant': 'variantValue',
        'quantity': 1,
        'list': 'listName'
      }],
      'impressions': [ {
        'id': "71028",
        'name': "Recommended Professional",
        'price': "12.95",
        'category': "Consumer Support",
        'variant': "variantValue",
        'position': 1,
        'list': "listName"
      }]
    }
  }
});

Note

The field step indicates the step of the checkout process where the customer is currently active. Depending on your design and region, your checkout process may contain multiple steps (cart page, billing details, review page, etc.).

removeFromCart

This event is triggered when a customer removes a product from the cart. The event occurs as soon as the customer clicks the Remove button and before the page reloads.

dataLayer.push({
  'event': 'removeFromCart',
  'ecommerce': {
    'currencyCode': 'EUR',
    'remove': {
      'actionField': {
      'list': 'listName',
    },
    'products': [ {
      'id': '2417',
      'name': 'Anti-Malware+%5b2+Years%5d',
      'price': '53.95',
      'brand': 'brandValue',
      'category': 'categoryValue',
      'variant': 'variantValue',
      'quantity': 1,
      'list': 'listName'       
    }] 
  }
});

addToCart

This event is triggered when a customer adds a recommended product to the cart. This occurs as soon as the customer clicks the Add button and before the page reloads.

dataLayer.push({
  'event': 'addToCart',
  'ecommerce': {
    'currencyCode': 'EUR',
    'add': {
      'actionField': {
        'list': 'listName',
      },
      'products': [ {
        'id': '2417',
        'name': 'Anti-Malware+%5b2+Years%5d',
        'price': '53.95',
        'brand': 'brandValue',
        'category': 'categoryValue',
        'variant': 'variantValue',
        'quantity': 1,
        'list': 'listName'       
      }]
    }
  }
});

submitOrder

This event is triggered when the customer clicks the Buy Now button. It occurs as soon as the customer clicks the button and before the page reloads.

dataLayer.push({
  'event': 'submitOrder',
  'paymentMethod' : 'CCA_VIS'
});

Note

The fact that this event is triggered does not automatically mean that the customer order has been accepted. It is possible that the customer must first correct some validation errors before submitting again.

purchase

This event is triggered when an order is submitted successfully, with or without payment, and the customer reaches the confirmation page The confirmation page is displayed after a customer makes a purchase. The confirmation page contains the order confirmation and delivery information..

dataLayer.push({
  'event' : 'purchase',
  'ecommerce': {
    'currencyCode': 'EUR',
    'purchase': {
      'actionField': {
      'id': '171513018',
      'affiliation': 'cleverbridge',
      'revenue': '53.95',
      'tax':'8.61',
      'shipping': '0',
      'coupon': ''
    },
      'products': [{
        'id': '2417',
        'name': 'Anti-Malware+%5b2+Years%5d',
        'price': '53.95',
        'brand': 'brandValue',
        'category': 'categoryValue',
        'variant': 'variantValue',
        'quantity': 1,
        'list': 'listName' 
      }] 
    }
  }
});

Note

To determine if the order was paid or unpaid, you can use the dataLayer value for the paymentStatus field, which can contain the following values:

• paid -> the order was successfully paid
• waiting for payment -> the customer chose an offline payment method (e.g. wire transfer) and is expected to wire the money soon
• quote -> the customer generated a price quote request that can be turned into a paid order later
• test purchase -> this was a test order using one of the Cleverbridge test credit cards

You can also gain additional insights by analyzing the dataLayer field cleverbridgePage. This can contain the following values on the confirmation page:

• confirmation.reject -> the payment was rejected
• confirmation.pending -> instant processing was not possible and the transaction is scheduled for processing as soon as possible
• confirmation.successOfflinePayment -> same as paymentStatus = waiting for payment
• confirmation.successInstantDelivery -> same as paymentStatus = paid

If the first payment attempt failed or was not processed instantly, Cleverbridge offers the customer a chance to choose a different payment option and try again. In this case, the dataLayer field cleverbridgePage can contain the following status:

• confirmationpp.reject -> the second payment attempt was rejected
• confirmationpp.pending -> the transaction is scheduled for processing as soon as possible
• confirmationpp.successInstantDelivery -> the second payment attempt was successful
• confirmationpp.successOfflinePayment -> the second payment will be completed offline (e.g. wire transfer)

To only trigger a tag when a certain ecommerce event occurs, create a new GTM trigger with the type Custom Event. Under Event Name, add one of the events listed above. For more information, see Custom event trigger.