DocumentationCommerceData Connection extension for Adobe Commerce

Collect Commerce Data using Adobe Experience Platform Tags

Last update: Mon Nov 13 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Admin
  • Developer

While you can use the Data Connection extension to publish and subscribe to storefront events, some merchants might already be using a data collection solution, such as the Adobe Experience Platform tags. For those merchants, Adobe Commerce provides a publishing only option in the Data Connection extension that uses the Adobe Commerce Event SDK.

Data Connection Extension Data Flow
Data Connection Extension Data Flow with Tags

In this topic, you will learn how to map the storefront event values provided by the Data Connection extension to the Adobe Experience Platform tags solution you are already using.

Collect event data from Adobe Commerce

To collect Commerce event data:

Map Commerce storefront data to Adobe Experience Platform

To map Commerce storefront data to Adobe Experience Platform, configure and install the following from within Adobe Experience Platform tags:

  1. Set up a tag property in Adobe Experience Platform Data Collection.

  2. Under Authoring, select Extensions and install and configure the following extensions:

  3. Publish tag to your development environment.

  4. Follow the Event Mapping steps below to configure data elements and rules for specific events.

Event mapping

Because data collection using tags is different from using the Adobe Commerce Event SDK, it is important to understand the equivalent terms used in both frameworks.

Adobe Experience Platform tags term
Adobe Commerce Event SDK term
data elements
context
rules
event
rule conditions - event listeners (from ACDL)

rule actions - event handlers (send to Adobe Experience Platform)

When you update the data elements and rules in Adobe Experience Platform tags with Adobe Commerce-specific event data, there are some common steps you will take.

For example, let’s add the Adobe Commerce signOut event to Adobe Experience Platform tags. The steps outlined below, except for specific values you set, describe how to add data elements and rules, which apply to all Adobe Commerce events you are adding to tags.

  1. Create a Data Element:

    Create New Data Element
    Create New Data Element

  2. Set Name to sign out.

  3. Set Extension to Adobe Experience Platform Web SDK.

  4. Set Data Element Type to XDM object.

  5. Select the Sandbox and Schema that you want to update.

  6. Under userAccount > logout, set the value in Visitor Logout to 1.

    Update Sign out value
    Update Sign out value

  7. Select Save.

  8. Create a Rule:

    Create New Rule
    Create New Rule

  9. Select Add under EVENTS.

  10. Set Extension to Adobe Client Data Layer.

  11. Set Event Type to Data Pushed.

  12. Select Specific Event and set the Event/Key to register for to sign-out.

  13. Select Keep Changes to save the new rule.

  14. Add an action.

  15. Set Extension to Adobe Experience Platform Web SDK.

  16. Set Action Type to Send Event.

  17. Set Instance to Alloy.

  18. Set Type to userAccount.logout.

  19. Set XDM data to %sign out%.

  20. Click Save.

    You created a data element in your schema for the signOut event from Adobe Commerce. Also, you created a rule with a specific action that should occur when that event is fired from the Adobe Commerce storefront.

Repeat the above steps in tags for each of the Adobe Commerce events described below.

Available events

For each of the following events, map the Adobe Commerce events to your XDM by following the above steps.

signOut

Triggered when a shopper attempts to sign out.

Data Elements

Create the following data element:

  1. Sign out:

    • Name: Sign out
    • Extension: Adobe Experience Platform Web SDK
    • Data Element Type: XDM object
    • Field Group: userAccount > logout
    • Visitor Logout: Value = 1

Rules

  • Name: Sign out
  • Extension: Adobe Client Data Layer
  • Event Type: Data Pushed
  • Specific event: sign-out
Actions
  • Extension: Adobe Experience Platform Web SDK
  • Action Type: Send event
  • Type: userAccount.logout
  • XDM data: %sign-out%

signIn

Triggered when a shopper attempts to sign in.

Data Elements

Create the following data elements:

  1. Account email:

    • Name: account email
    • Extension: Adobe Client Data Layer
    • Data Element Type: Data Layer Computed State
    • [Optional] path: accountContext.emailAddress

  2. Account type:

    • Name: account type
    • Extension: Adobe Client Data Layer
    • Data Element Type: Data Layer Computed State
    • [Optional] path: accountContext.accountType

  3. Account ID:

    • Name: account id
    • Extension: Adobe Client Data Layer
    • Data Element Type: Data Layer Computed State
    • [Optional] path*: accountContext.accountId

  4. Sign in:

    • Name: sign in
    • Extension: Adobe Experience Platform Web SDK
    • Data Element Type: XDM object
    • Field Group: person > accountID
    • Account ID: Value = %account id%
    • Field Group: person > accountType
    • Account Type: Value = %account type%
    • Field Group: person > personalEmailID
    • Personal Email Address: Value = %account email%
    • Field Group: personalEmail > address
    • Address: Value = %account email%
    • Field Group: userAccount > login
    • Visitor Login: Value = 1

Rules

  • Name: sign in
  • Extension: Adobe Client Data Layer
  • Event Type: Data Pushed
  • Specific event: sign-in
Actions
  • Extension: Adobe Experience Platform Web SDK
  • Action Type: Send event
  • Type: userAccount.login
  • XDM data: %sign in%

createAccount

Triggered when a shopper attempts to create an account.

Data Elements

Create the following data elements:

  1. Account email:

    • Name: account email
    • Extension: Adobe Client Data Layer
    • Data Element Type: Data Layer Computed State
    • [Optional] path: accountContext.emailAddress

  2. Account type:

    • Name: account type
    • Extension: Adobe Client Data Layer
    • Data Element Type: Data Layer Computed State
    • [Optional] path: accountContext.accountType

  3. Account ID:

    • Name: account id
    • Extension: Adobe Client Data Layer
    • Data Element Type: Data Layer Computed State
    • [Optional] path: accountContext.accountId

  4. Create account:

    • Name: Create account
    • Extension: Adobe Experience Platform Web SDK
    • Data Element Type: XDM object
    • Field Group: person > accountID
    • Account ID: Value = %account id%
    • Field Group: person > accountType
    • Account Type: Value = %account type%
    • Field Group: person > personalEmailID
    • Personal Email Address: Value = %account email%
    • Field Group: personalEmail > address
    • Address: Value = %account email%
    • Field Group: userAccount > createProfile
    • Account Profile Create: Value = 1

Rules

  • Name: Create account
  • Extension: Adobe Client Data Layer
  • Event Type: Data Pushed
  • Specific event: create-account
Actions
  • Extension: Adobe Experience Platform Web SDK
  • Action Type: Send event
  • Type: userAccount.createProfile
  • XDM data: %create account%

editAccount

Triggered when a shopper attempts to edit an account.

Data Elements

Create the following data elements:

  1. Account email:

    • Name: account email
    • Extension: Adobe Client Data Layer
    • Data Element Type: Data Layer Computed State
    • [Optional] path: accountContext.emailAddress

  2. Account type:

    • Name: account type
    • Extension: Adobe Client Data Layer
    • Data Element Type: Data Layer Computed State
    • [Optional] path: accountContext.accountType

  3. Account ID:

    • Name: account id
    • Extension: Adobe Client Data Layer
    • Data Element Type: Data Layer Computed State
    • [Optional] path: accountContext.accountId

  4. Edit account:

    • Name: Edit account
    • Extension: Adobe Experience Platform Web SDK
    • Data Element Type: XDM object
    • Field Group: person > accountID
    • Account ID: Value = %account id%
    • Field Group: person > accountType
    • Account Type: Value = %account type%
    • Field Group: person > personalEmailID
    • Personal Email Address: Value = %account email%
    • Field Group: personalEmail > address
    • Address: Value = %account email%
    • Field Group: userAccount > updateProfile
    • Account Profile Create: Value = 1

Rules

  • Name: Edit account
  • Extension: Adobe Client Data Layer
  • Event Type: Data Pushed
  • Specific event: edit-account
Actions
  • Extension: Adobe Experience Platform Web SDK
  • Action Type: Send event
  • Type: userAccount.updateProfile
  • XDM data: %edit account%

pageView

Triggered when any page loads.

Data Elements

Create the following data elements:

  1. Page name:

    • Name: page name
    • Extension: Adobe Client Data Layer
    • Data Element Type: Data Layer Computed State
    • [Optional] path: pageContext.pageName

Rules

  • Name: page view
  • Extension: Adobe Client Data Layer
  • Event Type: Data Pushed
  • Specific event: page-view
Actions
  • Extension: Adobe Experience Platform Web SDK
  • Action Type: Send event
  • Type: web.webPageDetails.pageViews
  • XDM data: %page view%

productView

Triggered when any product page loads.

Data Elements

Create the following data elements:

  1. Product name:

    • Name: product name
    • Extension: Adobe Client Data Layer
    • Data Element Type: Data Layer Computed State
    • [Optional] path: productContext.name

  2. Product SKU:

    • Name: product sku
    • Extension: Adobe Client Data Layer
    • Data Element Type: Data Layer Computed State
    • [Optional] path: productContext.sku

  3. Product Image URL:

    • Name: product image
    • Extension: Adobe Client Data Layer
    • Data Element Type: Data Layer Computed State
    • [Optional] path: productContext.mainImageUrl

  4. Product currency:

    • Name: product currency
    • Extension: Adobe Client Data Layer
    • Data Element Type: Data Layer Computed State
    • [Optional] path: productContext.pricing.currencyCode

  5. Currency code:

    • Name: currency code
    • Extension: Core
    • Data Element Type: Custom Code
    • Open Editor:
    code language-bash 
    return _satellite.getVar('product currency') || _satellite.getVar('storefront').storeViewCurrencyCode

  6. Special price:

    • Name: special price
    • Extension: Adobe Client Data Layer
    • Data Element Type: Data Layer Computed State
    • [Optional] path: productContext.pricing.specialPrice

  7. Regular price:

    • Name: regular price
    • Extension: Adobe Client Data Layer
    • Data Element Type: Data Layer Computed State
    • [Optional] path: productContext.pricing.regularPrice

  8. Product price:

    • Name: product price
    • Extension: Core
    • Data Element Type: Custom Code
    • Open Editor:
    code language-bash 
    return _satellite.getVar('product regular price') || _satellite.getVar('product special price')

  9. Product view:

    • Name: product view
    • Extension: Adobe Experience Platform Web SDK
    • Data Element Type: XDM object
    • Field Group: productListItems. Select Provide individual items and click the Add item button. Because this view is for a PDP, you can populate with a single item.
    • Field Group: productListItems > name
    • Name: Value = %product name%
    • Field Group: productListItems > SKU
    • SKU: Value = %product sku%
    • Field Group: productListItems > priceTotal
    • Price total: Value = %product price%
    • Field Group: productListItems > currencyCode
    • Currency code: Value = %currency code%
    • Field Group: productListItems > ProductImageUrl
    • ProductImageUrl: Value = %product image%
    • Field Group: commerce > productViews > value
    • value: Value = 1

Rules

  • Name: product view
  • Extension: Adobe Client Data Layer
  • Event Type: Data Pushed
  • Specific event: product-page-view
Actions
  • Extension: Adobe Experience Platform Web SDK
  • Action Type: Send event
  • Type: commerce.productViews
  • XDM data: %product view%

searchRequestSent

Triggered by events in the “search as you type” popover and by events on search results pages.

Data Elements

Create the following data elements:

  1. Search input

    • Name: search input
    • Extension: Adobe Client Data Layer
    • Data Element Type: Data Layer Computed State
    • [Optional] path: searchInputContext.units[0]

  2. Search input phrase

    • Name: search input phrase
    • Extension: Core
    • Data Element Type: Custom Code
    • Open Editor:
    code language-bash 
    return _satellite.getVar('search input').phrase;

  3. Search input sort

    • Name: search input sort
    • Extension: Core
    • Data Element Type: Custom Code
    • Open Editor:
    code language-bash 
    const searchInput = _satellite.getVar('search input');
const sortFromInput = searchInput ? searchInput.sort : [];
const sort = sortFromInput.map((searchSort) => {
    return {
        attribute: searchSort.attribute,
        order: searchSort.direction,
    };
});
return sort;

  4. Search input filters

    • Name: search input filters
    • Extension: Core
    • Data Element Type: Custom Code
    • Open Editor:
    code language-bash 
    
const searchInput = _satellite.getVar('search input');
const filtersFromInput = searchInput ? searchInput.filter : [];
const filters = filtersFromInput.map(
    (searchFilter) => {
        let value = [];
        let isRange = false;
        if (searchFilter.eq) {
            value.push(searchFilter.eq);
        } else if (searchFilter.in) {
            value = searchFilter.in;
        } else if (searchFilter.range) {
            isRange = true;
            value.push(String(searchFilter.range.from));
            value.push(String(searchFilter.range.to));
        }
        return {
            attribute: searchFilter.attribute,
            value,
            isRange,
        };
    }
);

return filters;

  5. Search request:

    • Name: search request
    • Extension: Adobe Experience Platform Web SDK
    • Data Element Type: XDM object
    • Field Group: siteSearch > phrase
    • value: Not yet available
    • Field Group: siteSearch > sort. Select Provide entire object.
    • Field Group: siteSearch > filter. Select Provide entire object.
    • Field Group: searchRequest > id
    • Unique Identifier: Value = %search request ID%
    • Field Group: searchRequest > value
    • value: Value = 1

Rules

  • Name: search request sent
  • Extension: Adobe Client Data Layer
  • Event Type: Data Pushed
  • Specific event: search-request-sent
Actions
  • Extension: Adobe Experience Platform Web SDK
  • Action Type: Send event
  • Type: searchRequest
  • XDM data: %search request%

searchResponseReceived

Triggered when Live Search returns results for the “search as you type” popover or search results page.

Data Elements

Create the following data elements:

  1. Search results:

    • Name: search results
    • Extension: Adobe Client Data Layer
    • Data Element Type: Data Layer Computed State
    • [Optional] path: searchResultsContext.units[0]

  2. Search result number of products:

    • Name: search result number of products
    • Extension: Core
    • Data Element Type: Custom Code
    • Open Editor:
    code language-bash 
    return _satellite.getVar('search result').products.length;

  3. Search result products:

    • Name: search result products
    • Extension: Core
    • Data Element Type: Custom Code
    • Open Editor:
    code language-bash 
    const searchResult = _satellite.getVar('search result');
const productsFromResult = searchResult.products ? searchResult.products : [];
const products = productsFromResult.map(
    (product) => {
        return { SKU: product.sku, name: product.name };
    }
);
return products;

  4. Search result suggestions:

    • Name: search result products
    • Extension: Core
    • Data Element Type: Custom Code
    • Open Editor:
    code language-bash 
    const searchResult = _satellite.getVar('search result');
const suggestionsFromResult = searchResult.suggestions ? searchResult.suggestions : [];
const suggestions = suggestionsFromResult.map((suggestion) => suggestion.suggestion);
return suggestions;

  5. Product Image URL:

    • Name: product image
    • Extension: Adobe Client Data Layer
    • Data Element Type: Data Layer Computed State
    • [Optional] path: productContext.mainImageUrl

  6. Search response:

    • Name: search response
    • Extension: Adobe Experience Platform Web SDK
    • Data Element Type: XDM object
    • Field Group: siteSearch > suggestions. Select Provide entire object.
    • Data element: %search result suggestions%
    • Field Group: siteSearch > numberOfResults
    • value: %search result number of products%
    • Field Group: productListItems. Select Provide entire object.
    • Field Group: productListItems > ProductImageUrl
    • ProductImageUrl: Value = %product image%
    • Data element: %search result products%
    • Field Group: searchResponse > id
    • Unique Identifier: Value = %search response ID%
    • Field Group: searchResponse > value
    • value: Value = 1

Rules

  • Name: search response received
  • Extension: Adobe Client Data Layer
  • Event Type: Data Pushed
  • Specific event: search-response-received
Actions
  • Extension: Adobe Experience Platform Web SDK
  • Action Type: Send event
  • Type: searchResponse
  • XDM data: %search response%

addToCart

Triggered when a product is added to a cart or every time the quantity of a product in the cart is incremented.

Data Elements

Create the following data elements:

  1. Product name:

    • Name: product name
    • Extension: Adobe Client Data Layer
    • Data Element Type: Data Layer Computed State
    • [Optional] path: productContext.name

  2. Product sku:

    • Name: product sku
    • Extension: Adobe Client Data Layer
    • Data Element Type: Data Layer Computed State
    • [Optional] path: productContext.sku

  3. Currency code:

    • Name: currency code
    • Extension: Adobe Client Data Layer
    • Data Element Type: Data Layer Computed State
    • [Optional] path: productContext.pricing.currencyCode

  4. Product special price:

    • Name: product special price
    • Extension: Adobe Client Data Layer
    • Data Element Type: Data Layer Computed State
    • [Optional] path: productContext.pricing.specialPrice

  5. Product Image URL:

    • Name: product image
    • Extension: Adobe Client Data Layer
    • Data Element Type: Data Layer Computed State
    • [Optional] path: productContext.mainImageUrl

  6. Product regular price:

    • Name: product regular price
    • Extension: Adobe Client Data Layer
    • Data Element Type: Data Layer Computed State
    • [Optional] path: productContext.pricing.regularPrice

  7. Product  price:

    • Name: product price
    • Extension: Core
    • Data Element Type: Custom Code
    • Open Editor:
    code language-bash 
    return _satellite.getVar('product regular price') || _satellite.getVar('product special price')

  8. Cart:

    • Name: cart
    • Extension: Adobe Client Data Layer
    • Data Element Type: Data Layer Computed State
    • [Optional] path: shoppingCartContext

  9. Cart id:

    • Name: cart id
    • Extension: Core
    • Data Element Type: Custom Code
    • Open Editor:
    code language-bash 
    return _satellite.getVar('cart').id

  10. Add to cart:

    • Name: add to cart
    • Extension: Adobe Experience Platform Web SDK
    • Data Element Type: XDM object
    • Field Group: productListItems. Select Provide individual items and click the Add item button. Because this view is for a PDP, you can populate with a single item.
    • Field Group: productListItems > name
    • Name: Value = %product name%
    • Field Group: productListItems > SKU
    • SKU: Value = %product sku%
    • Field Group: productListItems > priceTotal
    • Price total: Value = %product price%
    • Field Group: productListItems > currencyCode
    • Field Group: productListItems > ProductImageUrl
    • ProductImageUrl: Value = %product image%
    • Currency code: Value = %currency code%
    • Field Group: commerce > cart > cartID
    • Cart ID: Value = %cart id%
    • Field Group: commerce > productListAdds > value
    • value: Value = 1

Rules

  • Name: add to cart
  • Extension: Adobe Client Data Layer
  • Event Type: Data Pushed
  • Specific event: add-to-cart
Actions
  • Extension: Adobe Experience Platform Web SDK
  • Action Type: Send event
  • Type: commerce.productListAdds
  • XDM data: %add to cart%

openCart

Triggered when a new cart is created, which happens when a product is added to an empty cart.

Data Elements

Create the following data element:

  1. Open cart:

    • Name: open cart
    • Extension: Adobe Experience Platform Web SDK
    • Data Element Type: XDM object
    • Field Group: commerce > productListOpens > value
    • value: Value = 1
    • Field Group: commerce > cart > cartID
    • Cart ID: Value = %cart id%
    • Field Group: productListItems. For productListItems, multiple items can be precomputed. Select productListItems > Provide entire array.

Rules

  • Name: open cart
  • Extension: Adobe Client Data Layer
  • Event Type: Data Pushed
  • Specific event: open-cart
Actions
  • Extension: Adobe Experience Platform Web SDK
  • Action Type: Send event
  • Type: commerce.productListOpens
  • XDM data: %open cart%

viewCart

Triggered when any cart page loads.

Data Elements

Create the following data elements:

  1. Storefront:

    • Name: storefront
    • Extension: Adobe Client Data Layer
    • Data Element Type: Data Layer Computed State
    • [Optional] path: storefrontInstanceContext

  2. Product Image URL:

    • Name: product image

    • Extension: Adobe Client Data Layer

    • Data Element Type: Data Layer Computed State

    • [Optional] path: productContext.mainImageUrl

    1. Cart:

    • Name: cart
    • Extension: Adobe Client Data Layer
    • Data Element Type: Data Layer Computed State
    • [Optional] path: shoppingCartContext

  3. Cart id:

    • Name: cart id
    • Extension: Core
    • Data Element Type: Custom Code
    • Open Editor:
    code language-bash 
    return _satellite.getVar('cart').id

  4. Product list items:

    • Name: product list items:
    • Extension: Core
    • Data Element Type: Custom Code
    • Open Editor:
    code language-bash 
    const storefrontContext = _satellite.getVar('storefront');
const cart = _satellite.getVar('cart');

const returnList = [];
cart.items.forEach(item => {
    const selectedOptions = [];
    item.configurableOptions?.forEach(option => {
        selectedOptions.push({
            attribute: option.optionLabel,
            value: option.valueLabel,
        });
    });

    const productListItem = {
        SKU: item.product.sku,
        name: item.product.name,
        quantity: item.quantity,
        priceTotal: item.prices.price.value * item.quantity,
        currencyCode: item.prices.price.currency ? item.prices.price.currency : storefrontContext.storeViewCurrencyCode,
        selectedOptions: selectedOptions,
    };

    returnList.push(productListItem);
});
return returnList;

  5. View cart:

    • Name: view cart
    • Extension: Adobe Experience Platform Web SDK
    • Data Element Type: XDM object
    • Field Group: productListItems. For productListItems, there can be multiple items that are precomputed. Select productListItems > Populate entire array.
    • Data element: %product list items%
    • Field Group: productListItems > ProductImageUrl
    • ProductImageUrl: Value = %product image%
    • Field Group: commerce > cart > cartID
    • Cart ID: Value = %cart id%
    • Field Group: commerce > productListViews > value
    • value: Value = 1

Rules

  • Name: view cart
  • Extension: Adobe Client Data Layer
  • Event Type: Data Pushed
  • Specific event: shopping-cart-view
Actions
  • Extension: Adobe Experience Platform Web SDK
  • Action Type: Send event
  • Type: commerce.productListViews
  • XDM data: %view cart%

removeFromCart

Triggered when a product is removed from a cart or every time the quantity of a product in the cart is decremented.

Data Elements

Create the following data elements:

  1. Product name:

    • Name: product name
    • Extension: Adobe Client Data Layer
    • Data Element Type: Data Layer Computed State
    • [Optional] path: productContext.name

  2. Product sku:

    • Name: product sku
    • Extension: Adobe Client Data Layer
    • Data Element Type: Data Layer Computed State
    • [Optional] path: productContext.sku

  3. Currency code:

    • Name: currency code
    • Extension: Adobe Client Data Layer
    • Data Element Type: Data Layer Computed State
    • [Optional] path: productContext.pricing.currencyCode

  4. Product special price:

    • Name: product special price
    • Extension: Adobe Client Data Layer
    • Data Element Type: Data Layer Computed State
    • [Optional] path: productContext.pricing.specialPrice

  5. Product regular price:

    • Name: product regular price
    • Extension: Adobe Client Data Layer
    • Data Element Type: Data Layer Computed State
    • [Optional] path: productContext.pricing.regularPrice

  6. Product  price:

    • Name: product price
    • Extension: Core
    • Data Element Type: Custom Code
    • Open Editor:
    code language-bash 
    return _satellite.getVar('product regular price') || _satellite.getVar('product special price')

  7. Cart:

    • Name: cart
    • Extension: Adobe Client Data Layer
    • Data Element Type: Data Layer Computed State
    • [Optional] path: shoppingCartContext

  8. Cart id:

    • Name: cart id
    • Extension: Core
    • Data Element Type: Custom Code
    • Open Editor:
    code language-bash 
    return _satellite.getVar('cart').id

  9. Remove from cart:

    • Name: remove from cart
    • Extension: Adobe Experience Platform Web SDK
    • Data Element Type: XDM object
    • Field Group: productListItems. Select Provide individual items and click the Add item button. Because this view is for a PDP, you can populate with a single item.
    • Field Group: productListItems > name
    • Name: Value = %product name%
    • Field Group: productListItems > SKU
    • SKU: Value = %product sku%
    • Field Group: productListItems > priceTotal
    • Price total: Value = %product price%
    • Field Group: productListItems > currencyCode
    • Currency code: Value = %currency code%
    • Field Group: commerce > cart > cartID
    • Cart ID: Value = %cart id%
    • Field Group: commerce > productListRemovals > value
    • value: Value = 1

Rules

  • Name: remove from cart
  • Extension: Adobe Client Data Layer
  • Event Type: Data Pushed
  • Specific event: remove-from-cart
Actions
  • Extension: Adobe Experience Platform Web SDK
  • Action Type: Send event
  • Type: commerce.productListRemovals
  • XDM data: %remove from cart%

initiateCheckout

Triggered when the shopper clicks a checkout button.

Data Elements

Create the following data elements:

  1. Storefront:

    • Name: storefront
    • Extension: Adobe Client Data Layer
    • Data Element Type: Data Layer Computed State
    • [Optional] path: storefrontInstanceContext

  2. Product Image URL:

    • Name: product image
    • Extension: Adobe Client Data Layer
    • Data Element Type: Data Layer Computed State
    • [Optional] path: productContext.mainImageUrl

  3. Cart:

    • Name: cart
    • Extension: Adobe Client Data Layer
    • Data Element Type: Data Layer Computed State
    • [Optional] path: shoppingCartContext

  4. Cart id:

    • Name: cart id
    • Extension: Core
    • Data Element Type: Custom Code
    • Open Editor:
    code language-bash 
    return _satellite.getVar('cart').id

  5. Product list items:

    • Name: product list items
    • Extension: Core
    • Data Element Type: Custom Code
    • Open Editor:
    code language-bash 
    const storefrontContext = _satellite.getVar('storefront');
const cart = _satellite.getVar('cart');

const returnList = [];
cart.items.forEach(item => {
    const selectedOptions = [];
    item.configurableOptions?.forEach(option => {
        selectedOptions.push({
            attribute: option.optionLabel,
            value: option.valueLabel,
        });
    });

    const productListItem = {
        SKU: item.product.sku,
        name: item.product.name,
        quantity: item.quantity,
        priceTotal: item.prices.price.value * item.quantity,
        currencyCode: item.prices.price.currency ? item.prices.price.currency : storefrontContext.storeViewCurrencyCode,
        selectedOptions: selectedOptions,
    };

    returnList.push(productListItem);
});
return returnList;

  6. Initiate checkout:

    • Name: initiate checkout
    • Extension: Adobe Experience Platform Web SDK
    • Data Element Type: XDM object
    • Field Group: productListItems. For productListItems, there can be multiple items that are precomputed. Select productListItems > Populate entire array.
    • Data element: %product list items%
    • Field Group: productListItems > ProductImageUrl
    • ProductImageUrl: Value = %product image%
    • Field Group: commerce > cart > cartID
    • Cart ID: Value = %cart id%
    • Field Group: commerce > checkouts > value
    • value: Value = 1

Rules

  • Name: initiate checkout
  • Extension: Adobe Client Data Layer
  • Event Type: Data Pushed
  • Specific event: initiate-checkout
Actions
  • Extension: Adobe Experience Platform Web SDK
  • Action Type: Send event
  • Type: commerce.checkouts
  • XDM data: %initiate checkout%

placeOrder

Triggered when the shopper places an order.

Data Elements

Create the following data elements:

  1. Account email:

    • Name: account email
    • Extension: Adobe Client Data Layer
    • Data Element Type: Data Layer Computed State
    • [Optional] path: accountContext.emailAddress

  2. Storefront:

    • Name: storefront
    • Extension: Adobe Client Data Layer
    • Data Element Type: Data Layer Computed State
    • [Optional] path: storefrontInstanceContext

  3. Product Image URL:

    • Name: product image
    • Extension: Adobe Client Data Layer
    • Data Element Type: Data Layer Computed State
    • [Optional] path: productContext.mainImageUrl

  4. Cart:

    • Name: cart
    • Extension: Adobe Client Data Layer
    • Data Element Type: Data Layer Computed State
    • [Optional] path: shoppingCartContext

  5. Cart id:

    • Name: cart id
    • Extension: Core
    • Data Element Type: Custom Code
    • Open Editor:
    code language-bash 
    return _satellite.getVar('cart').id

  6. Order:

    • Name: order
    • Extension: Adobe Client Data Layer
    • Data Element Type: Data Layer Computed State
    • [Optional] path: orderContext

  7. Commerce order:

    • Name: commerce order
    • Extension: Core
    • Data Element Type: Custom Code
    • Open Editor:
    code language-bash 
    const order = _satellite.getVar('order');
const storefront = _satellite.getVar('storefront');

if (order.payments && order.payments.length) {
    payments = order.payments.map(payment => {
        return {
            paymentAmount: payment.total,
            paymentType: payment.paymentMethodCode,
            transactionID: order.orderId.toString(),
        };
    });
} else {
    payments = [
        {
            paymentAmount: order.grandTotal,
            paymentType: order.paymentMethodCode,
            transactionID: order.orderId.toString(),
        },
    ];
}

return {
    purchaseID: order.orderId.toString(),
    currencyCode: storefront.storeViewCurrencyCode,
    payments,
};

  8. Order shipping:

    • Name: order shipping
    • Extension: Core
    • Data Element Type: Custom Code
    • Open Editor:
    code language-bash 
    const order = _satellite.getVar('order');
return {
    shippingMethod: order.shipping.shippingMethod,
    shippingAmount: order.shipping.shippingAmount || 0,
}

  9. Promotion id:

    • Name: promotion id
    • Extension: Core
    • Data Element Type: Custom Code
    • Open Editor:
    code language-bash 
    return _satellite.getVar('order').appliedCouponCode

  10. Product list items:

    • Name: product list items
    • Extension: Core
    • Data Element Type: Custom Code
    • Open Editor:
    code language-bash 
    const storefrontContext = _satellite.getVar('storefront');
const cart = _satellite.getVar('cart');

const returnList = [];
cart.items.forEach(item => {
    const selectedOptions = [];
    item.configurableOptions?.forEach(option => {
        selectedOptions.push({
            attribute: option.optionLabel,
            value: option.valueLabel,
        });
    });

    const productListItem = {
        SKU: item.product.sku,
        name: item.product.name,
        quantity: item.quantity,
        priceTotal: item.prices.price.value * item.quantity,
        currencyCode: item.prices.price.currency ? item.prices.price.currency : storefrontContext.storeViewCurrencyCode,
        selectedOptions: selectedOptions,
    };

    returnList.push(productListItem);
});
return returnList;

  11. Place order:

    • Name: place order
    • Extension: Adobe Experience Platform Web SDK
    • Data Element Type: XDM object
    • Field Group: productListItems. For productListItems, there can be multiple items that are precomputed. Select productListItems > Populate entire array.
    • Data element: %product list items%
    • Field Group: productListItems > ProductImageUrl
    • ProductImageUrl: Value = %product image%
    • Field Group: commerce > order
    • Unique Identifier: Value = %commerce order%
    • Field Group: commerce > shipping
    • Unique Identifier: Value = %order shipping%
    • Field Group: commerce > promotionID
    • Promotion ID: Value = %promotion id%
    • Field Group: commerce > purchases > value
    • value: Value = 1
    • Personal Email Address: Value = %account email%
    • Field Group: personalEmail > address
    • Address: Value = %account email%

Rules

  • Name: place order
  • Extension: Adobe Client Data Layer
  • Event Type: Data Pushed
  • Specific event: place-order
Actions
  • Extension: Adobe Experience Platform Web SDK
  • Action Type: Send event
  • Type: commerce.order
  • XDM data: %place order%

Set identity in storefront events

Storefront events contain profile information based on the personalEmail (for account events) and identityMap (for all other storefront events) fields. The Data Connection extension joins and generates profiles based on these two fields. Each field, however, has different steps to follow to create profiles:

NOTE
If you have a previous setup that relies on different fields, you can continue to use those.
  • personalEmail - Applies to account events only. Follow the steps, rules, and actions outlined above
  • identityMap - Applies to all other storefront events. See the following example.

Example

The following steps show how to configure a pageView event with identityMap in Data Connection extension:

  1. Configure data element with custom code for ECID:

    Configure data element with custom code
    Configure data element with custom code

  2. Select Open Editor and add the following custom code:

    code language-javascript 
    return alloy("getIdentity").then((result) => {
    var identityMap = {
        ECID: [
        {
            id: ecid,
            primary: true
        }
        ],
        email: [
        {
            id: email,
            primary: false
        }
        ]
    };
  _satelite.setVar("identityMap", identityMap);
});

  3. Update XDM schema with identityMap set as ECID:

    Set identityMap as ECID
    Set identityMap as ECID

  4. Define rule actions that retrieve ECID:

    Retrieve ECID
    Retrieve ECID

Set identity in back office events

Unlike storefront events that use ECID to identity and link profile information, back office event data is SaaS-based and therefore no ECID is available. For back office events, you must use email to uniquely identify shoppers. In this section, you will learn how to link back office event data to an ECID using email.

  1. Create an identity map element.

    Back office identity map
    Create back office identity map

  2. Select Open Editor and add the following custom code:

const IdentityMap = {
  "ECID": [
    {
      id:  _satellite.getVar('ECID'),
      primary: true,
    },
  ],
};

if (_satellite.getVar('account email')) {
    IdentityMap.email = [
        {
            id: _satellite.getVar('account email'),
            primary: false,
        },
    ];
}
return IdentityMap;

  1. Add this new element to each identityMap field.

    Update each identityMap
    Update each identityMap

When you install the Data Connection extension in Adobe Commerce, data collection consent is enabled by default. Opt-out is managed through the mg_dnt cookie. You can follow the steps outlined here if you choose to use mg_dnt to manage consent. The Adobe Experience Platform Web SDK documentation has several additional options for managing consent.

  1. Create a Core Custom Code data element (%do not track cookie%) for the mg_dnt cookie:

    Create do not track data element
    Create do not track data element

  2. Create a Core Custom Code data element (%consent%) that returns out if cookie is set and in otherwise:

    Create consent data element
    Create consent data element

  3. Configure Adobe Experience Platform Web SDK Extension with %consent% data element:

    Update SDK with consent
    Update SDK with consent

Warnings

  • Not following steps to turn off Experience Platform collection results in events being double-counted
  • Not setting up mappings/events as described in this topic can affect Adobe Analytics boards
  • You cannot set up Target through the Data Connection extension if data collection is disabled
recommendation-more-help
6bf243c8-c8c6-4074-826f-546af445e840