Knowledge Base

 View Only

When to perform a Project Clean-Up

By Carmen Santos posted 10-11-2017 06:27

Project Clean Up is a tool located under Admin > Project > Choose Project > Clean Up tab for users with Manage Project permissions.

Some of the scenarios where a Project Clean up is recommended are when the Project Tree or Search service display rare behaviours like the following:

  • Users cannot select an item from the Explorer Tree or within search or filter results and are prompt with "This item has been deleted".
  • Users cannot select an item from the Explorer Tree or within search or filter results and are prompt with: "You don't have permissions to perform this action".
  • Hierarchy sequence of the Explorer Tree is inconsistent with the List View.
  • An item cannot be located it in the Explorer Tree though it can be seen in the List View.
  • Batch deleted items remain in the Explorer Tree or show up in filter results.

Cleaning up the project does not interfere with item history or the option to restore any deleted item

This is a background process and when it starts it displays a quick message in the UI.

And once completed, a second message is displayed.

On-premise customers can confirm the cleanup actions and the successful completion of the process in the server logs.

[com.jamasoftware.contour.documentNode.newcache.sanitizer.DocumentNodeSanitizer] - Start clean up project 20183.
[com.jamasoftware.contour.documentNode.newcache.sanitizer.DocumentNodeSanitizer] - Validating tree active fields
[com.jamasoftware.contour.documentNode.newcache.sanitizer.DocumentNodeSanitizer] - Done validating tree active fields in 136 ms
[com.jamasoftware.contour.documentNode.newcache.sanitizer.DocumentNodeSanitizer] - Validating sort order
[dc4a1b] [com.jamasoftware.contour.documentNode.newcache.sanitizer.DocumentNodeSanitizer] - Validating global sort orders

[com.jamasoftware.contour.documentNode.newcache.sanitizer.DocumentNodeSanitizer] - Done validating sort orders in 33 ms

[com.jamasoftware.contour.documentNode.newcache.sanitizer.GlobalSortOrderSanitizer] - Updating node 2456204 global sort order from 2011 to 200010
[com.jamasoftware.contour.documentNode.newcache.sanitizer.GlobalSortOrderSanitizer] - Updating node 2456203 global sort order from 2010 to 200009
[com.jamasoftware.contour.documentNode.newcache.sanitizer.GlobalSortOrderSanitizer] - Updating node 2456202 global sort order from 2009 to 200008
[com.jamasoftware.contour.documentNode.newcache.sanitizer.GlobalSortOrderSanitizer] - Updating node 2456201 global sort order from 2008 to 200007
[com.jamasoftware.contour.documentNode.newcache.sanitizer.GlobalSortOrderSanitizer] - Updating node 2456200 global sort order from 2007 to 200006
[com.jamasoftware.contour.documentNode.newcache.sanitizer.GlobalSortOrderSanitizer] - Updating node 2456199 global sort order from 2006 to 200005
[com.jamasoftware.contour.documentNode.newcache.sanitizer.GlobalSortOrderSanitizer] - Updating node 2456198 global sort order from 2005 to 200004
[com.jamasoftware.contour.documentNode.newcache.sanitizer.DocumentNodeSanitizer] - Evict project tree from cache.
[com.jamasoftware.contour.documentNode.newcache.sanitizer.DocumentNodeSanitizer] - Found 1596 changed nodes.
[com.jamasoftware.contour.documentNode.newcache.sanitizer.DocumentNodeSanitizer] - Indexing 1596 changed nodes.
[com.jamasoftware.contour.documentNode.newcache.sanitizer.DocumentNodeSanitizer] - Done clean up project 20183.

Project Managers can reach the local Jama System Administrator, or Jama Support in case of a hosted instance, to request this data.

The tool's purpose is to look for nodes on the Project Tree with inconsistent states in regards to the items they reference, as well as active items that have inactive ancestors, bringing them to a consistent state. It will re-calculate sort orders and compare them with the ones saved in the database, re-calculate global sort orders and compare them the one ones saved in the database, re-index items that have been modified and, where necessary, will invalidate the Project's Tree cache. 

This feature does not require re-indexing or downtime, however, for a large Project Tree we recommended performing the Clean Up at a low usage time.

If one of the mentioned scenarios persists after a project's Clean up, feel free to open a ticket with Jama Support.