Guide

How To Run SPCAF in SPDocKit

This functionality is meant for use with SharePoint Framework projects and is only available with a SPCAF Build licenses
Note: SysKit who develops SPDocKIt is responsible for the version of SPCAF being installed into SPDockIt. The released version may be greatly higher than this and so some released features and functions of SPCAF may not be present when being used in SPDocKit.

Please refer to SPDocKit documentation to find out what version of SPCAF is available with the product.

Running SPCAF analysis of your SharePoint Framework project from SPDocKit allows you to stay productive and easily check if there are any issues in your project. If any issues are found you can quickly fix them.

Note: Due to a .net framework 4.0 requirement, the integration of SPCAF with SPDocKit only supports SharePoint Versions SP2013 and SP2016. If SPDocKit is used in a SharePoint 2010 environment it will open .NET in 3.5 mode, which then does not call SPCAF.

Once you have loaded the plugin, assigned your license, and activated the next step is to run the SPCAF analysis. To run SPCAF analysis in SPDocKit you will need to first load into SPDocKit and do the following:

1. Go to Content and Usage Reports.

2. Scroll down to SPCAF Reports.

3. Select one of the following reports:

  • Analysis Summary.

    • Code Quality.
    • Code Metrics.
    • Code Dependencies.
    • Code Inventory.

SPDockit will then call the SPCAF to analyze the database and the SPCAF reports will then be loaded onscreen.

Last updated: 7/31/2024