This article relates to the optional module, ‘Document Retention’, which is only available in accounts where the iPassport team has enabled it.
With this tool it is possible to set expiration and deletion dates for all documents of a given type in a given Organisational Unit, based on when they are published. Documents which are deleted through this process are permanently removed from the database and cannot be recovered.
Once allowed by the iPassport team, the ‘Document Retention’ module will appear listed under ‘Administration > Settings > System Preferences > Optional Modules’, where it can be enabled by the account administrators.
It will then appear listed as, ‘Document Retention Settings’ under ‘Administration > Settings > Organisational Unit Preferences’.
A user requires the permission, ‘Organisational Units: Manage Settings’ in the OU where the settings are to be applied.
The ‘Document Retention Settings’ page has one section for each type of document (e.g. ‘Document’, ‘Policy’, ‘SOP’, etc.). Each section has three fields which can be configured. Since it is an Organisational Unit Preference, the settings only affect documents of each type in the selected OU.
The field, ‘Apply retention rules to’, offers two choices:
The field, ‘Securely delete the
The field, ‘Set
Settings are only applied after scrolling to the bottom of the page and clicking, Save.
When new settings on the ‘Document Retention Settings’ page are saved, if any documents will be affected the next time the ‘cron job’ runs, a warning will pop up for the user to be alerted and so they can confirm they wish to proceed.
It is possible to use only one of the two period fields. Documents can be set to only be inactivated but never be deleted or, no inactivation period can be set and a deletion period can be declared for documents which are inactivated manually or with an ‘Expiry Date’ setting.
When any of the documents covered by these settings is opened, it will display the calculated dates for inactivation and/or deletion.
Please use this module with caution as any errors can result in a permanent loss of information, or if at all possible, very expensive to recover.