Form Data Retention Policies

This article describes setting up retention policies for form data saved to the platform using the Database Save Action form field and visible using the Form Data Browser.

The first page of the form data retention scheduling form lists form data with and without schedules:

Only public object types with a FORM_ prefix are listed. You cannot set retention policies for other types (for example those created directly using the iCM API), or those related to user profiles, article extras or private forms.

To create a new policy, press "Create" next to a form data type that doesn't already have a schedule. Edit existing policies using the "Edit" button.

Creating a Schedule

The following fields must be completed when creating a retention policy:

• Description - Visible in the list of schedules
• Retention period - The retention period is set using an ISO 8601 duration. This Wikipedia article has a good description of how the standard works. For example, P3M sets the retention period as three months.
• Based on - Whether the retention period is based on the created or last updated date of the form data

 Press "Save" to save your policy and return to the list of form data and existing schedules.

Processing Schedules

When the DRM is installed a nightly scheduled task is set up. This task calls the goss.DataRetentionManager.dailySchedule.processSchedules end point.

That end point checks all of your schedules and deletes any records that meet your retention policies.