Andreas Ylivainio
Apr 8, 2011
  2728
(0 votes)

Personalization outside of the box (...or HTML-editor)

Coinciding with the release of EPiServer 6 R2 the creative minds at Circuit came up with the idea that a client of ours should have the ability to time control the display of slideshow-like content on their start page, ensuring the slideshow content targeted the appropriate target audience during different times of the day.

Since I knew the personalization in R2 was just around the corner I suggested we use that feature instead of just restricting the editors to selecting a time of day.

Thinking of the editors experience with having to paste HTML and CSS (and JavaScript for older browsers) to make the slideshow work within the editor, we quickly realized we needed to create a method for the editor to pick a Visitor Group and that we as developers of the start page template would render the correct html.

There is however no built-in method to select an arbitrary Visitor Group or to evaluate a Visitor Group match outside of the HTML-editor.

Enter Circuit.PropertyTypes.PropertyVisitorGroup! This custom property renders a dropdown-list of all defined Visitor Groups (using the Dynamic Data Store API) and saves the selected group in a property on the page.

I then hacked together a class named VisitorGroupsHandler used for activating the criterias in the selected Visitor Group and evaluating them. The class has three methods:

MatchAllCriteriasInGroup(VisitorGroup …)
 
MatchAnyCriteriasInGroup(VisitorGroup …)

and

IsMatch(VisitorGroup …) 

which uses both the preceding methods. The functionality does not yet handle points matching.

Here is an example of the MatchAllCriteriasInGroup method, minus argument validation:

public static bool MatchAllCriteriasInGroup(VisitorGroup visitorGroup)
 
{
 
//...
 
            var httpContextBase = new HttpContextWrapper(HttpContext.Current);
 
            foreach (var criteria in visitorGroup.Criteria)
 
            {
 
                var type = Type.GetType(criteria.TypeName, true);
 
                if (typeof(ICriterion).IsAssignableFrom(type))
 
                {
 
                    var criterion = (ICriterion)Activator.CreateInstance(type);
 
                    criterion.Initialize(criteria);
 
                    if (!criterion.IsMatch(httpContextBase.User, httpContextBase))
 
                    {
 
                        return false;
 
                    }
 
                }
 
            }
 
            return true;
 
        }
 
The end result is that the template code can decide what content to display based on the call to:
bool isBusinessVisitor = VisitorGroupsHandler.IsMatch(CurrentPage.BusinessVisitorGroup);
 
// Set active slide based on the isBusinessVisitor value

or when not using Page Type Builder:

bool isBusinessVisitor = VisitorGroupsHandler.IsMatch((PropertyVisitorGroup)CurrentPage["BusinessVisitorGroup"]).
 
// Set active slide based on the isBusinessVisitor value

The source code is downloadable here.

One thing I haven't solved is how to activate the Visitor Group interface when in edit mode to be able to preview the page with the different Visitor Groups used in the property. I will update the post when that is solved.

Feedback is very welcome!

Apr 08, 2011

Comments

smithsson68@gmail.com
smithsson68@gmail.com Apr 8, 2011 05:06 PM

There is an API for checking if the current request matches against a visitor group role.

Add the EPiServer.Personalization.VisitorGroups namespace to your code file then you will get an new overload to the EPiServer.Security.PrincipalInfo.CurrentPrincipal.IsInRole method which takes an enum specifying what type of role to query. One of the enum values is for Visitor Groups.

Apr 8, 2011 05:54 PM

Thank you Paul! That also takes care of the impersonation issues. I also found that implementing the interface IPersonalizedRoles for my property made the Visitor Groups GUI appear.

My public IEnumerable GetRoles() just returns the selected Visitor Group guid.

Please login to comment.
Latest blogs
Preview multiple Visitor Groups directly while browsing your Optimizely site

Visitor groups are great - it's an easy way to add personalization towards market segments to your site. But it does come with it's own set of...

Allan Thraen | Sep 26, 2022 | Syndicated blog

The Report Center is finally back in Optimizely CMS 12

With Episerver.CMS.UI 12.12.0 the Report Center is finally re-introduced in the core product.

Tomas Hensrud Gulla | Sep 26, 2022 | Syndicated blog

Dynamic Route in ASP.NET Core When MapDynamicControllerRoute Does Not Work

Background Creating one of the add-on for Optimizely I had to deal with challenge to register dynamically route for the API controller. Dynamic rou...

valdis | Sep 25, 2022 | Syndicated blog

404 Error on Static Assets Within an Optimizely plugin

Background With the move to CMS 12 and .NET 5/6, developers are now able to build Plugins and Extensions using Razor Class Libraries (RCL).  These...

Mark Stott | Sep 23, 2022