Guide

Install your License Key

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.

The following sections describe the different ways to install the license key depending on how you use SPCAF tools.

Note: When copying the license key from your email, please ensure to copy only the key, without the surrounding lines ("-----"). The license key will normally start with "0x0" and end with "==".

Install license key via SPCAF client application

  1. Start the SPCAF client application.

  2. In the header of the application click on the “Manage Licenses” icon.

  3. On the “Manage Licenses” page click the “Add” button.

  4. Paste your license key into the text field and click “Save”.

  5. After the successful installation of the key, your license is displayed in the section “Manage licenses”.

  6. Now your license has been applied to SPCAF.

Install license key via Visual Studio

  1. Start the Visual Studio IDE and open your SharePoint project for the analysis.

  2. In the “Tools” menu click “SPCAF SharePoint Code Analysis” -> “About”.

  3. In the “About” dialog of SPCAF click “Add License”.

  4. In the following screen click “Add License”.

  5. The “Enter SPCAF License” dialog will appear. Copy the license key from your email and paste it into the text field. Click “Save” to save the key to your computer.

  6. After successfully installing the key, your license will be displayed in the “Installed licenses” in the “About” dialog.

  7. Now you can use SPCAF with your license.

Install the License manually in the file system (advanced users)

For client installations (SPCAF Developer and Professional) the license key will need to be installed in the local AppData folder of the current user (which is typically: “C:\Users\YourUserName]\AppData\Local\SPCAF”).

Windows stores the path to the local AppData folder in the environment variable ‘localappdata’. To find out the physical path you can open a command prompt and enter “cd %localappdata%” to navigate to that folder.

  1. Navigate in Windows Explorer to folder “C:\Users\[YourUserName]\AppData\Local\SPCAF”.
  2. Create a file with the extension “.lic” (e.g. “License.lic).
  3. Open the file in your preferred text editor (e.g. notepad) and paste your license key.
  4. Save the file. Now you can use SPCAF with your license.

Install license for SPCAF Build license

For server installations, the license key needs to be installed in the folder which contains the main executable “spcaf.exe”.

Install License in Team Foundation Server

  1. Open TFS source control in Visual Studio.

  2. Navigate to the folder with the SPCAF executable files (e.g. “BuildProcessTemplates\CustomAssemblies\SPCAF”).

  3. Create a file with the extension “.lic”, e.g. “License.lic”.

  4. Open the file in your preferred text editor (e.g. notepad) and paste your license key.

  5. Perform a check-in on the folder.

  6. Now you can use SPCAF with your license.

Install the License for use in other build systems like TeamCity

  1. Navigate in Windows Explorer to the installation folder of SPCAF.
  2. Create a file with the extension “.lic_” (e.g. “License.lic).
  3. Open the file in your preferred text editor (e.g. notepad) and paste your license key.
  4. Save the file. Now you can use SPCAF with your license.

Last updated: 11/2/2023