What do the reports mean after the SPCAF analysis?

This article explains what the reports mean after completing an analysis with SPCAF.

After running SPCAF analysis you will have the following Reports which break down the results accordingly. This article will briefly explain what each of the results represents:

Overview

This is simply the Overview of the analysis and will display the total results for each section. From here you can access the independent results for Code Quality, Metrics, Inventory, and Dependencies.

Summary

The report provides a summary of the analysis results in charts and diagrams. The summary gives the overview for "Code Quality" and " Metrics", by showing the level of errors and if being viewed in HTML this can be filtered on the graphs. Summary also shows the Analysis Settings and Exceptions.

Code Quality

The code quality analyzers of SPCop focus on different types of SharePoint Code. They are used to identify possible problems or coding errors in assemblies, XML files, ASPX files, CSS files, JavaScript files, etc. The rules check the artefacts and return violations as Critical Error, Error, Critical Warning, Warning, or Information.

  • Critical Error - Issues reported on the Critical Error level may lead to a failed solution deployment process or the SharePoint farm can become unstable after deployment. The code contains syntax errors or files or referenced elements are missing. WSP's or Apps with critical errors should not be deployed to SharePoint because they can damage the farm or could have a highly negative impact.
  • Error - Issues reported at the Error level should not impact the solution deployment process or the stability of the SharePoint farm. But deployed solutions may not work as expected. Future upgrades of the solution may be impossible or may most likely fail. WSP's or Apps with errors should only be deployed to SharePoint very carefully after the detected issues have been reviewed.
  • Critical Warning - Issues reported at the Critical Warning level reflect issues that generally have little or no adverse effect on code behavior; they are primarily concerned with code maintainability, and correcting less-than-optimal choices for visible elements. However, for a minority of cases, these messages are considered errors. Therefore, they should be reviewed closely before they are excluded.
  • Warning - Issues reported at the Warning level are generally concerned with doing things correctly to keep your code base stable, extensible, and maintainable.
  • Information - Messages at the Information level are returned by rules that report information about a target, as opposed to detecting errors in a target.

Each violation rating lists the cause, the reason, and offers a resolution for the error.

Metrics

Note: Not available for SPCAF lite.

Provides detailed information about the amount of customization to estimate the complexity and volume of the solution. Metrics categorizes each customization as Feature Elements, Features by Scope, Solution Artifacts, Assembly Artifacts, Appweb Feature Elements, HostWeb Feature Elements, AppWeb File Types, Security Relevant Code, impacting Farm Stability and Code Languages.

  • Feature Elements - Tells which SharePoint artefacts are used in the application. These numbers help to see the complexity of the application and the impact on the SharePoint farm.
  • Features by Scope - Tells which types of features are used in the application. These numbers help to see the complexity of the application and the impact on the SharePoint farm.
  • Solution Artefacts - Tells which SharePoint artefacts are used in the application. These numbers help to see the complexity of the application and the impact on the SharePoint farm.
  • Assembly Artefacts - Tells which SharePoint artefacts are used in the application. These numbers help to see the complexity of the application and the impact on the SharePoint farm.
  • AppWeb Feature Elements - Tells which artefacts are deployed to the AppWeb by an App.
  • HostWeb Feature Elements - Tells which artefacts are deployed to the HostWeb by an App.
  • AppWeb File Types - Tells which types of files are deployed to the AppWeb as Modules.
  • Security Relevant Code - These numbers indicate which customization's, may have an impact on farm security and provide a risk for the farm.
  • Impacting Farm Stability - These numbers indicate how large they impact the stability of the farm.
  • Code Languages - This summary tells which different languages are used in the code and how many lines are present. This number helps to see which knowledge a developer needs to maintain the code.

Dependencies

Note: Not available for SPCAF lite.

Shows the dependencies between the SharePoint elements within the packages and external components. The results show the Solution Level Dependency, Feature Level Dependencies, .Net Dependencies, and General Dependencies.

Inventory

Note: Not available for SPCAF lite.

The SharePoint inventory report lists all contained customizations including their main properties and settings. This information helps to automatically document all developed customizations. These can be categorized as Application Contents, Feature Elements, Customization's, SharePoint Dependencies, External Dependencies, Resources, and Miscellaneous.

Tags

Pre-Production | Reports | Results | Analysis | Meaning | AN_U