Connect multiple personalization accounts

EPiServer.Personalization lets a single Optimizely Commerce (PaaS) installation connect to more than one Personalization Engine instance, that is, multiple personalization accounts. To support multiple personalization accounts,EPiServer.Personalization\ supports the concept of scope, see Multiple scopes.

This example describes how to connect personalization accounts with scopes.

Prerequisites

• An Optimizely Customized Commerce site version 12.4.1 to 13. For Optimizely Customized Commerce version 14, see Install Optimizely (ASP.NET Core).
• Quicksilver sample site, version 12.4.1 or higher (optional).
• EPiServer.Personalization.Common, version 2.0.0 or higher.
• Personalization API base URL, client token, admin token, and site.

Scope settings

You can use scopes in scenarios where you have personalization on multiple sites. If you only have one site with personalization features, you can use scopeless settings.

If you need to configure multiple scopes, the scope name must be the site's SiteDefinitionID. To find that value, log into the Optimizely Content Management System (CMS) and go to Admin mode > Config tab > Manage Websites. CMS versions 11.5.0 and higher show this value for each site. See Muiltiple scopes.

These are some examples of defining and using scopes.

Scopeless settings

Settings with no alias suffix are called scopeless. You can consider settings in earlier versions of the configuration schema as scopeless.

Scopeless settings are a fallback if a requested setting is not defined for a specific scope, meaning the configuration schema is backward compatible.

Personalization with specific scope

The following is an example of using personalization with a specific scope to score search results.

public static IQueriedSearch<TSource, FunctionScoreQuery> 
UsingPersonalization<TSource>(this ISearch<TSource> search, string scope)

Track with specific scope

The following is an example of tracking search with a specific scope, only effective if you installed the EPiServer.Find.Personalization package.

public static ISearch<TSource> Track<TSource>(this ISearch<TSource> search, string scope)

Default implementation

You get a default implementation of the scope feature with the EPiServer.Personalization and EPiServer.Find.Personalization packages. This implementation assumes that each CMS site uses one Commerce (PaaS) catalog and one Personalization Engine instance. If this setup fits your needs, set it up using the configuration only. For a more specialized set up, you need to write custom code.

The default implementation stores preference attribute data in cookies in the same way as earlier versions. If you have a single site using Personalization, you do not need to modify this behavior. To add additional scopes, you probably need to implement your own IPreferenceRepository and modify CUID and SessionID storage behavior. See Muiltiple scopes.

Modify the default behavior

If your installation differs from what is supported by the default implementation, you can write custom code as described below.

Preference attribute data depends on the CUID and SessionID. The Personalization Engine creates this data, and is only valid for the Personalization Engine instance that created them. So, silo these values per scope.

The default implementation stores preference attribute data in cookies bound to the current domain. This implementation covers the common scenario where there are no shared domains between scopes. To support the sharing of two scopes with a single domain, write custom code.

Another possible scenario is splitting an existing scope in two. Do not use existing cookie values for the new scope in this case.

To control how cookies are created and read for a scope, replace the default IPreferenceRepository implementation with your custom implementation. You also need to change the default ICookieService implementation used in EPiServer.Personalization.