Discovering Sitecore PowerShell Reports
Sitecore PowerShell is a popular and powerful module that can be used as a development accelerator. It allows Developers, Content Authors, and Marketers to automate various tasks like content creation, audits, correction, etc.
Apart from infinite possible usage with custom scripts, SPE already has provided a lot of ammunition in existing package. In this series of two blogs, we will discover Reports, Toolbox and some cool tips to get started with custom scripts.
In this blog, we will go through a list of PowerShell Reports provided OOTB. It can be quite easy to carry out audits on your tree for better analysis. These can be extremely helpful to Developers, QA, and Content Authors.
The list of reports is located under Desktop > Reporting Tools > PowerShell Reports
The reports are grouped into 5 categories.
- Configuration Audit
- Analyze Configurations, Introduction to all available commands etc.
- Content Audit
- Audit Content Items by it’s standard/custom values, configurations etc.
- Media Audit
- Audit Media assets in library by it’s properties, find out unused media items etc.
- Solution Audit
- Audit your implementation for best practices and to make your tree author friendly
- Security Management
- Peep into logs, Check security on Items etc.
Native Reports
Here is a list of all native reports along with their script’s location under tree (A good starting point to write your custom one than starting from scratch).
| Report Type | Report Name | Report Location |
|---|---|---|
| Configuration Audit | ||
| Find all Sitecore PowerShell Commands | /sitecore/system/Modules/PowerShell/Script Library/SPE/Reporting/Content Reports/Reports/Configuration Audit/Find all Sitecore PowerShell Commands | |
| Find items with a missing template | /sitecore/system/Modules/PowerShell/Script Library/SPE/Reporting/Content Reports/Reports/Configuration Audit/Find items with a missing template | |
| Find site domain conflicts | /sitecore/system/Modules/PowerShell/Script Library/SPE/Reporting/Content Reports/Reports/Configuration Audit/Find site domain conflicts | |
| Content Audit | ||
| Aliases | /sitecore/system/Modules/PowerShell/Script Library/SPE/Reporting/Content Reports/Reports/Content Audit/Aliases | |
| Broken Links | /sitecore/system/Modules/PowerShell/Script Library/SPE/Reporting/Content Reports/Reports/Content Audit/Broken Links | |
| Items have no publishable version | /sitecore/system/Modules/PowerShell/Script Library/SPE/Reporting/Content Reports/Reports/Content Audit/Items have no publishable version | |
| Items last updated | /sitecore/system/Modules/PowerShell/Script Library/SPE/Reporting/Content Reports/Reports/Content Audit/Items last updated | |
| Items scheduled to archive | /sitecore/system/Modules/PowerShell/Script Library/SPE/Reporting/Content Reports/Reports/Content Audit/Items scheduled to archive | |
| Items unpublished in one or more targets | /sitecore/system/Modules/PowerShell/Script Library/SPE/Reporting/Content Reports/Reports/Content Audit/Items unpublished in one or more targets | |
| Items with active reminders | /sitecore/system/Modules/PowerShell/Script Library/SPE/Reporting/Content Reports/Reports/Content Audit/Items with active reminders | |
| Items with aliases | /sitecore/system/Modules/PowerShell/Script Library/SPE/Reporting/Content Reports/Reports/Content Audit/Items with aliases | |
| Items with duplicate names | /sitecore/system/Modules/PowerShell/Script Library/SPE/Reporting/Content Reports/Reports/Content Audit/Items with duplicate names | |
| Items with personalized renderings | /sitecore/system/Modules/PowerShell/Script Library/SPE/Reporting/Content Reports/Reports/Content Audit/Items with personalized renderings | |
| Items with template | /sitecore/system/Modules/PowerShell/Script Library/SPE/Reporting/Content Reports/Reports/Content Audit/Items with template | |
| Items with tokens in fields | /sitecore/system/Modules/PowerShell/Script Library/SPE/Reporting/Content Reports/Reports/Content Audit/Items with tokens in fields | |
| Recent workflow history | /sitecore/system/Modules/PowerShell/Script Library/SPE/Reporting/Content Reports/Reports/Content Audit/Recent workflow history | |
| Stale workflow items | /sitecore/system/Modules/PowerShell/Script Library/SPE/Reporting/Content Reports/Reports/Content Audit/Stale workflow items | |
| Media Audit | ||
| Database based media items | /sitecore/system/Modules/PowerShell/Script Library/SPE/Reporting/Content Reports/Reports/Media Audit/Database based media items | |
| File based media items | /sitecore/system/Modules/PowerShell/Script Library/SPE/Reporting/Content Reports/Reports/Media Audit/File based media items | |
| Image items with empty Alt field | /sitecore/system/Modules/PowerShell/Script Library/SPE/Reporting/Content Reports/Reports/Media Audit/Image items with empty Alt field | |
| Media items by size and type | /sitecore/system/Modules/PowerShell/Script Library/SPE/Reporting/Content Reports/Reports/Media Audit/Media items by size and type | |
| Media items last updated | /sitecore/system/Modules/PowerShell/Script Library/SPE/Reporting/Content Reports/Reports/Media Audit/Media items last updated | |
| Media items not used by content items | /sitecore/system/Modules/PowerShell/Script Library/SPE/Reporting/Content Reports/Reports/Media Audit/Media items not used by content items | |
| Media items with obsolete versions | /sitecore/system/Modules/PowerShell/Script Library/SPE/Reporting/Content Reports/Reports/Media Audit/Media items with obsolete versions | |
| Media items with warnings | /sitecore/system/Modules/PowerShell/Script Library/SPE/Reporting/Content Reports/Reports/Media Audit/Media items with warnings | |
| Media items without associated files | /sitecore/system/Modules/PowerShell/Script Library/SPE/Reporting/Content Reports/Reports/Media Audit/Media items without associated files | |
| Unused media items | /sitecore/system/Modules/PowerShell/Script Library/SPE/Reporting/Content Reports/Reports/Media Audit/Unused media items | |
| Solution Audit | ||
| Apply security to roles rather than users | /sitecore/system/Modules/PowerShell/Script Library/SPE/Reporting/Content Reports/Reports/Solution Audit/Apply security to roles rather than users | |
| Assign icons to templates | /sitecore/system/Modules/PowerShell/Script Library/SPE/Reporting/Content Reports/Reports/Solution Audit/Assign icons to templates | |
| Break inheritance - do not deny | /sitecore/system/Modules/PowerShell/Script Library/SPE/Reporting/Content Reports/Reports/Solution Audit/Break inheritance - do not deny | |
| How many of each custom template is used | /sitecore/system/Modules/PowerShell/Script Library/SPE/Reporting/Content Reports/Reports/Solution Audit/How many of each custom template is used | |
| How many of which field types are used | /sitecore/system/Modules/PowerShell/Script Library/SPE/Reporting/Content Reports/Reports/Solution Audit/How many of which field types are used | |
| How many times is each rendering used | /sitecore/system/Modules/PowerShell/Script Library/SPE/Reporting/Content Reports/Reports/Solution Audit/How many times is each rendering used | |
| Image Fields | /sitecore/system/Modules/PowerShell/Script Library/SPE/Reporting/Content Reports/Reports/Solution Audit/Image Fields | |
| Leverage the presentation component parameters | /sitecore/system/Modules/PowerShell/Script Library/SPE/Reporting/Content Reports/Reports/Solution Audit/Leverage the presentation component parameters | |
| Limit number of versions | /sitecore/system/Modules/PowerShell/Script Library/SPE/Reporting/Content Reports/Reports/Solution Audit/Limit number of versions | |
| Limit the number of items under any given node | /sitecore/system/Modules/PowerShell/Script Library/SPE/Reporting/Content Reports/Reports/Solution Audit/Limit the number of items under any given node | |
| Make good use of inheritance | /sitecore/system/Modules/PowerShell/Script Library/SPE/Reporting/Content Reports/Reports/Solution Audit/Make good use of inheritance | |
| Standard Values define settings | /sitecore/system/Modules/PowerShell/Script Library/SPE/Reporting/Content Reports/Reports/Solution Audit/Standard Values define settings | |
| TreelistEx instead of Treelist for big trees | /sitecore/system/Modules/PowerShell/Script Library/SPE/Reporting/Content Reports/Reports/Solution Audit/TreelistEx instead of Treelist for big trees | |
| Use special tree syntax | /sitecore/system/Modules/PowerShell/Script Library/SPE/Reporting/Content Reports/Reports/Solution Audit/Use special tree syntax | |
| Use the Help and Title for fields | /sitecore/system/Modules/PowerShell/Script Library/SPE/Reporting/Content Reports/Reports/Solution Audit/Use the Help and Title for fields | |
| Which templates define the layout on Standard Values | /sitecore/system/Modules/PowerShell/Script Library/SPE/Reporting/Content Reports/Reports/Solution Audit/Which templates define the layout on Standard Values | |
| Security Management | ||
| Find Audit Trail from logs | /sitecore/system/Modules/PowerShell/Script Library/SPE/Tools/Security Management/Reports/Security Audit/Find Audit Trail from logs | |
| Items with security for an account | /sitecore/system/Modules/PowerShell/Script Library/SPE/Tools/Security Management/Reports/Security Audit/Items with security for an account | |
| Items with security for domain | /sitecore/system/Modules/PowerShell/Script Library/SPE/Tools/Security Management/Reports/Security Audit/Items with security for domain | |
| Locked Items | /sitecore/system/Modules/PowerShell/Script Library/SPE/Tools/Security Management/Reports/Security Audit/Locked Items | |
| Recently logged in users | /sitecore/system/Modules/PowerShell/Script Library/SPE/Tools/Security Management/Reports/Security Audit/Recently logged in users |
Stay tuned for the next part, it’s coming soon.
