1. Set up Commerce Connect

Items installed with Commerce Connect

Version:

This topic describes the items installed in Sitecore with the Commerce Connect package.

Note

The Storefront Abandoned Cart marketing automation campaign is available from Commerce Connect 9.0.2. The New Order Placed marketing automation campaign is available from Commerce Connect 9.2. To use them, you must have installed the Connect Marketing Automation package. For more information, see the Installation Guide.

Finding Commerce Connect items in the Content Editor

Commerce Connect items are installed in the following folders in the Content Editor:

Item typeItem path
Page events/sitecore/System/Settings/Analytics/Page Events/CommerceConnect
Goals/sitecore/System/Marketing Control Panel/Goals/CommerceConnect
Outcomes/sitecore/System/Marketing Control Panel/Outcomes
Conditional renderings/sitecore/System/Settings/Rules/Definitions/Elements/CommerceConnect Conditional Renderings
Marketing automation plan folder/sitecore/system/Marketing Control Panel/Automation Plans
Experience Analytics Dimensions/sitecore/system/Marketing Control Panel/Experience Analytics/Dimensions/Connect
Marketing automation conditions/sitecore/system/Settings/Rules/Definitions/Elements/Commerce - Cart

/sitecore/system/Settings/Rules/Definitions/Elements/Commerce - Email
Templates/sitecore/Templates/CommerceConnect

Page events, goals, and outcomes

To access page events, goals, and outcomes included with Commerce Connect, you need to use the API provided with Commerce Connect. For more information, see the Commerce Connect Developer's Guide.

The table below details the Commerce Connect page events, goals and outcomes.

Note

When Sitecore saves events, goals and outcomes, Sitecore stores the related personal data in contact facets and assigns the facets a PIISensitive attribute (Personally Identifiable Information) so that the facets can be deleted if the customer exercises their right to be forgotten. For more information, see the Privacy Guide.

Service layer the item belongs toItem TypeItem NameData Stored with the Item
CartPage eventCart CreatedExternalId, UserId, CartName, CartStatus
CartPage eventCart DeletedExternalId (Cart ID), UserId, CartName, CartStatus
CartPage eventCart LockedExternalId, UserId, CartName, CartStatus
CartPage eventCart ResumedExternalId, UserId, CartName, CartStatus, PreviousState
CartPage eventCart UnlockedExternalId, UserId, CartName, CartStatus
CartPage eventCart UpdatedCustomerId, CartName, ShopName
CartPage eventLines Added To CartListOfCartLines (ProductId, Quantity, Price)
CartPage eventLines Removed From CartListOfCartLines (ProductId, Quantity, Price)
CartPage eventLines Updated On CartListOfCartLines (ProductId, Quantity, Price)
CartPage eventAbandonedShopname, Cart ID, Cart and Cart Total
CatalogPage eventVisited Category PageCatalog Name, Category Name
CatalogPage eventFacet AppliedFacet name, Applied (boolean)
CatalogPage eventProduct SortingSort key, Sort direction (ASC/DSC)
CatalogPage eventVisited Product Details PageProduct ID, ProductName, ParentCategoryName, ShopName, ParentCategoryID
Customers and UsersPage eventCustomer Account DeletedCustomerName, ShopName
Customers and UsersPage eventCustomer Account DisabledCustomerName, ShopName
Customers and UsersPage eventCustomer Account EnabledCustomerName, ShopName
Customers and UsersPage eventCustomer Account UpdatedCustomerName, ShopName
Customers and UsersPage eventUser Account DeletedUserName, ShopName
Customers and UsersPage eventUser Account DisabledUserName, ShopName
Customers and UsersPage eventUser Account EnabledUserName, ShopName
Customers and UsersPage eventUser Account UpdatedUserName, ShopName
Customers and UsersGoalCustomer Account CreatedCustomerName, ShopName
Customers and UsersGoalUser Account CreatedUserName, ShopName
GlobalizationPage eventCulture chosenShopName, Culture ID
InventoryPage eventAdd To Cart Stock StatusCartId, UserId, ShopName, ListOfCartLines(ProductId, StockStatus, InStockDate, ShippingDate)
InventoryPage eventBack In Stock SubscriptionProduct, Email, Location, InterestDate, ShopName
InventoryPage eventBack In Stock UnsubscriptionProduct, Location, ShopName, VisitorId
InventoryPage eventProducts Are Back In StockShopName, ListOfProducts
InventoryPage eventVisited Product Stock StatusShopName, Product, Location, StockStatus, AvailabilityDate, StockCount
LoyaltyProgramGoalLoyalty Program JoinedExternalId, UserId, ShopName, CardNumber
OrdersPage eventGift Card PurchaseOrder ID, Gift CardI ID, the order total, the amount used on the gift card and the remaining amount
OrdersPage eventLoyalty cart PurchaseOrder ID, Order Total, Loyalty CardID, Loyalty program ID (if available), Loyalty points used and the total amount that the loyalty points equals
OrdersPage eventOrder Status ChangedOrder ID, Status (string)
OrdersPage eventOrdered Product Stock StatusProductID, ProductName, StockStatus, InStockDate, ShippingDate, PreOrderable (true/false)
OrdersPage eventVisitor Cancel OrderCustomerId, ShopName, OrderId, Total
OrdersPage eventVisitor Viewed Order DetailsCustomerId, ShopName, OrderId, Total amount
OrdersPage eventVisitor Viewed Order HistoryCustomerId, ShopName
OrdersPage eventOffline Orders SynchronizedUserId, ShopName, LastOrderSynchronizedDate, ExternalSystem, NumberOfOrdersSynchronized, SynchronizedOrderIDsList
OrdersGoalVisitor Order CreatedExternalId (Order ID), ShopName, Totals, Order
OrdersOutcomeProduct Purchase (Visitor Order Created)Shopname, Order ID (External ID), a cut down order (order header + order lines with product ids and names, line total, subtotal and total)
Note

This is not enabled from Sitecore 9.0.2 to Sitecore 9.2. You can use the Visitor Order Created goal instead.

PricingPage eventCurrency chosenShopName, Currency ID
WishListsPage eventLines Added To WishListExternalId, UserId, WishListName, ShopName, ListOfCartLines(ProductId, Quantity, Price)
WishListsPage eventLines Removed From WishListExternalId, UserId, WishListName, ShopName, ListOfCartLines(ProductId, Quantity, Price)
WishListsPage eventLines Updated On WishListExternalId, UserId, WishListName, ShopName, ListOfCartLines(ProductId, Quantity, Price)
WishListsPage eventWishList CreatedExternalId, UserId, WishListName, ShopName
WishListsPage eventWishList DeletedExternalId, UserId, WishListName, ShopName
WishListsPage eventWishList EmailedListOfWishLists(ExternalId, UserId, WishListName, ShopName)
WishListsPage eventWishList PrintedExternalId, UserId, WishListName, ShopName
[Part of Platform]Page eventSearchShopName, SearchTerm, NumberOfHits

Personalization rules

The table below shows details of the personalization rule conditions that come with Commerce Connect.

Service layerItem nameDescriptionRule parameters
CartTotal Product Quantity ConditionTests the current quantity of items in the cart against a specified value.TotalProductQuantity, compares-to operator
CartCart Total ConditionTests the current cart total against a specified amount.CartTotal, compares-to operator
CartSpecific Product Quantity ConditionTests the current cart content for the quantity of a specified product against a specified value.ProductId, ProductQuantity, compares-to operator
InventoryCurrent Product Stock CountTests the stock count of a product given by the Commerce Context implementation against a specified value. Requires Commerce Context. The default implementation alone throws Not Implemented exceptions.StockCount, compares-to operator
InventoryCurrent Product Stock Count By LocationTests the stock count of a product provided by Commerce Context against a specified value. Also tests for the product being in a specified location. Requires Commerce Context. The default implementation alone throws Not Implemented exceptions.StockCount, Location, compares-to operator
InventoryCurrent Product Stock StatusTests the stock status of a product provided by Commerce Context against a specified status. Requires Commerce Context. The default implementation alone throws Not Implemented exceptions.StockStatus, compares-to operator
InventoryCurrent Product Stock Status By LocationTests the stock status of a product provided by Commerce Context against a specified status. Also tests for the product being in a specified location. Requires Commerce Context. The default implementation alone throws Not Implemented exceptions.StockStatus, Location, compares-to operator
InventorySpecific Product Stock CountTests the stock count of a specified product against a specified value.ProductId, StockCount, compares-to operator
InventorySpecific Product Stock Count By LocationTests the stock count of a specified product against a specified value. The condition also tests for the product being in a specified location.ProductId, StockCount, Location, compares-to operator
RulesHas Triggered Page EventsTests the number of occurrences of a specified page event within a specified time range against a specified value. Not recommended for use in production systems; not optimized as it does not use KeyBehaviorCache, which was introduced with 8.1.PageEventName, MinimalNumberOfTimes, TimeRange

Marketing automation campaigns

Commerce Connect contains default marketing automation campaigns including the Storefront Abandoned Cart marketing automation campaign and the New Order Placed marketing automation campaign. The following table describes items installed for marketing automation campaign.

Service layer the item belongs toItem typeItem nameDescription
CartNew Order Placed campaign templateNew Order PlacedSends an order confirmation email to contacts who have completed a purchase.
CartMarketing Automation campaign templateAbandoned CartFollows up on contacts who visit the storefront and leave a shopping cart with products in it. If a contact has a known email address, Sitecore sends a notification email to encourage the contact to finalize the purchase. The marketing automation campaign stores the cart ID in custom values.
CartMarketing Automation campaign templateWhere Cart Has Been ManipulatedChecks if any actions have been performed on the cart since the contact was enrolled into the campaign or since last checked.
CartMarketing Automation campaign templateWhere Contact Has EmailChecks if an email exists for the contact.
CartMarketing Automation campaign templateWhere Contact Cart Is EmptyChecks whether the cart with the specified ID is empty.
If you have suggestions for improving this article, let us know!