The Configuration Verifier - BloomReach Experience - Open Source CMS
07-01-2019

The Configuration Verifier

Introduction

The BloomReach Experience Manager Configuration Verifier, brXM CV or just CV in short, is a tool to support projects and developers during the upgrade between major BloomReach Experience Manager releases, and is available to BloomReach Experience Manager customers and partners.

The CV supersedes and replaces the earlier Bootstrap Configuration Upgrade Verifier and is available as of BloomReach Experience Manager release version 13. Compared to the earlier Upgrade Verifier, the CV is more versatile and useful beyond just major (product) upgrades; it can also be used to verify and report on project specific configuration changes, at any time!

CV is setup and configured as an extension of an existing BloomReach Experience Manager project, and is available as a standard (enterprise) Maven dependency.

CV runs inside the CMS application and generates a detailed report in YAML format about the differences (deltas) between the current project configuration and an existing (e.g. previous version) repository (database), without (yet) modifying or updating the repository.

The current version of CV only checks for differences between the config definitions of the project configuration (see: Manage Configuration) and the existing repository, but not for changes in the namespaces or in content. Also, CV does not yet have a UI, and the reported differences are not yet correlated with the documented configuration changes of the product.

How it works

CV runs inside the CMS application when it is activated by setting the system property repo.verify.configuration as true. It then uses a different repository initialization to only load the provided CMS project configuration, including the HST platform configuration and additional HST site web app configuration(s). Instead of applying the project configuration, it will then only compare it against the existing repository database, and report all the detected differences in a specific YAML delta format.

The existing repository is not modified (persistently) during this process and also not kept available afterwards for regular usage. After this process has finished, the web container (Tomcat) is stopped again. CV can be run both locally by a developer or remotely on a deployable environment.

Using the Configuration Verifier

Usage of CV is further described in these documents (login required):

Did you find this page helpful?
How could this documentation serve you better?
On this page
    Did you find this page helpful?
    How could this documentation serve you better?