Documentation

The developers and architects at Rencore have been creating applications on the SharePoint platform as project managers, architects, or developers for many years.

The SharePoint Customization Analysis Framework (SPCAF) is the "de facto" tool to verify the quality, compliance & governance of customization's being deployed to your SharePoint on-premises and cloud environments. Catch errors in your SharePoint customization's throughout…

Our support team is dedicated to our customers and will endeavor to help you with the use of our products and aim to make your experience with our powerful tools a pleasant one.

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

- Modern browsers, (i.e. latest versions of Firefox, Chrome etc).

Note: Before the installation, please make sure to close all running instances of Visual Studio. The setup cannot proceed if Visual Studio is running. Also, make sure that your system meets the system requirements.

To use SPCAF you will need to install an SPCAF license key, such as a trial key or a purchased license key. This key is a cryptic text that is usually delivered via email.

To use SPCAF features completely you will need to activate an SPCAF license key, such as a trial key or a purchased license key. The following sections describe the different ways to activate this license key on your computer so that it can be found by the SPCAF tools.

SPCAF comes with a client application that can be used to run an analysis of WSP files or apps. The client application is an alternative to analysis in Visual Studio e.g. if the source code of the project is not available or if the user is not familiar with Visual Studio.

So you have analyzed your project but now you need to distribute the results to people who do not have access to SPCAF, as such you will need to create a PDF or DOCX report which you will need to do when setting up the analysis.

Besides HTML format, SPCAF can also create reports in the formats PDF and DOCX as a result of an analysis. Sometimes it is required that the layout of these reports meet the corporate design. To achieve this the report template for PDF and DOCX reports can be customized…

So you have analyzed your project(s) multiple times and want to compare the history of the results of each scan to see any the changes to the project over the versions analyzed. Rather than taking the details out of each result and compiling this yourself there is a feature…

Sign in to SPCAF with your Subscription Plan

To Run SPCAF in PowerShell either edit and use the supplied example script or create your own to suit your needs.

Note: The use of SPCAF from command line requires a Build License.

SharePoint code analysis can also be executed through a YAML build. In order to run SPCAF, you must first upload it to your build environment. First, you will need to download SPCAF from our downloads page.

Note: This functionality is only available in SPCAF Build License.

Note: This functionality is only available in SPCAF Build License.

Note: This functionality is only available in SPCAF Build License.

In order to upload your build in TFS2017, you must use the TFX command line. This article will explain what is required in order to do this.

This functionality is meant for use with SharePoint Framework projects.

This functionality is meant for use with SharePoint Framework projects.

This functionality is meant for use with SharePoint Framework projects and is only available with a SPCAF Build licenses

Note: Please note that Rencore will no longer provide updates for SPCAF integration into SonarQube. SPCAF version 7.6.0.0. is the last plugin available, support will continue as we continue to support SPCAF version 7.6.0.0.

Note: Please note that Rencore will no longer provide updates for SPCAF integration into SonarQube. SPCAF version 7.6.0.0. is the last plugin available, support will continue as we continue to support SPCAF version 7.6.0.0.

Note: Please note that Rencore will no longer provide updates for SPCAF integration into SonarQube. SPCAF version 7.6.0.0. is the last plugin available, support will continue as we continue to support SPCAF version 7.6.0.0.

Note: Please note that Rencore will no longer provide updates for SPCAF integration into SonarQube. SPCAF version 7.6.0.0. is the last plugin available, support will continue as we continue to support SPCAF version 7.6.0.0.

Note: Please note that Rencore will no longer provide updates for SPCAF integration into SonarQube. SPCAF version 7.6.0.0. is the last plugin available, support will continue as we continue to support SPCAF version 7.6.0.0.

Note: Please note that Rencore will no longer provide updates for SPCAF integration into SonarQube. SPCAF version 7.6.0.0. is the last plugin available, support will continue as we continue to support SPCAF version 7.6.0.0.

Note: Please note that Rencore will no longer provide updates for SPCAF integration into SonarQube. SPCAF version 7.6.0.0. is the last plugin available, support will continue as we continue to support SPCAF version 7.6.0.0.

Note: Please note that Rencore will no longer provide updates for SPCAF integration into SonarQube. SPCAF version 7.6.0.0. is the last plugin available, support will continue as we continue to support SPCAF version 7.6.0.0.

Note: Please note that Rencore will no longer provide updates for SPCAF integration into SonarQube. SPCAF version 7.6.0.0. is the last plugin available, support will continue as we continue to support SPCAF version 7.6.0.0.

This functionality is only available in SPCAF Build.

Note: This functionality is only available with an SPCAF Farm build license.

This functionality is only available with a SPCAF Build licenses.

Note: This functionality is meant for use with SharePoint Framework projects.

This functionality is meant for use with SharePoint Framework projects.

Running SPCAF analysis of your SharePoint Framework project from Visual Studio Code 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 without leaving Visual Studio Code.

By default, SPCAF installs a Visual Studio add-in available for Visual Studio 2010 to 2015. This add-in adds a menu entry to the tools menu and to the context menu of Solution and Project. From this menu, you can start the SharePoint code analysis.

SPCAF does not automatically install a Visual Studio add-in to Visual Studio 2017 as it does for previous versions. You will need to manually install the SPCAF extension by using the .vsix available from our downloads on our website.

This functionality is only available in SPCAF Build.

This functionality is only available in SPCAF Quality Gate.

To get a log file with more information about the analysis process, you have to set the parameter "LogFile" of the TFS build activity.

MSBuild integration in a TeamBuild (e.g. on Team Foundation Server) is only available in SPCAF Build. The client licenses can use MSBuild or the local build in Visual Studio.

SPCAF by default comes with 7 standard rulesets that cover the general requirements needed to scan the majority of files. However, we do recommend that you create your own custom ruleset to be used for analyzing your specific project. This means you can ignore specific…

SPCAF allows the configuration of the analysis process with ruleset files (see section "Rulesets" in this documentation).

In some cases, it is necessary to exclude files from the analysis, e.g. to avoid analysis of 3rd party assemblies or jquery files. This can be achieved by using SPCAF rulesets.

Sometimes the analysis reports potential issues that should not appear in the reports.

SPCAF comes with 6 pre-configured rulesets that you can use to analyze your project. These rulesets are "All Analyzers", "Minimum Settings", "Minimum Recommended Settings", "Extended Recommended Settings (default)", "SharePoint Framework - All Rules", and "Angular…

FxCop is one of the 3rd party analyzer s that can be integrated with SPCAF via rule. The rule will be executed only if the tool FxCop is installed locally. If the tool is not be found the rule will throw an exception.

CAT.NET is one of the 3rd Party analyzers that can be integrated in SPCAF via a rule. The rule will be executed only if the tool CATNET is installed locally. If the tool is not found the rule will throw an exception.

SPCAF is periodically updated with new features, new rules, improvements to rules and of course bug fixes. As such it is recommended to always have the latest version of SPCAF for your analysis (license permitting).

From time to time it may be necessary for you to transfer a valid license from one machine to a new machine. In these circumstances you will need to contact support and instruct them of your intention then you will need to do the following:

Provide Support My Logs and License

If you have installed Rencore Code (SPCAF) on a Windows VM and the Challenge code is missing when attempting to activate the license, as shown below:

If you have recently purchased a license for SPCAF or recently activated your license and are still getting the "Free Header" (see below) when viewing a report. There are a couple of things to check:

SPCAF uses settings within Windows you can change where menus appear on the screen by indicating which hand you write with. This, unfortunately, causes the issue in SPCAF to now display the tooltips correctly.

Although it is possible to utilize SPCAF in gulp without a valid license, you will find that you will get more errors, compared to running SPCAF with a license.

Identify where spcaf files are located with 3rd party software

If the SPCAF context menu appears disabled in Visual Studio, then you might either have no SharePoint project selected or you are experiencing a historic bug, which caused the context menu to appear disabled when a solution has unloaded projects.

spcop.exe oops something quite went not the way we expected

Message: Failed to load settings file 'C:\Program Files x86)\SPCAF\RuleSets\RS10ExtendedRecommendedRules.sp...

why does spdisposechecker not show any violations for sharepoint 2013 projects

The 3rd-Party analysis tools FXCop, FXCop Metrics, Cat.Net, and SPDisposeCheck have not been installed automatically with SPCAF, as redistribution of them is prohibited by their respective owners.

If SPCAF is on a machine that has full access, when logging into SPCAF it will periodically communicate with our activation servers to confirm there are no updates on the current license being used. This should rarely ever cause a problem unless there is a major hardware…

There are several reasons why SPDisposeCheck, CAT.NET, or FXCop are not recognized by SPCAF. Below are the main causes, ways of checking if it is the cause, and of course how to rectify:

Note: Please note that Rencore will no longer provide updates for SPCAF integration into SonarQube. SPCAF version 7.6.0.0. is the last plugin available, support will continue as we continue to support SPCAF version 7.6.0.0.

SPCAF has various points in the analysis: 0-84% analyzing the solution, 85-94% creating Reports, and +95% tidying up temp files and displaying the reports. Under certain conditions, the tool runs into an error after the analysis is complete, as shown below:

If your system prevents you from installing SPCAF due to an expired certificate.