Example configuration for retention service

Owned by sebastian.goretzka
Last updated: Sept 12, 2024 by Stefan Franz
2 min read

 

Activation of the retention service:

SF1.retention.type=adretention

Retention Rule Example

The retention in custom repository SF1 should be configured for ALL components without note, kgsannotation, descr, pagelist, note.meta.

SF1.retention.adretention.rule1.contenttype = application/pdf SF1.retention.adretention.rule1.startofretentionperiod = 0 0 0 0 0 SF1.retention.adretention.rule1.expirationperiod = 9 0 0 0 0 SF1.retention.adretention.rule1.destructionperiod = 0 0 1 0 0 SF1.retention.adretention.rule1.metatype = addocument SF1.retention.adretention.rule1.documentname = [notequals][note;kgsannotation;descr;pagelist;note.meta]

  • Line 1: If there is a mime type specified, it will be used just for the defined mime type (e.g., PDF).

  • Line 2: Defines the start of the retentionperiod. In this example, the retention starts immediately.

  • LIne 3: Defines the expirationperiod. In this example, the retention is set for 9 years.

  • Line 4: Defines the destructionperiod. In this example, the destruction will be possible one day after the defined retentionperiod (9 years and 1 day, Expirationperiod + destructionperiod).

  • Line 5: The retention will be just used for “addocument”.

  • Line 6: Defines the matcher and components that are involved. In this example, retention will be excluded for all defined components.

 

Destruction Rule Example

tia ContentServer 3.8.0 or higher required

It is possible to configure only a destruction date and no retention. When the date is reached a deletion should be triggered by a leading system.

This date can only be queried by CMIS.

The destruction in custom repository SF1 should be configured for ALL components without note, kgsannotation, descr, pagelist, note.meta.

SF1.retention.adretention.rule1.contenttype = application/pdf SF1.retention.adretention.rule1.startofretentionperiod = 0 0 0 0 0 SF1.retention.adretention.rule1.expirationperiod = 0 0 0 0 0 SF1.retention.adretention.rule1.destructionperiod = 2 0 0 0 0 SF1.retention.adretention.rule1.metatype = addocument SF1.retention.adretention.rule1.documentname = [notequals][note;kgsannotation;descr;pagelist;note.meta]

  • Line 1: If there is a mime type specified, it will be used just for the defined mime type (e.g., PDF).

  • Line 2: Defines the start of the retentionperiod. In this example, retention is not required.

  • LIne 3: Defines the expirationperiodIn this example, retention is not required.

  • Line 4: Defines the destructionperiod. In this example, the destruction will be possible after two years.

  • Line 5: The destruction will be just used for “addocument”, new documents.

  • Line 6: Defines the matcher and components that are involved. In this example, destruction will be excluded for all defined components.