Summary

This document describes the steps required to configure the data retention period of records within the Evolution database. By default, all records are retained forever.

Prerequisites

The following is needed in order to configure database data retention for Evolution.

• An installation of the Evolution software at version 2.5.x or greater.
• Sysadmin privileges on the Microsoft SQL Server database instance where the Evolution database (evo_dev) is installed.

Process

The cleanup of old data records within the Evolution database is enabled by the Evolution Maintenance SQL Agent job. The job runs automatically at 2AM every day by default and can be adjusted as needed.

In order to configure the specific retention policies, it is necessary to update the dbo.Configuration table within the evo_dev database. Note the following relevant configurations:

These configurations do not exist in the Configuration table by default and must be added one by one using Evolution’s configuration updater script as follows:

DECLARE @now DateTime2(7)

SET @now = SYSUTCDATETIME()

EXEC evo.p_Configuration#Updater @ConfigurationSection = N’Maintenance’, @ConfigurationName= N’<InputConfigName>’, @ConfigurationValue=N’<InputValue>’, @ConfigurationUpdated=@now, @ConfigurationUpdatable=0, @ConfigurationDeltaStatusUserID_LastUpdatedBy=1

Be sure to input values in number of days that are appropriate for your organization’s data retention requirements.

With the values added to the Configuration table, simply enable the Evolution Maintenance SQL Agent job. Note that values configured within the job settings directly are ignored when the previously configured database records are in place.