cms · tools

A Simple Content Audit Tool For Sitecore

Someone wants you to develop a tool provides Sitecore users a simple UI to be able to remove unsupported Sitecore item language versions of a specific Sitecore site. The main purpose is to clean up databases and might be to improve Sitecore performance.

Assumptions:

  • simple UI (a new custom Sitecore admin page)
  • support multi-site / multi-tenant Sitecore implementation
  • there are different Sitecore templates for the site’s root item
    • Site 1: /sitecore/templates/Site 1/Site Folder
    • Site 2: /sitecore/templates/Site 2/Site Root
  • there are different Sitecore templates for the site’s settings item
    • Site 1: /sitecore/templates/Site 1/Site Settings
    • Site 2: /sitecore/templates/Site 2/Site Root
  • there are different Sitecore field names for configuring the site’s supported languages and source field is “/sitecore/system/Languages”
    • Site 1: Languages
    • Site 2: Site Languages
  • pagination: page size is 16

If that is the case, you may try to play with my Content Audit Tool.

How to install it

Download this tool as a Sitecore package on Sitecore Marketplace or on Gitlab then install it to your Sitecore instance via Installation Wizard.

Note: you can download the source code in order to update the .Net framework version and the Sitecore DLLs version then publish it to your sitecore website via Visual Studio.

How to use it

1) Guide the tool which template names are used for detecting the site’s root item:

  • open \App_Config\Include\z.Vhs.ContentAuditTool.config
  • update Sitecore setting Vhs.ContentAuditTool.SiteRootTemplateNames if missing the site root template name
    • cat_6

2) Guide the tool which template names are used for detecting the site’s setting item and which field names are used for reading the supported languages:

  • open \App_Config\Include\z.Vhs.ContentAuditTool.config
  • update Sitecore setting Vhs.ContentAuditTool.SiteSettingsTemplateNames if missing the site settings template name
    • cat_7
  • update Sitecore setting Vhs.ContentAuditTool.LanguagesFieldNames if missing the language field name whose the container is the site settings item
    • cat_8

3) open a browser, navigate to http://yoursite/sitecore/admin/ContentAuditTool.aspx, sign in with admin account if not yet then you will see something like this:

cat_5

Note: you can enable to add the group name (tenant folder name) – as prefix – to the site name in the drop-list site automatically (disabled by default) so that you will select the site correctly if you want to play with multi-tenant sites

  • open \App_Config\Include\z.Vhs.ContentAuditTool.config
  • update Sitecore setting Vhs.ContentAuditTool.SupportMultiTenant to true
    • cat_9

Not Good Enough? Please feel free to download the source code and add your own enhancements if necessary.

Got issues?

Please send your issues (with screenshots if possible) to viet.hoang.sitecore@gmail.com so that I have a chance to understand your problem and be able to suggest the solution.

Happy Sitecore coding!

REFERENCES

Advertisement

Leave a Reply

Please log in using one of these methods to post your comment:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s

This site uses Akismet to reduce spam. Learn how your comment data is processed.