Creating a retention rule

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

All parameters of a rule share the same prefix:

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

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.

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. Each path must start and end with a slash “/” character.	see below: Specifying document filters
`contenttype`	no	Filter for content type: The rule is only applied, when the document matches this filter.	Example: `application/pdf`

Retention inheritance

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

Format of specifying retention period values

The values for the parameters startofretentionperiod, expirationperiod, destructionperiod specify periods and follow the format described below.

Periods define the amount of time (e.g., days, months, years) from creation date the documents should be protected from modification.

Example:

The rentention period can be defined in years, months, days, hours and minutes.

# 0(year) 0 (month) 0 (day) 0 (hour) 0 (minute)

Specifying document filters

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

The format is:

[<operator>][<path(s)>]

The characters [ and ] are required. What is written inside < and >, however, is a placeholder in the format explanation.

Valid as operator are:

equals

notequals

contains

notcontains

startswith

notstartswith

endswith

notendswith

A path here is:

`documentname`	valid file name
`containerpath`	valid UNIX path

A list of path values can be provided separated by semicolon.

Examples:

template_all.retention.adretention.rule1.documentname = [notequals][note;kgsannotation;descr;pagelist;note.meta]

SF1.retention.adretention.rule2.containerpath         = [notstartswith][/Knowledge Provider/]