Installation

The DRM is imported into iCM as part of the standard site release process. This will import all of the relevant forms and end points, but you will still need to set up the Form App Shortcut and create the nightly scheduled task.

Form App Shortcut

Create a shortcut for an iCM user group with access to the "Retention Manager" form. You could add this to an existing administrator group, or create a new group which will only grant certain users access to the form app.

Scheduled End Point

Set up a scheduled task to run the goss.DataRetentionManager.dailySchedule.processSchedules end point. We recommend running it every evening. It is this end point that actually triggers the data management task.

My Account Integration

The "User Delete Retention Manager" form can be used by website users to delete history records that relate to them.

If you want your users to be able to delete data via My Account, first create an article using the Forms Service template and relate the "User Delete Retention Manager" form to it. Next select that article as a "List item" in the My Account article extras.

See the My Account - Advanced Layout documentation for more information.

Configuration

A configuration end point includes some feature flags and support for batching in custom deletion end points.

function(params, credentials) {
    return {
        flags: {
            formData: true
        },
        processHistory: {
            getHistoriesBatchSize: 500,
            maxRunTime: 240
        },
        customEndpointsForBatchDeletion: []
    };
}