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 | ||||
|---|---|---|---|---|---|---|---|
| yes | Start of retention period calculated based on time of object creation | see below: Format of specifying retention period values | ||||
| yes | Duration of retention period. | see below: Format of specifying retention period values | ||||
| yes | Time interval after retention period while destruction of object is still not allowed. | see below: Format of specifying retention period values | ||||
| yes | Defining at which step in process the rule is applied. |
| ||||
| no | Filter for file name: The rule is only applied, when the document matches this filter. | see below: Specifying document filters | ||||
| no | Filter for folder name: The rule is only applied, when the document matches this filter.
| see below: Specifying document filters | ||||
| no | Filter for content type: The rule is only applied, when the document matches this filter. For each | Example:
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.
...