Activation
...
The retention service is activated in configuration by setting the retention.type parameter to adretentionof the retention service:
| Code Block |
|---|
<repository or template>SF1.retention.type=adretention |
In case the retention service is activate by template, but it should be deactivate for single repository, set the parameter for this repository to none:
| Code Block |
|---|
<repository name>.retention.type=none |
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.
| Code Block |
|---|
0(year) 0 (month) 0 (day) 0 (hour) 0 (minute) |
The following matchers are available for configuring the retention period for components (documentname) or paths (containerpath).
| Code Block |
|---|
equals
notequals
contains
notcontains
startswith
notstartswith
endswith
notendswith |
Example for ArchiveLink Repositories
Retention for all components Retention Rule Example
The retention in custom repository SF1 should be configured for ALL components without note, kgsannotation, descr, pagelist, note.meta,..
| Code Block |
|---|
SF1.retention.type=adretention |
Configuration for the service (example).
...
. |
...
| Code Block |
|---|
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.
Heredity of retention:
If the retention is just definde for the document and not excluded by using the matcher (defined above), the tia core will apply the retention to all components.
Example 1:
The document has a retention of ten years, and the component does not have a defined retention → the component will also get the retention defined for the document (10 years).
Example 2:
...
Destruction Rule Example
| Info |
|---|
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.
| Code Block |
|---|
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.