Automated Cleanup

The Automated Cleanup page allows you to schedule automated cleanup of system generated data from the UCX. This data includes files associated with automatic and user initiated backups, CDR records, call center report data, call recordings, packet captures, and voicemail messages. The ability to schedule automatic reboots has also been added as configurable task. Each category of data can be configured for cleanup independently of each other.

Before configuring Automated Cleanup, E-MetroTel recommends that you consult with your customer to ensure that any cleanup schedules adhere to the customer's data retention policy, as the Automated Cleanup data removal process is not recoverable.
The Automated Cleanup of Voicemail Messages will delete all voicemails, regardless of their state (i.e. read, unread, stored in other folders, etc.),

The following items are available for cleanup actions:


Item Description
Backups - Automated Removes appropriate backups that have been created through the Automatic Backup process
Backups - User Removes appropriate backups that have been created through the manual backup process
CDR Records Removes appropriate CDR records for the whole system 
Call Center Reports Removes Groups, Agents, and Records data from the Call Center Report database
Call Recordings Removes appropriate call recording files
Packet Captures Removes packet captures generated in the Support / Packet Capture page
System Reboot Performs a system reboot on an administrator-defined schedule
Voicemail Messages Removes appropriate voicemail messages for the whole system

Automated Cleanup Status

To review the status of the Automated Cleanup functionality:

  1. Open the UCX Web-based Configuration Utility
  2. From the System tab, select System Tools
  3. From the Left Menu select Automated Cleanup
  4. The default setting for the Automated Cleanup is Inactive, shown in red text at the top of the page.
  5. The following information is displayed for each of the items available for cleanup.
    Information Description
    Frequency The frequency that cleanup is conducted for this item
    [Never (default) / Weekly / Monthly / Quarterly / Semi-Annually / Annually]
    Start Time The hour of the day that the UCX is to initiate the cleanup process for this item (if scheduled).
    Delete Older Than The age of the data beyond which should be cleaned up (deleted) for this item (if scheduled).
    Last Cleanup When the last cleanup activity for this item was executed.
    Next Cleanup When the next cleanup activity for this item is scheduled
    Current Usage The current number of records or disk space associated with this cleanup item.

Configuring Automated Cleanup

To configure the Automated Cleanup feature on your UCX system, perform the following steps:

  1. Update the individual items as required by clicking on Edit on the item type you wish to modify (Backups - User for this example).
  2. For each cleanup type, you may set the Cleanup Frequency, Start Time, and Delete Older Than setting.
  3. Set the Frequency by selecting a period in the drop down box.
  4. Set the Start Time specifically for this cleanup item (independent of the other other cleanup activities).
  5. Set the Delete Older Than value if desired. The default value for each item is set based on the nature of the data. The default values are:
    Item Delete Older Than default setting
    Backups - Automated 90 Days
    Backups - User 365 Days
    CDR Records 730 Days
    Call Center Reports 365 Days
    Call Recordings 730 Days
    Packet Captures 7 Days
    System Reboot N/A (not applicable)
    Voicemail Messages 365 Days
  6. Once you have modified the settings for a particular item, click Save.
  7. Make changes to any other items as desired.
NOTE: If you configure the Call Recordings schedule to remove CDR files at a time prior to removal of the corresponding Call Recordings, you will receive a Warning indicating that once the CDR files are removed you will no longer be able to access the Call Recording files through the Web-based Configuration Utility user interface. You will be allowed to proceed without any further action but will not be presented with the warning again until you change any of the CDR scheduling details.

Starting the Automated Cleanup Process

After you have configured the desired cleanup parameters, you must start the Automated Clean process by clicking Activate Tasks button. The indicator at the top of the page will turn green and show a status of Active.


Once the Automated Cleanup process has reached the Next Cleanup date, it will update the display to show when the cleanup occurred, if it succeeded, and when the next cleanup activity will be run.


Stopping Automated Cleanup

Once Automated Cleanup has been activated, you can stop the process anytime. To stop the Automated Cleanup, click the Deactivate Tasks button.