Sunday, 3 July 2016

Working With SharePoint Web Scoped Features Using PnP PowerShell

Views
In this post, you will learn, how we can retrieve, activate or deactivate Web scoped features on SharePoint site or sub sites, using PnP PowerShell. The Client Side Object Model is used internally for these operations.

Prerequisite:

You need to have PowerShell 3.0 available on a Windows machine. You need to install or import PnP PowerShell packages. You can download the installers or view more documentation on the official site. The installers are available here. Online version installer is preferred for On Premise or Office 365 operations. You can also install all the three installers for testing (SharePoint 2013, 2016, online).

The following operations will be compatible with SharePoint 2013 On Premise and Office 365 versions.

Connect To Site:

Connect to the site, using the snippet, given below. PnP PowerShell code, given below, helps in getting the current context of the site, using the Client Side Object Model (CSOM).
  1. #Get Current Context Site (Root or subsite)  
  2. $siteurl = "https://abc.sharepoint.com/subsite"  
  3. Connect-SPOnline -Url $siteurl  
  4. $ctx = Get-SPOContext  
Since, we are working with the features with Web Scope, the site URL can be the site collection or sub sites available. Once connected, you can carry out any of the operations mentioned below, based on the requirement.

Retrieve Web Scope Features:

The Web scoped features active on the site or sub sites are retrieved in the operation, given below. Get-SPOFeature command is used to get all the features from the site. Since, we are retrieving the Web scoped features, the scope parameter is not required in this operation.

Each and every feature information is retrieved, using for each loop. The display name and definition Id are retrieved from the features. The code snippet given below helps retrieving all the Web scoped features from the site or sub site, specified in the context.
  1. function RetrieveFeatures(){  
  2.     # Get Web Scoped features  
  3.     $features = Get-SPOFeature -Scope Web  
  4.     Write-Host "Total active features count " $features.Count  
  5.     foreach($feature in $features){  
  6.         Write-Host "Feature Name : " $feature.DisplayName  
  7.         Write-Host "Feature ID   : " $feature.DefinitionId  
  8.     }  
  9.       
  10. }  
  11. RetrieveFeatures #Get all web scoped features from site   
The feature can be retrieved, using the identity. The identity can be the feature name or Id. The scope parameter is optional. Though, Web is passed as a scope. The following code snippet retrieves the feature, using the feature Id.
  1. function RetrieveFeature(){  
  2.     $features = Get-SPOFeature -Scope Web  
  3.     # Check whether FollowingContent feature is active  
  4.     $feature = Get-SPOFeature -Identity a7a2793e-67cd-4dc1-9fd0-43f61581207a -Scope Web  
  5.     if($feature.DisplayName -ne $null){  
  6.         Write-Host $feature.DisplayName " feature is active"          
  7.     }  
  8.     else{  
  9.         Write-Host "Couldn't find info about feature id. Feature is not active"  
  10.     }  
  11. }  
  12. RetrieveFeature #Get web scoped feature from site using feature id   

Enable Web Scope Feature:

The feature can be activated, using PnP PowerShell script. Enable-SPOFeature command is used to activate the features. Along with the command, the necessary parameter is the identity. The identity is the feature Id. The scope is an optional parameter.

The code snippet, given below, helps in activating the feature at the Web scope.
  1. function EnableFeature(){  
  2.     # Active Mobile View web feature  
  3.     Enable-SPOFeature -Identity d95c97f3-e528-4da2-ae9f-32b3535fbb59 -Scope Web  
  4.   
  5.     $feature = Get-SPOFeature -Identity d95c97f3-e528-4da2-ae9f-32b3535fbb59 -Scope Web
  6.     if($feature.DisplayName -ne $null){  
  7.         Write-Host $feature.DisplayName " feature is activated"  
  8.     }  
  9.     else{  
  10.         Write-Host "Feature is not activated"  
  11.     }  
  12. }  
  13. EnableFeature # Activates Mobile View web feature using feature id   

The image, given below, shows the operation.



The image, given below, shows the activated feature. The URL is required to access the Web scope feature.




Disable Web Scope Feature:

The feature can be deactivated, using PnP PowerShell script. Disable-SPOFeature command is used to deactivate the features. Along with the command, the necessary parameter is the identity. The identity is the feature Id. The scope is an optional parameter.

The code snippet, given below, helps in deactivating the feature at the Web scope.
  1. function DisableWebFeature(){  
  2.       
  3.     Disable-SPOFeature -Identity d95c97f3-e528-4da2-ae9f-32b3535fbb59 -Scope Web  
  4.       
  5.     $feature = Get-SPOFeature -Identity d95c97f3-e528-4da2-ae9f-32b3535fbb59 -Scope Web
  6.     if($feature.DisplayName -eq $null){  
  7.         Write-Host $feature.DisplayName " feature is deactivated"  
  8.     }  
  9.     else{  
  10.         Write-Host "Feature is still active"  
  11.     }  
  12. }  
  13. DisableWebFeature # Deactivates Mobile View web feature using feature id  
Note: The operations will be compatible for SharePoint 2013/2016 On Premise / SharePoint online sites.