Last updated: Jan 09 2019

Area: Episerver Commerce, Episerver Perform Applies to versions: EPiServer.Personalization.Commerce 1.0 and higher

Installing and configuring the native integration package

This topic describes how to configure the native integration for Episerver Commerce. The native integration provides the product-specific setup when implementing personalization for Episerver solutions.


The native integration package is available via the Episerver NuGet feed. See also Install and configure personalization.

After installing it, you must modify the configuration to include settings for your Episerver Perform environment. Recommendations reads its configuration from the <appSettings> section. The following keys are used.

Recommendation keys

Key Description
episerver:tracking.Enabled Indicates if the Tracking system will execute tracking.
episerver:personalization.BaseApiUrl   The URL of the Episerver Perform environment to use. This should only contain the protocol and host name. Note: Never use UAT endpoints in production for this key.
episerver:personalization.Site   The site name used to identify requests to the tracking server.
episerver:personalization.ClientToken   The token used to authenticate tracking requests to the REST API.
episerver:personalization.AdminToken   The token used to authenticate admin requests to the REST API.
episerver:personalization.RequestTimeout   [Optional] Timeout for the REST calls. The default value is 30 seconds.
episerver:personalization.TrackingMode  [Optional] The tracking mode to use. Acceptable values are ServerSide and ClientSide.
To use the client side (JavaScript) tracking APIs, set the value to ClientSide. The default value is ServerSide.

New in Commerce 12.15.1

[Optional] Lets you exclude user IP address from tracking data. Set to True to omit IP address from tracking, which may reduce recommendation accuracy. Default value is False.


New in Commerce 12.15.1

[Optional] Controls whether the pseudonymous user identifier is used instead of user email address in  tracking data. Set to True to omit email address from tracking and use Contact Id instead. Default value is False.
episerver:personalization.CatalogFeedBatchSize   [Optional] The number of products processed in one batch when the product feed is generated. A higher value can be faster but puts more pressure on the memory. The default value is 50.
episerver:personalization.CatalogNameForFeed   [Optional] Selects the catalog used to generate product feed if you have multiple catalogs. If this value is not set, the first catalog is used.
Note: This property will be removed when Product feed support for multiple catalogs is added.

The export function has a few settings in addition to those above. These settings need to be set via code on the default CatalogFeedSettings instance:

var catalogFeedSettings = ServiceLocator.Current.GetInstance<CatalogFeedSettings>();
catalogFeedSettings.DescriptionPropertyName = "...";
Property Description
ExcludedAttributes   Names of product properties to exclude from the catalog feed.
DescriptionPropertyName   The product feed requires each product to have a description. Set this to a property name you want to use as description. Default value is "Description".
AssetGroupName   The first asset in this group is used for the item's image link. The default value is "default".

Do you have feedback on this documentation? Send an email to documentation@episerver.com. For development-related questions and discussions, refer to our Forums on https://world.episerver.com/forum/