Root - Database Cleanup

Performs automated cleanup and maintenance tasks on the Grooper repository database.

Remarks

Overview

The Database Cleanup command is designed to help administrators maintain the health, performance, and manageability of the Grooper repository database. It automates the removal of obsolete data, enforces retention policies, and eliminates orphaned or outdated records that can accumulate over time.

By configuring this command, you can schedule or execute a variety of maintenance operations, such as purging old statistics, event logs, processing jobs, and test batches, as well as cleaning up the list of registered machines and removing orphaned processing tasks. This helps control database growth, ensures compliance with data retention requirements, and keeps the system running efficiently.

Usage

• Enable or configure the desired cleanup options using the available properties.
• Set retention periods (in days) for statistics, logs, jobs, and ad hoc jobs to control how long data is kept.
• Add test batch folders to automate the purging of old test batches.
• Optionally enable removal of inactive machines and orphaned processing tasks.
• Execute the command manually or schedule it as part of regular system maintenance.

Each selected operation is performed in a safe, controlled manner, with progress and results logged for review. No active or recently used data is affected unless it meets the configured criteria.

When to Use

• As part of routine system maintenance to prevent database bloat and improve performance.
• To comply with organizational or regulatory data retention policies.
• After periods of heavy processing, testing, or system changes that generate excess data.

Diagnostics and Logging

• All cleanup actions, including deletions and purges, are logged in the Grooper event log for auditing.
• Progress and results are displayed during execution, including the number of records or objects removed.
• Any errors or issues encountered are recorded for troubleshooting.

Best Practices

• Review retention settings regularly to ensure they align with business and compliance requirements.
• Schedule cleanup operations during maintenance windows to minimize impact on users.
• Monitor logs after execution to verify that cleanup actions completed as expected.

Properties

Name	Type		Description
Clean Machines List	Boolean	►	Removes machines from the Machines folder that have not connected in the last 30 days. DefaultTrue When enabled, this operation cleans up the list of servers and workstations registered in the Machines folder by removing any machine that has not successfully connected to the repository in the past 30 days. Helps keep the Machines list current and free of obsolete or decommissioned entries. No effect on active or recently connected machines.
Stat Retention Period	Int32	►	The retention period (in days) for statistics data in the repository. Default365 Statistics data older than this value will be deleted from the database. Set to 0 to disable statistics purging. Default: 365 days. Use this to manage database size and comply with data retention policies.
Log Retention Period	Int32	►	The retention period (in days) for Grooper event log entries. Default365 Event log entries older than this value will be deleted from the Log table. Set to 0 to disable log purging. Default: 365 days. Helps manage database growth and ensures logs remain relevant.
Job Retention Period	Nullable Int32?	►	The retention period (in days) for Processing Jobs and associated Processing Tasks. If set, Processing Jobs older than this value will be deleted, along with their associated Processing Tasks. Jobs are created when processing is resumed on a paused batch or when a Batch Process Step completes. Batches are not deleted by this operation; only their jobs are purged. Set to null to disable job purging. Use this to reduce database bloat when batches are retained for long periods.
Ad Hoc Job Retention Period	Int32	►	The retention period (in days) for ad hoc Processing Jobs created by activity testing. Default30 Ad hoc jobs older than this value will be deleted from the database. Ad hoc jobs are created when an administrator tests batch objects from the Activity Tester tab. Set to 0 to disable ad hoc job purging. Default: 30 days.
Purge Batches	Purge Folder[]	►	Specifies test folders whose batches should be purged based on age criteria. EditorObject Collection Editor ConverterCollection Converter Add one or more Folder objects from the 'Batches / Test' area to this list. Batches within these folders (and their subfolders) will be considered for deletion if they meet the configured retention period. Use this to automate cleanup of test batches and manage storage in test environments. Each Purge Folder entry allows you to specify a folder and a retention period.
Purge Orphaned Tasks	Boolean	►	Deletes Processing Tasks that no longer have a parent node in the repository. DefaultFalse When enabled, this operation scans for Processing Tasks whose parent Node or Processing Job has been deleted, and removes them from the database. Helps maintain referential integrity and prevents orphaned task records from accumulating. Safe to run regularly as part of system maintenance.

See Also

Purge FolderRoot