Expand Minimize

SPC040102: Declare attribute 'Title' and 'Description' in Solutions

To make it easier to identify Solutions in the Solution Gallery in SharePoint the attributes 'Title' and 'Description' should be declared.

CheckId SPC040102
TypeName DeclareTitleAndDescriptionInSolutions
Severity Warning
Type Solution

The manifest.xml of a WSP should contain a meaningfull title and description to describe the purpose of the solution. Although this information is not displayed in the SharePoint central administration it is accessible via PowerShell or SPCAF inventory.

<Solution
   SolutionId="006be6c7-623d-44e2-95af-1f91d78d060a"
   Title="Corporate Intranet - Core Components"
   Description="Contains the core intranet components like logging, configuration, master pages etc."
   xmlns="http://schemas.microsoft.com/sharepoint/">
   <RootFiles>
   ...
   </RootFiles>
   <FeatureManifests>
   ...
   </FeatureManifests>
</Solution>

To suppress this violation in XML SharePoint code add the following comment right before the XML tag which causes the rule violation. Learn more about SuppressMessage here.

<!-- "SuppressMessage":{"rule":"SPC040102:DeclareTitleAndDescriptionInSolutions","justification":"Provide reason for suppression here"} -->
Disclaimer: The views and opinions expressed in this documentation and in SPCAF do not necessarily reflect the opinions and recommendations of Microsoft or any member of Microsoft. SPCAF and RENCORE are registered trademarks of Rencore. All other trademarks, service marks, collective marks, copyrights, registered names, and marks used or cited by this documentation are the property of their respective owners.