Personalization

Library overview

Personalization Library is one of the core components of Personalization. The library identifies the relevant content or recommendations to display on the website.

The library matches personalization rules and visitor behavior data to identify the content. The library receives the visitor behavior data and channel events data from Exchange. It then matches this data with the personalization rules created by the marketer. Based on this comparison, the library suggests results for personalized content. The suggested results are further processed as per the content type. They are then passed over to the channel's content rendering mechanism to be displayed on the zone.

Caching

Caching is a mechanism used by web browsers to store web page resources locally. Caching improves performance and minimizes bandwidth consumption.

The PZN library uses caching to store visitor behavior and events data. The data is stored in the local browser memory as local storage. The information is then used to generate relevant personalization and product recommendations.

When a visitor visits the channel for the first time, the PZN Library is loaded. Data is stored in the LocalStorage variables rulesData and caricatureData for one hour. After one hour, data in these variables is auto refreshed. The latest data is fetched and stored in these variables and used by PZN Library for the next hour. If you use shared audiences, the visitor ID from the library and the X1ID from Exchange are matched during the one-hour interval.

When you publish a new rule in PZN, the personalized content is generated based on that rule. This content is displayed on the channel one hour after the visitor initially loads the page.

Library versions

The PZN library is updated periodically to deliver new capabilities. This table provides the currently- supported Personalization library versions and the corresponding features.
See detailed list of all the previous Library versions.

Tip:

Test the new library version for your channel in a non-production environment. You can validate the library before you apply it to your production website.

Version
Features

2.3 (Latest version)

Exchange capture changes.
Note: After upgrading to this version, ensure that you re-publish all the personalization rules and product recommendation strategies on your channel zones so that the latest updates take effect.

2.2.0

  • Support for the capability to show a header (title) for product recommendation zones on the channel. To use this feature, you must deploy library version 2.2.0 and then configure the zone. For more information, see Configure zones on your channel .
  • Support for personalization using contextual information of the channel visitor.
    Note: After upgrading to this version, ensure that you re-publish all the personalization rules and product recommendation strategies on your channel zones so that the updates take effect.

2.1.0

  • Support for ability to specify dynamic model input sources for product recommendations
  • Support for ability to generate product recommendations based on an individual visitor's behavior on the channel in the current and previous sessions.

2.0.0

Upgrading to this Library version requires changes to zone configuration.

  • Zone configuration made simpler: The getContentID() function for content personalization and getRecommendedProducts() function for product recommendations are now merged into a common getContent() function. This means, you can now use the same code snippet (with minimal changes) for content personalization or product recommendations on a zone.
  • Similarly, capturing click events is made simpler: The trackevent() and trackProduct() functions are now replaced by a common collectBehavior() function.
  • Added support for new content types.

  • Housekeeping updates

    • The jsWrtp object is now changed to PersonalizationLibrary.
    • Caching implementation to reduce the frequent checks for personalization rules.
    • The Local Storage object ibmrtp is now replaced by acousticPZN.
    • Added new helper functions to clear the local storage data

1.5.1

  • Added support for PageView events

1.5.0

(Stable version)

Choose a library version

You can choose to deploy the stable version, latest version, or any specific version. The following table provides a quick comparison between these versions.

Stable
Latest
Specific

Description

The stable version has been tested and validated over a period, usually a month, by the customers. This validation ensures most of the frequently encountered issues are addressed. It provides a reliable experience across all the supported features. When you specify the Stable version, you're auto upgraded when the underlying version changes. For example, currently, the Stable version points to v1.5.0; a few months later, it may point to v2.0.0. When there are changes to the stable version, you do not need to deploy the new stable version. You should only make necessary changes to the zone configuration code if any.

The latest version is the most recent library version with all the latest features and bug fixes. Over few months, this version becomes the Stable version.

Currently, version 2.3.0 is the latest.

You can install any of the currently supported library versions. Specify the version number and omit the Stable/Latest attribute when you install. Here are a couple of scenarios when you may want to install a specific version.

  • You want to upgrade from the stable version to a higher version with the latest features or bug fixes you need.

  • The stable version may point to different library versions after some time. For example, the current Stable version could be v1.50, and a few months later, it may change to v2.0.0. When the stable version changes, you may need to change the zone configuration code. If you do not want to make these changes, you can choose any specific Library version. It ensures that your library version isn't upgraded when the stable version changes. But it also means you would have to upgrade to a newer version manually.

You can install any of the currently supported versions (1.5.0, 1.5.1, 2.0.0, 2.1.0, or 2.2.0) as a specific version.

Usage

Recommended for first installation

Upgrade to this version if already on Stable version and want latest features

Upgrade to this version if already on Stable and want patch fixes

Pros

Validated and tested for common issues and necessary features

Auto-upgrade when the underlying version changes

The most recent release, hence has all the latest features and bug fixes

More control on the version being used

Cons

Usually not the most recent release, hence may not have latest features and bug fixes

Yet to undergo the incubation period for extensive validation

No auto-upgrades, hence more resource-intensive each upgrade would need to be done manually

Frequency

Slower rollout

Relatively frequent rollout

Frequent rollout

Current version

1.5.0

2.3.0

1.5.0, 1.5.1, 2.0.0, 2.1.0, 2.2.0

Updated 7 months ago


Library overview


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.