The Dmclean tool automates the dmclean utility. The utility scans the repository for orphaned content objects, ACLs, and annotations (dm_note objects). The utility also scans for the workflow templates created by the SendToDistributionList command (a DTC command that routes a document to multiple users concurrently) and left in the repository after the workflow completed. The utility generates an API script to remove the orphaned content objects. The Dmclean tool performs these operations and (optionally) runs the generated script.

When the agent exec program invokes the script, the tool generates a report showing which ACLs, notes, and workflow templates are removed. The report also shows the orphaned content objects that will be removed if the generated API script is executed. The status report is saved in /System/Sysadmin/Reports/DMClean.

Whether the generated script runs is controlled by the tools clean_now argument. This argument is set to TRUE by default. If you set it to FALSE, the script is not run; it must be run manually to remove the orphaned objects. (The script is stored in %DOCUMENTUM\dba\log\hexrepositoryid\sysadmin.)

The Dmclean tool is installed in the inactive state.