Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

The Content Recommender module provides relevant content based on the user's journey in real time. It allows for assigning scores based on page visits or how the user interacts with your content, such as, clicking links or playing media.

Status INCUBATOR
TypeJar
SubVisual App
JIRARECOMMEND
Gitrecommender

Installation

Maven is the easiest way to install the modules. Add the following dependency to your bundle:

<dependency>
  <groupId>info.magnolia.recommendation</groupId>
  <artifactId>magnolia-recommender</artifactId>
  <version>${recommenderVersion}</version>
</dependency>

Versions

1.0.1Magnolia 5.6.2

Usage

Scoring helps to identify interest in certain products, product groups, services, or topics. The identified interest scores help you to display personalized experiences.

Understanding score models

Score models identify a customer's interest when they browse your site. Their interest is captured in the form of interest points. For example, events like clicking links or page visits indicates interest on certain topics. Watching a video or interaction with the page may indicate even higher interest. These important events make up a dimension of the score model.

Not every interaction indicates the same amount of interest. Therefore you can adjust the number of value points to be assigned per specific event. Score assignment can be fine-tuned by first visit, recency, and frequency. For example, frequent and recent visits normally indicate a strong interest in a topic and should be weighted higher than points assigned for a first time visit.

Together these events, and their weights, along with frequencies make up the score model.

Score Models app

The Score Models app is where you create and manage models. It's a good idea to arrange your models into folders. Perhaps Products, Campaigns, and/or Special offers.

When creating models pick a non technical name that is understandable for your editors and marketeers. Additionally, you can give the model a description to explain what you intend to classify. There is also a dependencies tab that gives you an overview where your model is currently in use. This includes score models assigned for page views as well as component interactions.

Assigning score models

Score models can be assigned in a couple different ways. In both cases scoring is assigned in the Pages app.

  • Page view scoring is handled in the browser subapp. Click Edit Score Model, then assign points for visiting that page.
  • Interacting with components scoring is handled in the page editor. Use the Score model assignment tab in the component dialog.

Integrating score models

The module provides requires some integration into you templating project.

Javascript

The recommender.js script handles the persistence of the scoring on the browser side. Be sure to include this file provided by the content recommender module.

<script type="text/javascript" charset="utf-8" async="" src="/.resources/magnolia-recommender/webresources/js/recommender.js"></script>

Templating functions

The recommender.js script relies on HTML tags to understand which interactions should be tracked. The required tags can be generated with the help of the RecommenderTemplatingFunctions. They are available in the scorefn templating functions.

For example to enable page visit events, add the following to the HTML <head> section.

${scorefn.getPageVisitMetaTags(content)}

Scoring components

For specific components extend the component dialog. You can do so by including the scoreModel.yaml file. 

form: 
  tabs:
    - !include:/magnolia-recommender/dialogs/scoreModel.yaml
Next you need to generate the tags in your element by using the scorefn function.
<a class="yourButton" ${scorefn.getComponentScoreModelMetaTag(content)}>...

Using centralized analytics

The recommender module is not collecting any analytics data. However, integration into your existing analytics solution is straight forward.  Extend the recommender.js file and add custom tracking events in the MgnlScoreModel#trackEvent() method.

Here are some links that should help determine how to add the events.

Warnings

  • This module is at INCUBATOR level. It has had limited testing and low adoption.

Changelog

  • Version 1.0.1 - Initial release of the extensions version of the module.
  • No labels