Configure the reporting database purge task
To configure the reporting database purge task, go to the configuration page in the Services Framework user interface and select the new task configuration link.
The following table shows the information that is needed to configure the reporting database purge task.
| Field | Description | Example |
|---|---|---|
| Task | Contains the registered tasks in the system. Select the name of the reporting database purge task that was entered during registration. | Reporting database purge task |
| Configuration | Descriptive name for the configuration. This field is required and can contain up to 60 characters. | Reporting database purge task configuration |
| Description | A detailed description that explains what the configuration does. This field is optional. If entered, it must be 512 characters or less. | Purge all records older than 12 months. |
| Activate task | Identifies whether the configuration is active. When it is active, the task is available to purge database records. | Yes, No |
| Process end of day | Indicates whether the task is to be called during end of day processing. Set this value to no because it doesn't apply to the reporting database purge task. | No |
| Process cleanup | Set this value to no because it doesn't apply to the reporting database purge task. | No |
| Retention Period | Configures how long to keep the records before they are purged from the database. The purge process subtracts the retention period from the current date and time to determine which records to purge. | If the retention period is set to 12 and the current date and time is 7 May 2029 at 1:00 PM, the purge process deletes all records older than 1:00 PM on 7 May 2028. |
| Commit rate | The maximum number of records to delete before a database commit is done. | If the commit rate was set to 500, the purge process does a database commit after every 500 records that are deleted. |
| FTM Base properties file | The path and file name of the properties file that defines what data is deleted from the
FTM base tables in the reporting and analytics
database. The FTM purge utility is integrated with this task. For more information about the properties that are used in this file, see Configuring and executing. |
The full path and file name of a database purge utility properties file. |