Configure Document Versioning - Bloomreach Experience - Open Source CMS

Configure Document Versioning

Introduction

Goal

Configure when to create a new version of a document in its version history.

Background

Bloomreach Experience Manager maintains a version history for each document in the content repository. This enables audit tracing of a document's changes over time as well as restoring an older version of a document.

There are two levels of document versioning: basic, coarse-grained versioning and fine-grained versioning. This page describes these two levels of versioning, to which types of document each applies by default, and how to enable fine-grained versioning for any document type.

Basic Versioning

Basic or coarse-grained versioning applies to all regular document types (i.e. not Experience Page Documents) by default. It creates a new version in a document's history on the following events:

  • Publish document
  • Take document offline
  • Restore old version of document

Fine-Grained Versioning

This feature is available since Bloomreach Experience Manager 14.3.0.

Fine-grained versioning applies to Experience Page Documents by default. It creates a new version in a document's history on the following events:

  • Save document in the document editor (either in the Experience manager of in the Content application)
  • Manually create a new version in the document editor (either in the Experience manager of in the Content application)
  • Publish document
  • Take document offline
  • Restore old version of document

As this level of versioning practically tracks every single change made to a document, it is particularly well-suited to implementation scenarios with a requirement for audit tracing.

Enable Fine-Grained Versioning for a Document Type

Fine-grained versioning is enabled for any document that has the mixin hippostdpubwf:audittrace.

Experience Page Documents have this mixin added by default.

To enable fine-grained versioning for all regular documents of a certain document type, add the hippostdpubwf:audittrace mixin to the relevant node type in the CND.

For example, assuming a default implementation project created using the Maven archetype and with the News feature added, fine-grained versioning can be enabled by adding the hippostdpubwf:audittrace mixin to the myproject:newsdocument node type in repository-data/application/src/main/resources/hcm-config/namespace/myproject.cnd:

[myproject:newsdocument] > hippostd:relaxed, hippotranslation:translated, myproject:basedocument, hippostdpubwf:audittrace
  orderable
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?