How to: Analyse with the SPCAF client |
SPCAF comes with a client application that can be used to run an analysis of WSP files or apps.
The client application is useful if an analysis in Visual Studio is not possible. e.g. because the source code of the project is not available or if the user is not familiar with Visual Studio.
The client application can be started from the start menu "SharePoint Code Analysis (SPCAF)". The following screenshot shows the start screen of the client application.
Following functions are available:
| Function | Description |
| Home | Brings you back to the start. |
| New | Starts a new analysis. |
| Open | Opens a previously saved performed analysis from the file system. |
| Start Analysis | Drag you .wsp, .app or .dll files int the center of the circle or add files by clicking the + button. |
| Recent Results | Opens a recent analysis, performed on the current machine. |
Configure the Analysis
To run a SharePoint code analysis, either drag your files or folders into the circle or click the + button and choose to "Add Files" or "Add Folders" to select them from the file system.
The next screen permits you to choose the output type of the report which can be PDF, DOCx and VS Dependency Graph, tag the outputs you desire. Clicking on the settings allows you to choose from one of the preset Analysis Rulesets or load a custom one.
Start the Analysis
After you have started the analysis, SPCAF will extract all information from your solutions or apps and displays the progress.
Navigate Results
After the analysis has finished, you will see a summary page from which you can navigate to the different reports and also download the specific types of reports which have been configured in the analysis settings. (e.g. DOCX, PDF, VS Dependency Graph)
On the left, you can navigate between the different available reports. Also at the bottom of this screen, you will see the details of; Date, Analyzed Elements, Settings Used, Exception and Duration.
Note: The selection depends on the SPCAF license you have installed.
Review Results
After selecting a report, the left-hand navigation guides you between the main sections.
At the top of each report, you can filter the results by the analyzed file, the violation severity or a specific package element.
Each violation can be expanded to see the affected source code.
