The items installed with Commerce Connect

Abstract

View the items that are installed in Sitecore when you install the Commerce Connect package.

When you install the Commerce Connect package in Sitecore, a number of items are installed.

This topic describes the installed items in the following sections:

Finding Commerce Connect items in the Content Editor

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

Item type	Item 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`
Engagement automation plan folder	`/sitecore/system/Marketing Control Panel/Engagement Plans/CommerceConnect`
Engagement automation actions	`/sitecore/System/Settings/Analytics/Engagement Automation/Predefined items/Actions/CommerceConnect`
Experience Analytics Dimensions	`/sitecore/system/Marketing Control Panel/Experience Analytics/Dimensions/Connect`
Engagement automation conditions	`/sitecore/System/Settings/Rules/Definitions/Elements/CommerceConnect Workflows`
Templates	`/sitecore/Templates/CommerceConnect`
Branch templates	`/sitecore/Templates/Branches/CommerceConnect`

In addition, a number of Experience Analytics reports that specifically handle data from Sitecore Commerce Connect are installed with Commerce Connect.

Commerce Connect 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 shows details of the Commerce Connect page events, goals and outcomes.

Service layer the item belongs to	Item Type	Item Name	Data Stored with the Item
Cart	Page event	Cart Created	`ExternalId, UserId, CartName, CartStatus`
Cart	Page event	Cart Deleted	`ExternalId (Cart ID), UserId, CartName, CartStatus`
Cart	Page event	Cart Locked	`ExternalId, UserId, CartName, CartStatus`
Cart	Page event	Cart Resumed	`ExternalId, UserId, CartName, CartStatus, PreviousState`
Cart	Page event	Cart Unlocked	`ExternalId, UserId, CartName, CartStatus`
Cart	Page event	Cart Updated	`CustomerId, CartName, ShopName`
Cart	Page event	Lines Added To Cart	`ListOfCartLines (ProductId, Quantity, Price)`
Cart	Page event	Lines Removed From Cart	`ListOfCartLines (ProductId, Quantity, Price)`
Cart	Page event	Lines Updated On Cart	`ListOfCartLines (ProductId, Quantity, Price)`
Cart	Outcome	Abandoned Cart	`Shopname, Cart ID, Cart and Cart Total`
Catalog	Page event	Visited Category Page	`Catalog Name, Category Name`
Catalog	Page event	Facet Applied	`Facet name, Applied (boolean)`
Catalog	Page event	Product Sorting	`Sort key, Sort direction (ASC/DSC)`
Catalog	Page event	Visited Product Details Page	`Product ID, ProductName, ParentCategoryName, ShopName, ParentCategoryID`
Customers and Users	Page event	Customer Account Deleted	`CustomerName, ShopName`
Customers and Users	Page event	Customer Account Disabled	`CustomerName, ShopName`
Customers and Users	Page event	Customer Account Enabled	`CustomerName, ShopName`
Customers and Users	Page event	Customer Account Updated	`CustomerName, ShopName`
Customers and Users	Page event	User Account Deleted	`UserName, ShopName`
Customers and Users	Page event	User Account Disabled	`UserName, ShopName`
Customers and Users	Page event	User Account Enabled	`UserName, ShopName`
Customers and Users	Page event	User Account Updated	`UserName, ShopName`
Customers and Users	Goal	Customer Account Created	`CustomerName, ShopName`
Customers and Users	Goal	User Account Created	`UserName, ShopName`
Globalization	Page event	Culture chosen	`ShopName, Culture ID`
Inventory	Page event	Add To Cart Stock Status	`CartId, UserId, ShopName, ListOfCartLines(ProductId, StockStatus, InStockDate, ShippingDate)`
Inventory	Page event	Back In Stock Subscription	`Product, Email, Location, InterestDate, ShopName`
Inventory	Page event	Back In Stock Unsubscription	`Product, Location, ShopName, VisitorId`
Inventory	Page event	Products Are Back In Stock	`ShopName, ListOfProducts`
Inventory	Page event	Visited Product Stock Status	`ShopName, Product, Location, StockStatus, AvailabilityDate, StockCount`
LoyaltyProgram	Goal	Loyalty Program Joined	`ExternalId, UserId, ShopName, CardNumber`
Orders	Page event	Gift Card Puchase	`Order ID, Gift CardI ID, the order total, the amount used on the gift card and the remaining amount`
Orders	Page event	Loyalty cart Puchase	`Order ID, Order Total, Loyalty CardID, Loyalty program ID (if available), Loyalty points used and the total amount that the loyalty points equals`
Orders	Page event	Order Status Changed	`Order ID, Status (string)`
Orders	Page event	Ordered Product Stock Status	`ProductID, ProductName, StockStatus, InStockDate, ShippingDate, PreOrderable (true/false)`
Orders	Page event	Visitor Cancel Order	`CustomerId, ShopName, OrderId, Total`
Orders	Page event	Visitor Viewed Order Details	`CustomerId, ShopName, OrderId, Total amount`
Orders	Page event	Visitor Viewed Order History	`CustomerId, ShopName`
Orders	Page event	Offline Orders Synchronized	`UserId, ShopName, LastOrderSynchronizedDate, ExternalSystem, NumberOfOrdersSynchronized, SynchronizedOrderIDsList`
Orders	Goal	Visitor Order Created	`ExternalId (Order ID), ShopName, Totals, Order`
Orders	Outcome	Product 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)`
Pricing	Page event	Currency chosen	`ShopName, Currency ID`
WishLists	Page event	Lines Added To WishList	`ExternalId, UserId, WishListName, ShopName, ListOfCartLines(ProductId, Quantity, Price)`
WishLists	Page event	Lines Removed From WishList	`ExternalId, UserId, WishListName, ShopName, ListOfCartLines(ProductId, Quantity, Price)`
WishLists	Page event	Lines Updated On WishList	`ExternalId, UserId, WishListName, ShopName, ListOfCartLines(ProductId, Quantity, Price)`
WishLists	Page event	WishList Created	`ExternalId, UserId, WishListName, ShopName`
WishLists	Page event	WishList Deleted	`ExternalId, UserId, WishListName, ShopName`
WishLists	Page event	WishList Emailed	`ListOfWishLists(ExternalId, UserId, WishListName, ShopName)`
WishLists	Page event	WishList Printed	`ExternalId, UserId, WishListName, ShopName`
[Part of Platform]	Page event	Search	`ShopName, SearchTerm, NumberOfHits`

Commerce Connect personalization rules

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

Service layer	Item name	Description	Rule parameters
Cart	Total Product Quantity Condition	Tests the current quantity of items in the cart against a specified value.	TotalProductQuantity, compares-to operator
Cart	Cart Total Condition	Tests the current cart total against a specified amount.	CartTotal, compares-to operator
Cart	Specific Product Quantity Condition	Tests the current cart content for the quantity of a specified product against a specified value.	ProductId, ProductQuantity, compares-to operator
Inventory	Current Product Stock Count	Tests 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
Inventory	Current Product Stock Count By Location	Tests 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
Inventory	Current Product Stock Status	Tests 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
Inventory	Current Product Stock Status By Location	Tests 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
Inventory	Specific Product Stock Count	Tests the stock count of a specified product against a specified value.	ProductId, StockCount, compares-to operator
Inventory	Specific Product Stock Count By Location	Tests 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
Rules	Has Triggered Page Events	Tests 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.	PageEventName, MinimalNumberOfTimes, TimeRange

Commerce Connect engagement plans, actions, and conditions

Note

Commerce Connect engagement plans are not available in version 9.0 of Commerce Connect. They will be reintroduced in an update to version 9.0.

The table below shows details of the Commerce Connect engagement plans, actions and conditions.

Service layer	Type	Name	Description
Cart	Engagement plan action	SetCartStatusAction	Updates the status of the cart with the specified ID to a given value. Used in Abandoned Cart engagement plan.
Cart	Engagement plan action	TriggerCartAbandonedOutcome	Triggers the Abandoned Cart outcome. Used in Abandoned Cart engagement plan.
Cart	Engagement plan condition	HasEmailCondition	Checks if an email exists for the contact. Used in Abandoned Cart engagement plan.
Cart	Engagement plan condition	HasEmptyCartCondition	Checks if the cart with the specified ID is empty or not. Used in Abandoned Cart engagement plan.
Cart	Engagement plan	Abandoned Cart	Follows up on contacts who visit the storefront and leave a shopping cart with products in it. For contacts with a known e-mail address, a notification e-mail is dispatched to encourage the contact to come back and finalize the purchase. The engagement plan state contains the contact ID and the cart ID.
Catalog	Engagement plan action	RemoveExpiredBackInStockNotificationsAction	Removes expired notification requests. Used in Products Back In Stock engagement plan.
Catalog	Engagement plan action	SendBackInStockNotificationEmailAction	Sends a notification email to contacts when one or more products are back in stock. Used in Products Back In Stock engagement plan.
Catalog	Engagement plan condition	AreProductsBackInStockCondition	Checks if any products out of a list of products are back in stock. Used in Products Back In Stock engagement plan.
Catalog	Engagement plan condition	HasListOfVisitorNotificationsExpiredCondition	Checks if any product notification requests have expired. Used in Products Back In Stock engagement plan.
Inventory	Engagement plan	Products Back In Stock	Handles requests from contacts to be notified when one or more specified products get back in stock. Each request includes a date after which the contact is no longer interested in being notified. When one or more products are back in stock, an e-mail is dispatched to all contacts waiting for notification. The contacts are identified by ID, e-mail, product, interest date, and location when they sign up to be notified. The information is stored in the engagement automation plan state for the contact.
Orders	Engagement Plan	New Order Placed	Engagement plan with only the initial state as default. The plan is meant to be customized to follow-up with post purchase satisfaction surveys and additional promotions to encourage the customer to return and make further purchases. Can also be used to send out mail confirmations
WishLists	Engagement Plan	WishList Created	Engagement plan with only the initial state as default. The plan is meant to be customized to follow-up with e-mail based promotions for products on the wishlist(s) to encourage the customer to return and purchase one or more products.