Experience Analytics Commerce tab - the underlying technology

Version: 8.2

The reports on the Experience Analytics Commerce tab come with Sitecore Commerce Connect. For more information about installing the Commerce Connect package, see http://dev.sitecore.net.

This topic describes some of the technology behind these reports:

The underlying data

The table below shows where the underlying data in the reports come from:

Report	Chart	Page event/goal	Segment	Table key	Metrics populated
Orders	Number of orders	Visitor Order Created	All orders	OrderID	Value = Order.Total Visits = SUM(Order.Line.QTY) Count = 1
Orders	Average order amount	Visitor Order Created	All orders	OrderID	Value = Order.Total Visits = SUM(Order.Line.QTY) Count = 1
Orders	Total order amount	Visitor Order Created	All orders	OrderID	Value = Order.Total Visits = SUM(Order.Line.QTY) Count = 1
Orders	Total order amount	Visitor Order Created	All orders	OrderID	Value = Order.Total Visits = SUM(Order.Line.QTY) Count = 1
Orders	Largest orders by order amount	Visitor Order Created	All orders	OrderID	Value = Order.Total Visits = SUM(Order.Line.QTY) Count = 1
Orders	Largest orders by quantity of items	Visitor Order Created	All orders	OrderID	Value = Order.Total Visits = SUM(Order.Line.QTY) Count = 1
Orders	Number of orders	Visitor Order Created	All orders	OrderID	Value = Order.Total Visits = SUM(Order.Line.QTY) Count = 1
Campaigns	Campaigns by number of orders	Visitor Order Created	Campaigns by orders	CampaignId	Count = Number of orders Value = Total value of order for the campaign
Campaigns	Campaigns by order amount	Visitor Order Created	Campaigns by orders	CampaignId	Count = Number of orders Value = Total value of order for the campaign
Products	Product details viewed	Visited Product Detail Page	All products visited	ItemID_ProductID	PageViews = Count([Visited Product Detail Page])
Products	Bestsellers	Visitor Order Created	All products purchased	SitecoreProductItemID_ ProductID	Count=SUM(Order.Line.QTY)
Products	Most viewed product details	Visited Product Detail Page	All products visited	ItemID_ProductID	PageViews = Count([Visited Product Detail Page])
Products	Most viewed product details	Visited Product Detail Page	All products visited	ItemID_ProductID	PageViews = Count([Visited Product Detail Page])
Categories	Categories viewed	Visited Category Page	All categories visited	ItemID_CategoryID	PageViews = Count([Visited Category Page])
Categories	Most viewed categories	Visited Category Page	All categories visited	ItemID_CategoryID	PageViews = Count([Visited Category Page])
Categories	Most viewed categories	Visited Category Page	All categories visited	ItemID_CategoryID	PageViews = Count([Visited Category Page])
Customers	Registrations	User Account Created	All user registrations	ExternalID	Count = Count([User Account Created)]
Customers	Registrations	User Account Created	All user registrations	ExternalID	Count = Count([User Account Created)]
Customers	Top customers by total order amount	Visitor Order Created	All customer orders	CustomerID	Value = Sum([OrderTotal]) Count = Count([Order])
Customers	Top customers by number of orders	Visitor Order Created	All customer orders	CustomerID	Value = Sum([OrderTotal]) Count = Count([Order])
Customers	Customers by total order amount	Visitor Order Created	All customer orders	CustomerID	Value = Sum([OrderTotal]) Count = Count([Order])
Customers	Customers by number of orders	Visitor Order Created	All customer orders	CustomerID	Value = Sum([OrderTotal]) Count = Count([Order])
Customers	Top contacts by total order amount	Visitor Order Created	All contact orders	UserID	Value = Sum([OrderTotal]) Count = Count([Order])
Customers	Top contacts by number of orders	Visitor Order Created	All contact orders	UserID	Value = Sum([OrderTotal]) Count = Count([Order])
Customers	Contacts by total order amount	Visitor Order Created	All contact orders	UserID	Value = Sum([OrderTotal]) Count = Count([Order])
Customers	Contacts by number of orders	Visitor Order Created	All contact orders	UserID	Value = Sum([OrderTotal]) Count = Count([Order])
Cart lines	Products most frequently removed from the cart	Lines Removed From Cart	All cart removals	ProductID	Count=Number of times it was removed.
Shopping Cart Activity	Products most frequently added to the cart	Lines Added To Cart	All cart additions	ProductID	Count=Number of times it was added.
Shopping Cart Activity	Products most frequently updated on the cart	Lines Updated On Cart	All cart updates	ProductID	Count=Number of times it was updated.
Shopping Cart Activity	Product-quantity most frequently updated on the cart	Lines Updated On Cart	All cart updates	ProductID	Count=Number of times it was updated.
Filtering and sorting	Facets most frequently applied	Facet Applied	All facets applied	Facet name	Count=Number of times the fact was applied.
Filtering and sorting	Sort options most frequently applied	Product Sorting	All sort options	Sort key_Sort direction	Count=Number of time the sort options were applied.
Regional settings	Regional settings most frequently applied	Culture Chosen	All cultures selected	Culture	Count=Number of times the culture was selected.
Internal search	Top internal keywords that gave the fewest results	Search	All search terms	Search term	Count=Total number of hits for the search term.
Internal search	Top internal keywords that gave the most results	Search	All search terms	Search term	Count=Total number of hits for the search term.
Internal search	Top internal keywords that gave the highest revenue	Search event Visitor Order Created event	All search term purchases	Search term	Count=1
Payment and shipping	Most popular shipping methods	Visitor Order Created	All Shipping Methods	ShippingMethodID	Count=1
Payment and shipping	Most popular payment methods	Visitor Order Created	All Payment Methods	PaymentMethodID	Count=1
Payment and shipping	Payment by gift card	Gift Card Purchase	All gift card purchases	GiftCardPurchase (constant string)	Value=Total amount. Count=Number of gift card purchases.
Payment and shipping	Payment by loyalty card	Loyalty Card Purchase	All loyalty card purchases	LoyaltyCardPurchase (constant string)	Value=Total amount. Count=Number of loyalty card purchases.
Wish list activity	Products most frequently removed from the wish list	Lines Removed From WishList	All wishlist removals	ItemId_ProductId	Count=Number of times it was removed.
Wish list activity	Products most frequently added to the wish list	Lines Added to WishList	All wishlist additions	ItemId_ProductId	Count=Number of times it was added.
Wish list activity	Products most frequently updated in the wish list	Lines Updated On WishList	All wishlist updates	ItemId_ProductId	Count=Number of times it was updated.
Loyalty programs	Loyalty program enrollment	Loyalty Program Joined	All loyalty programs joined	ExternalId	Count = Count([loyalty Program Joined)] Should always be 1.
Loyalty programs	Most popular loyalty programs	Loyalty Program Joined	All loyalty programs joined	ExternalId	Count = Count([loyalty Program Joined)] Should always be 1.

The currency converter

The Commerce Experience Analytics dimensions save monetary values as part of the data. These values are saved in the original currency of the orders, which means that if your site supports multiple currencies, the values might be difficult to analyze. However, the Connect Experience Analytics dimensions call a special currency converter to help solve this problem. The converter allows the dimensions to resolve the monetary values in the specific reporting currency that you require.

The default implementation of the currency converter simply returns the original value and therefore it is up to you to supply an implementation that will convert the monetary values accordingly.

Note

In a distributed environment, the code and configuration is on the processing server, and the converter is called just before the dimension data is written to the database.

Use this information to implement the conversion:

Method parameter	Description
transactionDate	The date that the transaction occurred. Use this to determine when the transaction occurred so that you can convert the amount correctly. In Sitecore, you can regenerate the dimension so that this date may represent a past transaction.
amount	The amount to be converted.
amountCurrency	The currency of the current transaction.
requiredCurrency	The currency that you want to convert to.

To create a new currency converter, create a class that implements the ICurrencyConverter interface, implement the Convert method, and then change the configuration in the Sitecore.Commerce.ExperienceAnalytics.config file:

RequestResponse

    <settings>
      <setting name="Commerce.ExperienceAnalytics.ReportingCurrencyCode" value="USD"/>
    </settings>

This defines your reporting currency. The configuration in the following sample identifies the implementation of the currency converter that will be called prior to the dimension data being written to the database:

RequestResponse

    <commerce-experienceAnalytics>
      <currencyConverter
       type="Sitecore.Commerce.ExperienceAnalytics.Currency.DefaultCurrencyConverter, 
       Sitecore.Commerce.ExperienceAnalytics" />
    </commerce-experienceAnalytics>

Do you have some feedback for us?

If you have suggestions for improving this article,