Database Tools

Optimize Database

The Optimize Database tool removes and/or repairs various records within the database. It is NOT recommended to run this tool frequently.

Warning - Before running any optimization tool, please backup your database to protect against data loss.

Optimize Database

To run the Optimize Database tool:

  1. Click the system menu button (  ) > Administration > Optimize Database.
  2. Select Optimize Database.
  3. Configure the following options:
    • Remove notifications and expired announcements - Removes notifications and expired announcements from the database.
    • Remove Smart Publishing information - Removes all cache information used to intelligently decide when a published file needs to be re-transmitted to the destination server.
    • Remove old versions of assets - Removes all but the current version for all version-capable assets from the database. This includes: pages, files, blocks, formats, templates and external links.
    • Remove orphaned records - Removes all child records from the database that are no longer referenced by a parent record (e.g. blobs, metadata, page configurations, page regions, etc.).
    • Remove Background Task History - Removes all background task history items before the selected start date/time.
  4. Click Submit.

Path Repair Tool

Assets in Cascade CMS cache their path in the site to speed up certain operations in the system. Normally these paths are updated as the assets and their ancestors are moved, but they have been known to get out of sync. Situations that cause this problem are corrected as they are found, but in the case that the database is already in this state the Path Repair Tool can be used to correct it. Diagnosing this situation, however, is not possible through the Cascade CMS interface so the tool should only be done under the explicit direction by Hannon Hill Support.

Warning - Before running any optimization tool, please backup your database to protect against data loss.

To run the Path Repair Tool:

  1. Click the system menu button (  ) > Administration > Optimize Database.
  2. Select Path Repair Tool.
  3. Click Submit.

After running the Path Repair Tool, a report is given detailing the status of the repair.

The Properties section gives the timestamp of when the tool was started and the status of the attempt (whether any inconsistent paths were found and if they were updated successfully).

The section labeled Successfully Repaired lists all of the assets which were found to have incorrect paths and were repaired without problems, along with the site to which they belonged.

The Errors section lists any assets which were not able to be repaired. Each item also includes the error which was encountered during the repair. A common problem is that the asset fails validation, e.g. a page without a configuration or content type, which must be corrected before the path is repaired.

Recycle Bin Checker

The Recycle Bin Checker is a system tool used to correct data inconsistencies that may occur where the children of recycled assets are not marked as recycled. Situations that can cause this problem are corrected as they are found, but in the case that the database is already in this state this tool is available. Diagnosing this situation, however, is not possible through the Cascade CMS interface so the tool should only be done under the explicit direction of Hannon Hill Support.

Warning - Before running any optimization tool, please backup your database to protect against data loss.

To run the Recycle Bin Checker:

  1. Click the system menu button (  ) > Administration > Optimize Database.
  2. Select Recycle Bin Checker.
  3. Click Submit.

After running the Recycle Bin Checker, a report is given detailing the status of the repair.

The Properties section gives the timestamp of when the tool was started and the status of the attempt (whether any inconsistent items were found and if they were updated successfully).

The section labeled Successfully Repaired lists all of the assets which were found to be inconsistent and were repaired without problems, along with the site to which they belonged.

The Errors section lists any assets which were not able to be repaired. Each item also includes the error which was encountered during the repair.