SPDocKit
Try it for FreeContact UsProduct Site
  • SPDocKit by Syskit
  • Release Notes
    • SPDocKit 12
    • SPDocKit 11.1.0
    • SPDocKit 11
    • SPDocKit 10
    • SPDocKit 9.1.0
    • SPDocKit 9
    • SPDocKit 8.0.3
    • SPDocKit 8
  • Requirements
    • SharePoint On-Premises User Permissions Requirements
    • Supported SharePoint Editions
    • System Requirements
    • Server Load Permission Requirements
    • Service Application Permission Requirements
  • Installation
    • Install SPDocKit
    • Upgrade to the Latest Version
    • Uninstall SPDocKit
  • Activation
    • Activate SPDocKit
    • Manage License
    • Activation Privacy Statement
  • Configuration
    • Configure SPDocKit
    • Configure SPDocKit Database
    • Import and Export SPDocKit Settings
  • Create SharePoint Farm Snapshots
    • Snapshots Screen
    • Manual Snapshots
    • Automatic Snapshots
  • Explore Reports & Create Documentation
    • Farm Explorer
      • Farm Explorer Screen
      • Farm Dashboard
      • Farm Explorer Reports
      • Farm Documentation
      • Passwords and Product keys
      • Generate an AutoSPInstaller XML Configuration File
      • Change the Limit on Site Topology Report
    • Site Explorer
      • Site Explorer Screen
    • Permission Reports
      • Permissions Reports screen
    • Analytics and Usage Reports
      • Analytics and Usage Reports Screen
      • Analytics Dashboard
      • Site Collection Analytics
      • Document Extensions Reports
    • Audit Reports
      • Audit Reports Screen
      • Audit Dashboard
      • Audit Log Details
      • Administrative Actions
      • Audit Settings
    • Best Practices
      • Best Practices Screen
      • Best Practices Reports
    • Subscriptions and Alerts
      • Subscriptions and Alerts
      • Create New Subscription
      • Create New Alert
    • Customizing Reports
      • Customize View
      • Add Comments
  • Compare SharePoint Configurations
    • Compare Wizard
    • Compare SharePoint Farms
    • Compare Servers
    • Compare Web Applications
    • Compare Site Collections
    • Compare SharePoint Permissions
    • Compare Web.Config Files
  • Manage SharePoint Permissions
    • Permissions Explorer Screen
    • Manage Permissions Ribbon Actions
    • Users and Groups Actions
      • Manage Groups Wizard
      • Group Memberships Wizard
      • Copy Permissions Wizard
      • Move Permissions Wizard
      • Manage Permissions Wizard
      • Remove Permissions Wizard
    • Securable Objects Actions
      • Break/Restore Permission Inheritance Wizard
      • Restore Permissions
      • Copy Object Permissions Wizard
    • Site Collection Actions
      • Site Collection Administrators Wizard
      • Permission Levels Wizard
      • Clean Site Collections Wizard
    • Add Tags
    • SPDocKit Permission Management Event Log
  • Configure & Extend SPDocKit
    • Backstage Screen
    • Options Wizard
    • License Management
    • Role Based Security
    • Extend SPDocKit
      • Install SPDocKit Extensions
      • Download SPDocKit Extensions
      • Activate SPCAF Extension
  • Query & Change SharePoint Settings
    • Queries and Rules Screen
    • Create SharePoint Governance Policy Rule
    • Create SPDocKit Query
    • Change SPDocKit Query Results Limit
    • Create Audit Queries and Rules
  • FAQ
    • Requirements
    • Installation
    • Activation
    • Configuration
    • Features
    • Security
    • Miscellaneous
    • SPDocKit Insights Removed
    • SPDocKit Insights Migration
  • Known Issues
    • CREATE TABLE permissions denied
    • Custom features missing in reports
    • Data retention not working properly
    • Distributed Cache loading issue
    • Load crashes with NullReference exception
    • Available Windows updates
    • Permissions Wizard issue
    • PowerPivot FileNotFoundException issue
    • SQL Clusters support
    • Storage Metrics report subscription
    • Unaccounted differences in the UPA settings
    • Custom Query issue with URL export
    • Recursive groups issue with export
  • Troubleshooting
    • SharePoint
      • Could not access content database
      • The service application ‘UPA Name’ does not have any proxies that are default in a proxy group
    • Server Load & User Permissions
      • RPC Server is Unavailable
      • Error occurred while loading Web Application
      • Error occurred while trying to load 'Problems and Solutions' and 'Rule Definitions'
      • Error while loading IIS Settings Information
      • Errors while trying to load the SharePoint farm
      • Errors while loading server information
      • Failed at retrieving SQL Accounts from the following servers
      • My permissions loading status is reported as ”Failed”
      • Service was unable to read Active Directory properties
      • SQL Server is unavailable
      • Error adding service account to "spdockit_service_role" database role
    • SQL Server Connection
      • SPDocKit won’t connect to a provided server and database
      • Configure SQL server to listen on a specific port
      • Is SQL Server configured to use a named instance
      • Inbound traffic on TCP Port 1433 needs to be allowed on the SQL
      • Service user does not have rights to connect to the SQL server
      • TCP/IP network traffic not enabled on the SQL Server
Powered by GitBook
On this page
  • Installing
  • Activation

Was this helpful?

  1. Configure & Extend SPDocKit
  2. Extend SPDocKit

Activate SPCAF Extension

This article explains how to activate SPCAF Extension.

PreviousDownload SPDocKit ExtensionsNextQuery & Change SharePoint Settings

Last updated 2 years ago

Was this helpful?

SPCAF is a SharePoint Code Analysis Framework developed by RENCORE GmbH. It provides detailed information about SharePoint customization’s (WSPs or Add-ins) code quality, dependencies, complexity and more.

Use SPDocKit to load WSPs information from your SharePoint farm and then add SPCAF reports using Extension Manager to analyze them. Available SPCAF reports include Analysis Summary, Code Quality, Code Metrics, Code Dependencies, and Code Inventory. They are located in the Content & Usage Reports section of SPDocKit.

Please note! Because of a .NET Framework 4.0 requirement, SPDocKit with SPCAF extension only supports SharePoint Versions SP2013 and SP2016. SPCAF extension for SPDocKit is free but it is dependent on the third-party license, which is not provided by the SPDocKit team. Please refer to the website for more information on pricing.

If you only wish to try the SPCAF extension without activation, there is a trial mode where you can see the summary report. Click for more information.

Installing

To install SPCAF extension you can use either online or offline installation. For detailed instructions click .

Activation

If you already have the licensed SPCAF on a machine together with SPDocKit, the SPCAF plugin will be activated automatically.

As we mentioned before, you will receive your license key from Rencore. The key will be in a plain text format. This is what you need to do to create a license file: Create a file with extension “.lic”, e.g., “license.lic“. Then, open the file in your preferred text editor (e.g., notepad) and paste in your license key.

After you install the extension, you need to activate it. Take the license file (whose name must be license.lic) and place it in: “%ProgramData%\SPDocKit\Extensions\SPCAF”.

Please note! By default, the folders Extensions and SPCAF do not exist and you need to create them.

Please note that, by default, the folders Extensions and SPCAF do not exist and you need to create them.

After that, go to the SPCAF Reports in the Content & Usage Reports section of SPDocKit. Select any report, and you will notice the following message:

Click the Activate your license button.

Open the email and take the attached file (activations.caf). Place it in the following folder: “%USERPROFILE%\AppData\Local\SPCAF”

And that is it. You may try opening some of the SPCAF reports to make sure they are working properly.

You will notice a challenge code (in the previous picture). Visit the webpage and enter the code, as well as your e-mail address and the license key. The license key is the same one from the second step of this wizard. You need to open it with any text editor and copy/paste it. Click Submit. You will receive further instructions in your e-mail shortly, but here is what you need to do:

Please note! The SPCAF Reports section will be visible in the navigation tree only after the extension.

activation.spcaf.com
installing
RENCORE GmbH
here
here