Documentation Center

Using SDL Web Experience Optimization module

The SDL Web Experience Optimization module uses the concept of Experience Optimization Regions which are modeled based on DXA Region Models.

Once the Experience Optimization module is installed, you can start using example regions:
  • Example1
  • Example2

Creating Experience Optimization Regions

You can define your own Experience Optimization Region in the Experience Optimization Page Template Metadata, under the Region Name field. Once the Experience Optimization Region is created you must create associated Component Templates in Content Manager. Finally, you need to fill in the Region Name field in the Component Template Metadata.

Optionally, if you want to create a custom Region View, you can use the preprovided examples of Experience Optimization Regions Views as a reference. The Experience Optimization Module comes with the SmartTargetRegion single-column, two-column, three-column, and four-column sample Region Views. Experience Optimization Region Views must be then registered with SmartTargetRegion Model type. For more information on View registration, see Setting up an Area (.NET).

Here is an example of code you can use for registration:
RegisterViewModel("PromoRegionTest", typeof(SmartTargetRegion));

Region Models of the SmartTargetRegion type are processed by the Experience Optimization Model Builder, and are filled with SmartTargetPromotion entities. These entities are by default rendered using the Promotion Entity View but you can also configure a custom Promotion View in the Experience Optimization Configuration Component.

Creating a Experience Optimization-enabled Page Template

To create a Experience Optimization-enabled Page, you must first create a Experience Optimization-enabled Page Template which uses Experience Optimization Page Template Metadata schema. Experience Optimization Regions should either use your own custom Experience Optimization Region View or Experience Optimization:Experience OptimizationRegion View.

The Experience Optimization Page Template Metadata schema is an extension of the DXA Page Template Metadata schema, which allows users to define the following Experience Optimization settings on a Page:
  • Whether duplicate Experience Optimization Promotion items are allowed on the Page.
  • The maximum number of items shown in each Experience Optimization Region.

Here is the Experience Optimization-enabled Page template that comes with the Experience Optimization Module:

Creating a Experience Optimization-enabled Page

Experience Optimization-enabled Pages can be made by selecting a Experience Optimization-enabled Page Template.

The Page Template predefines Experience Optimization Regions in its metadata. It is possible to specify fallback content for each Experience Optimization Region by adding Component Presentation to the Experience Optimization Regions, which means adding Component Presentations using a Component Template which is associated with the Experience Optimization Regions.

The Experience Optimization module comes with two example Component Templates that can be used to put (News)Articles as fallback content in the two example Experience Optimization Regions:
  • Article [SmartTarget:Example1]
  • Article [SmartTarget:Example2]