Versions Compared

Old Version 1

changes.mady.by.user Armin Franke

Saved on

compared with

New Version Current

changes.mady.by.user Steffen Kremsler

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The retention service uses rules to manage retention periods. Rule names can be choosen chosen at will.

All parameters of a rule share A rule actually is the set of parameters chosen from the table below sharing the same prefix:

<repository or template>.retention.adretention.<rule name>

...

Each parameter can be used only once with a prefix.

Rule parameters

Parameter

Mandatory?

Description

Valid values

startofretentionperiod

yes

Start of retention period calculated based on time of object creation

see below: Format of specifying retention period values

expirationperiod

yes

Duration of retention period.

see below: Format of specifying retention period values

destructionperiod

yes

Time interval after retention period while destruction of object is still not allowed.

see below: Format of specifying retention period values

metatype

yes

Defining at which step in process the rule is applied.

addocument

adfolder

documentname

no

Filter for file name: The rule is only applied, when the document matches this filter.

see below: Specifying document filters

containerpath

no

Filter for folder name: The rule is only applied, when the document matches this filter.

Info

Each path must start and end with a slash “/” character.

Info

The containerpath parameter matches a CMIS standard requirement. However, currently there is little practical use of this parameter.

see below: Specifying document filters

contenttype

no

Filter for content type: The rule is only applied, when the document matches this filter.

For each

Example:

application/pdf

Also valid is a semicolon-separated list of content-types.

Info

Deactivation of a single rule (i.e. when configured in template but not desired for single repository) is not possible. As workaround, the attribute "metatype" may be set to a non-defined value.

Retention inheritance

The retention period specified for the document also applies to its components, even when these specify a different retention.

...

Document filters allow to controll control if a rule is to be applied based of on file name and folder of the object to be archived. They allow inclusion and exclusion.

...

equals

notequals

contains

notcontains

startswith

notstartswith

endswith

notendswith

A path here isThe interpretation of path depends on the parameter actually:

documentname

valid file name

containerpath

valid UNIX path

...