1. Commerce Connect Reports

Experience Analytics Commerce tab

Version:

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.

Note

The Experience Analytics reports are only available in Commerce Connect version 9.0.2 and later.

The underlying data

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

ReportChartPage event/goalSegmentTable keyMetrics populated
OrdersNumber of ordersVisitor Order CreatedAll ordersOrderIDValue = Order.Total

Visits = SUM(Order.Line.QTY)

Count = 1
OrdersAverage order amountVisitor Order CreatedAll ordersOrderIDValue = Order.Total

Visits = SUM(Order.Line.QTY)

Count = 1
OrdersTotal order amountVisitor Order CreatedAll ordersOrderIDValue = Order.Total

Visits = SUM(Order.Line.QTY)

Count = 1
OrdersTotal order amountVisitor Order CreatedAll ordersOrderIDValue = Order.Total

Visits = SUM(Order.Line.QTY)

Count = 1
OrdersLargest orders by order amountVisitor Order CreatedAll ordersOrderIDValue = Order.Total

Visits = SUM(Order.Line.QTY)

Count = 1
OrdersLargest orders by quantity of itemsVisitor Order CreatedAll ordersOrderIDValue = Order.Total

Visits = SUM(Order.Line.QTY)

Count = 1
OrdersNumber of ordersVisitor Order CreatedAll ordersOrderIDValue = Order.Total

Visits = SUM(Order.Line.QTY)

Count = 1
CampaignsCampaigns by number of ordersVisitor Order CreatedCampaigns by ordersCampaignIdCount = Number of orders

Value = Total value of order for the campaign
CampaignsCampaigns by order amountVisitor Order CreatedCampaigns by ordersCampaignIdCount = Number of orders

Value = Total value of order for the campaign
ProductsProduct details viewedVisited Product Detail PageAll products visitedItemID_ProductIDPageViews = Count([Visited Product Detail Page])
ProductsBestsellersVisitor Order CreatedAll products purchasedSitecoreProductItemID_ ProductIDCount=SUM(Order.Line.QTY)
ProductsMost viewed product detailsVisited Product Detail PageAll products visitedItemID_ProductIDPageViews = Count([Visited Product Detail Page])
ProductsMost viewed product detailsVisited Product Detail PageAll products visitedItemID_ProductIDPageViews = Count([Visited Product Detail Page])
CategoriesCategories viewedVisited Category PageAll categories visitedItemID_CategoryIDPageViews = Count([Visited Category Page])
CategoriesMost viewed categoriesVisited Category PageAll categories visitedItemID_CategoryIDPageViews = Count([Visited Category Page])
CategoriesMost viewed categoriesVisited Category PageAll categories visitedItemID_CategoryIDPageViews = Count([Visited Category Page])
CustomersRegistrationsUser Account CreatedAll user registrationsExternalIDCount = Count([User Account Created)]
CustomersRegistrationsUser Account CreatedAll user registrationsExternalIDCount = Count([User Account Created)]
CustomersTop customers by total order amountVisitor Order CreatedAll customer ordersCustomerIDValue = Sum([OrderTotal])

Count = Count([Order])
CustomersTop customers by number of ordersVisitor Order CreatedAll customer ordersCustomerIDValue = Sum([OrderTotal])

Count = Count([Order])
CustomersCustomers by total order amountVisitor Order CreatedAll customer ordersCustomerIDValue = Sum([OrderTotal])

Count = Count([Order])
CustomersCustomers by number of ordersVisitor Order CreatedAll customer ordersCustomerIDValue = Sum([OrderTotal])

Count = Count([Order])
CustomersTop contacts by total order amountVisitor Order CreatedAll contact ordersUserIDValue = Sum([OrderTotal])

Count = Count([Order])
CustomersTop contacts by number of ordersVisitor Order CreatedAll contact ordersUserIDValue = Sum([OrderTotal])

Count = Count([Order])
CustomersContacts by total order amountVisitor Order CreatedAll contact ordersUserIDValue = Sum([OrderTotal])

Count = Count([Order])
CustomersContacts by number of ordersVisitor Order CreatedAll contact ordersUserIDValue = Sum([OrderTotal])

Count = Count([Order])
Cart linesProducts most frequently removed from the cartLines Removed From CartAll cart removalsProductIDCount=Number of times it was removed.
Shopping Cart ActivityProducts most frequently added to the cartLines Added To CartAll cart additionsProductIDCount=Number of times it was added.
Shopping Cart ActivityProducts most frequently updated on the cartLines Updated On CartAll cart updatesProductIDCount=Number of times it was updated.
Shopping Cart ActivityProduct-quantity most frequently updated on the cartLines Updated On CartAll cart updatesProductIDCount=Number of times it was updated.
Filtering and sortingFacets most frequently appliedFacet AppliedAll facets appliedFacet nameCount=Number of times the fact was applied.
Filtering and sortingSort options most frequently appliedProduct SortingAll sort optionsSort key_Sort directionCount=Number of time the sort options were applied.
Regional settingsRegional settings most frequently appliedCulture ChosenAll cultures selectedCultureCount=Number of times the culture was selected.
Internal searchTop internal keywords that gave the fewest resultsSearchAll search termsSearch termCount=Total number of hits for the search term.
Internal searchTop internal keywords that gave the most resultsSearchAll search termsSearch termCount=Total number of hits for the search term.
Internal searchTop internal keywords that gave the highest revenueSearch event

Visitor Order Created event
All search term purchasesSearch termCount=1
Payment and shippingMost popular shipping methodsVisitor Order CreatedAll Shipping MethodsShippingMethodIDCount=1
Payment and shippingMost popular payment methodsVisitor Order CreatedAll Payment MethodsPaymentMethodIDCount=1
Payment and shippingPayment by gift cardGift Card PurchaseAll gift card purchasesGiftCardPurchase (constant string)Value=Total amount.

Count=Number of gift card purchases.
Payment and shippingPayment by loyalty cardLoyalty Card PurchaseAll loyalty card purchasesLoyaltyCardPurchase (constant string)Value=Total amount.

Count=Number of loyalty card purchases.
Wish list activityProducts most frequently removed from the wish listLines Removed From WishListAll wishlist removalsItemId_ProductIdCount=Number of times it was removed.
Wish list activityProducts most frequently added to the wish listLines Added to WishListAll wishlist additionsItemId_ProductIdCount=Number of times it was added.
Wish list activityProducts most frequently updated in the wish listLines Updated On WishListAll wishlist updatesItemId_ProductIdCount=Number of times it was updated.
Loyalty programsLoyalty program enrollmentLoyalty Program JoinedAll loyalty programs joinedExternalIdCount = Count([loyalty Program Joined)]

Should always be 1.
Loyalty programsMost popular loyalty programsLoyalty Program JoinedAll loyalty programs joinedExternalIdCount = 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:

The ICurrencyConverter interface and DefaultCurrencyConverter class.
Method parameterDescription
transactionDateThe 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.
amountThe amount to be converted.
amountCurrencyThe currency of the current transaction.
requiredCurrencyThe 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:

<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:

<commerce-experienceAnalytics>
      <currencyConverter
       type="Sitecore.Commerce.ExperienceAnalytics.Currency.DefaultCurrencyConverter,
       Sitecore.Commerce.ExperienceAnalytics" />
    </commerce-experienceAnalytics>
If you have suggestions for improving this article, let us know!