Library versions

Personalization Library is updated periodically to deliver new capabilities. This page lists the new features, important bug fixes and other updates delivered in each version, as well as provides the guidance about which version you should go for.

๐Ÿ“˜

Best Practice

When a new library version is released, it is a good idea to test and validate it for your channel in a non-Production environment. This will make it easier for you to upgrade to the new version and avail all of its features in your production website.

Library versions

This table provides the currently- supported Personalization Library versions and the corresponding features.
For a detailed list of all the previous Library versions, see this page.

Version

Features

2.2.0
(Latest version)

  • 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 as described in this article.
  • 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 latest 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)

Choosing a Library version

When deploying Personalization Library, you have the following options to choose from:

  • Use the Stable version
  • Use the Latest version
  • Use any specific version

The following table provides a quick comparison between these versions.

StableLatestSpecific
UsageRecommended for first installationUpgrade to this version if already on Stable version and want latest featuresUpgrade to this version if already on Stable and want patch fixes
ProsValidated and tested for common issues and necessary featuresAuto-upgrade when the underlying version changesThe most recent release, hence has all the latest features and bug fixesMore control on the version being used
ConsUsually not the most recent release, hence may not have latest features and bug fixesYet to undergo the incubation period for extensive validationNo auto-upgrades, hence more resource-intensive each upgrade would need to be done manually
FrequencySlower rolloutRelatively frequent rolloutFrequent rollout
Current version1.5.02.2.01.5.0, 1.5.1, 2.0.0, 2.1.0, 2.2.0

Let us understand each of these versions in more detail.

Stable version

The stable version is the one which is tested and validated over an incubation period (usually a month, but it may vary) by the customers to ensure that it addresses most of the frequently encountered issues and 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 the changes to Stable version are announced on this page, you do not need to deploy the new stable version, and should only make necessary changes to zone configuration code, if any.

๐Ÿ“˜

Best Practice

When configuring Acoustic Personalization for the first time, it is recommended that you use the Stable version of the library.

Stable version is usually not the most recent version of the library, and hence may not have all the latest features and the bug fixes. The Stable version has a slower rollout frequency.

Currently, version 1.5.0 is the Stable version.

Latest version

This is most recent version of the library, and it provides all the latest features and bug fixes. Over a period of few months, this version undergoes the incubation period and gradually becomes the Stable version.

Currently, version 2.2.0 is the Latest version.

Specific version

You can install any of the currently supported library versions directly by specifying the version number (and omitting the Stable/Latest attribute). Here are a couple of scenarios when you may want to do so.

  • You are currently on Stable version and want to upgrade to a higher version that has the features or bug fixes you need.
  • The Stable version of the library may internally point to different Library versions over a period of 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 changes to Stable version are announced on the Library versions page, you need to ensure that you also make the necessary changes to zone configuration code, if any. If you do not want this, you can choose any specific version of the Library. This ensures that your Library version isn't upgraded automatically when the Stable version changes, but it also means you would have to upgrade to 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.


Whatโ€™s Next

Here are some of the related topics you can browse through.