Fork me on GitHub

Configuring BloomReach Version History Cleaner

Module Configuration Options

BloomReach Version History Cleaner module is located and configured at /hippo:configuration/hippo:modules/version-history-cleaner like the following:

/version-history-cleaner:
  jcr:primaryType: hipposys:module
  hipposys:className: com.bloomreach.forge.versionhistory.core.repository.DocumentHistoryCleanerDaemonModule
  /hippo:moduleconfig:
    jcr:primaryType: hipposys:moduleconfig
    default.max.days: -1
    default.max.revisions: -1
    default.truncate.ondelete: false
          

The following configurations are supported.

Property Name Description Default value
default.max.days The default maximum days to retain a version since its creation date time. For example, if a version was created 10 days ago, and if this property is set to 7 (days), then the version will be removed automatically when the document is published.
If this is set to a negative integer, then this option is ignored.
-1
default.max.revisions The default maximum version count to retain for the document. For example, if there are 10 versions for the document, and if this property is set to 5, then the 5 older versions will be removed automatically when the document is published, keeping the 5 newer versions.
If this is set to a negative integer, then this option is ignored.
-1
default.truncate.ondelete Flag whether or not to truncate the archived node in /content/attic/... and all the versions when a document is deleted. For example, if this is set to true, then when you delete a document, it truncates the archived node in /content/attic/... and all the versions in the version history. false

You can also override the configurations for specific document types. For example, if you want to use different settings for myproject:newsdocument, then just add all the overriding properties with prefixing them by the document type name instead of "default". Here's an overriding example for myproject:newsdocument document type:

Property Name Description Default value
myproject:newsdocument.max.days The document type (myproject:newsdocument) specific configuration to override default.max.days.
If this is set to a negative integer, then this option is ignored.
-1
myproject:newsdocument.max.revisions The document type (myproject:newsdocument) specific configuration to override default.max.revisions.
If this is set to a negative integer, then this option is ignored.
-1
myproject:newsdocument.truncate.ondelete The document type (myproject:newsdocument) specific flag whether or not to truncate the archived node in /content/attic/... and all the versions when a document of the specific type is deleted. false