Skip to main content

Configuration

This section describes the configuration options that enable you to control how Uniform personalization operates.

tip

Some configuration can be set in multiple places. In these cases, the order of priority (from low to high) is:

  1. Sitecore config setting
  2. Sitecore module setting
  3. Tracker code

Sitecore config settings#

Some aspects of Uniform personalization can be configured using settings configured in Sitecore config files.

Default emitter#

For more information on emitters, see the Emitters section.

This feature is controlled using the following setting:

Uniform.Optimize.Emitters.Default

The setting value is the name of an emitter. A list of emitters that are available on your Sitecore instance is available under as children of the following item in the Sitecore content database:

  • Item path: /sitecore/system/Uniform/Modules/Optimize/Personalization/Emitters
note

The Sitecore items that represent the emitters are generated automatically when the Sitecore pipeline initialize runs. You cannot manually add or remove these items.

Disable testing#

It is possible to disable personalization testing globally. When testing is disabled, even if active tests are available, no personalization testing will be executed.

This feature is controlled using the following setting:

Uniform.Optimize.Personalization.Esi.TestingDisabled

The following values are supported:

  • false - Personalization testing is performed if an active test is available. This is the default value.
  • true - No personalization testing is performed, even if an active test is available.

Escape rendering markup#

When personalization rules are converted into ESI tags, the markup inside the ESI tags may contain ESI tags of their own. An example is when conditional logic is emitted in a rendering.

However, there are cases where the markup must be escaped. This setting adds an ESI text tag around the markup.

This feature is controlled using the following setting:

Uniform.Optimize.Personalization.Esi.UseRenderingEscapeMarkup

The following values are supported:

  • false - Rendering markup is included without any modification. This is the default value.
  • true - Rendering markup is set inside an esi:text tag when personalization rules are assigned to the rendering.
caution

Enabling this setting means that any nested ESI tags will not be executed by the personalization engine. This means you will see the ESI tags in the page source code.

Sitecore module settings#

Some aspects of Uniform personalization can be configured using fields on items in the Sitecore content database.

Disable emitter#

This setting prevents Uniform from generating any personalization logic. This effectively disables all personalization.

This setting is configured in the following field:

  • Item path: /sitecore/system/Uniform/Modules/Optimize/Settings
  • Field name: Disable emitter

The following values are supported:

  • unticked - Use the emitter specified on the Sitecore instance.
  • ticked - Disable the emitter.

Emitter#

This field overrides the default emitter setting.

This setting is configured in the following field:

  • Item path: /sitecore/system/Uniform/Modules/Optimize/Settings
  • Field name: Emitter

Include personalization dependencies#

Certain personalization conditions depend on a Uniform tracker event occurring. Consider a case where a personalization rule includes a condition that involves pattern matching. Pattern matching is a part of the tracking process, so the personalization rule should not be evaluated until after the tracking process is finished. The Uniform tracker fires an event when the tracking process is finished. This is a case where the personalization rule has a dependency on the "tracking finished" event.

When the tracker event is triggered, that should cause the component with the dependency to be refreshed. This process is called "deferred personalization" because the personalization is delayed until the dependent event is fired. This setting enables support for deferred personalization.

caution

This setting is only compatible with sites built with JSS that use client-side routing (i.e. SPA navigation). If this setting is enabled on an unsupported site, the tracker will not capture personalization activity. For this reason, deferred personalization is disabled by default.

This setting is configured in the following field:

  • Item path: /sitecore/system/Uniform/Modules/Optimize/Settings
  • Field name: Include personalization dependencies

The following values are supported:

  • unticked - Do not include personalization dependencies.
  • ticked - Include personalization dependencies.

Page modes#

Uniform only activates personalization logic when the Sitecore page mode matches one of the modes specified by this setting. This prevents code that runs on the edge from being rendered in cases where the code cannot be executed. By default, only "normal" page mode is enabled.

The following page modes are supported:

  • Experience Editor
  • Normal
  • Preview

This setting is configured in the following field:

  • Item path: /sitecore/system/Uniform/Modules/Optimize/Settings
  • Field name: Page Modes
note

In most cases this value does not need to be changed.