Monday, 13 June 2016

Upload And Set Custom Master Page To Site Using CSOM PowerShell On SharePoint

Views
In this article post, you will learn how to upload custom master page to master page gallery and apply custom master pages to the site using CSOM Powershell on SharePoint 2013 / SharePoint 2016 / SharePoint online sites.


Steps Involved:


The following prerequisites need to be executed before going for any operations using CSOM PowerShell on SharePoint sites.
  1. Add the references using the Add-Type command with the necessary reference paths. The necessary references are Microsoft.SharePoint.Client.dll, Microsoft.SharePoint.Client.Runtime.dll.
    1. Add-Type -Path "C:\Program Files\Common Files\microsoft shared\Web Server Extensions\16\ISAPI\Microsoft.SharePoint.Client.dll"  
    2. Add-Type -Path "C:\Program Files\Common Files\microsoft shared\Web Server Extensions\16\ISAPI\Microsoft.SharePoint.Client.Runtime.dll"  
  2. Initialize client context object with the site URL.
    1. $siteURL = ""  
    2. $ctx = New-Object Microsoft.SharePoint.Client.ClientContext($siteURL)  
  3. If you are trying to access SharePoint Online site then you need to setup the site credentials with credentials parameter and load it to the client context. 
    1. #Not required for on premise site - Start  
    2. $userId = "abc@abc.onmicrosoft.com"  
    3. $pwd = Read-Host -Prompt "Enter password" -AsSecureString  
    4. $creds = New-Object Microsoft.SharePoint.Client.SharePointOnlineCredentials($userId, $pwd)  
    5. $ctx.credentials = $creds  
    6. #Not required for on premise site - End  
  4. If you are trying to access the SharePoint on premise site then the credentials parameter is not required to be set to the context but you need to run the code on the respective SharePoint Server or you need to pass the network credentials and set the context.
    1. #Credentials for on premise site - Start  
    2. $pwd = Read-Host -Prompt "Enter password" -AsSecureString  
    3. $creds = New-Object System.Net.NetworkCredential("domain\userid", $pwd)  
    4. $ctx.Credentials = $creds  
    5. #Credentials for on premise site - End  


Upload and Apply Master Page:


We will see how we can upload the master page file from local system to master page gallery and apply the uploaded master page to the site.
  • Get the master page from local.
    • Get the master page file local system URL and access the properties of master page file using Get-ChildItem method.
    • Then read the master page content using ReadAllBytes method and initialize the content to variable ($fileBytes).
      1. $pageFilePath = "D:\custom.master"  
      2. $pageFilePath = Get-ChildItem $pageFilePath  
      3. $fileBytes = [System.IO.File]::ReadAllBytes($pageFilePath.FullName)  
  • Set the master page file details.
    • Initialize file creation information object to set the master page file properties to be uploaded. 
    • To the object created, set the necessary parameters like URL, content. Overwrite parameter can be used to force write the file to the server.
      1.   
      2. $newFileInfo = New-Object Microsoft.SharePoint.Client.FileCreationInformation  
      3. $newFileInfo.Url = $pageFilePath.Name  
      4. $newFileInfo.Content = $fileBytes  
      5. $newFileInfo.Overwrite = $true  
  • Access the folder and add the master page.
    • Using the context, access the web. It should be root web since master page gallery is present at the top level site.
    • Then access the master page gallery folder using web and GetByTitle method.
    • From the web, get the source list and destination list using the list names. Then access the appropriate folder and the files method to add our new master page. Add new file creation information object created above. Load and execute the query.
      1. $web = $ctx.Site.RootWeb  
      2. $folder = $web.Lists.GetByTitle("Master Page Gallery")  
      3. $masterPage = $folder.RootFolder.Files.Add($newFileInfo)  
      4. $ctx.Load($web)  
      5. $ctx.Load($masterPage)  
      6. $ctx.ExecuteQuery()  
  • Publish as major version.
    • Then to publish the master page, we need to check out the file. Check out is required since the master page is neither checked out nor checked in as major version when the master page is uploaded. Load and execute the query for check out operation.
    •  Then check in the master page with comments and check in type. Check in type should be major version.
      1. #Check Out  
      2. $masterPage.CheckOut()  
      3. $ctx.Load($masterPage)  
      4. $ctx.ExecuteQuery()  
      5. #Check In and Publish  
      6. $masterPage.CheckIn("Majorversion checkin",[Microsoft.SharePoint.Client.CheckinType]::MajorCheckIn)  
      7. $ctx.Load($masterPage)  
      8. $ctx.ExecuteQuery()  
  • We have successfully uploaded the master page. No we will apply the master page to the site. 
    • From the web object, access the custom master url property and set the master page relative url. 
    • To set master page for custom pages, use CustomMasterUrl property. 
    • To set master page for system master pages, use MasterUrl property. 
    • After setting the properties, update the web object. Then load and execute the web object with the context.
      1. $web.CustomMasterUrl = $masterPage.ServerRelativeUrl  
      2. $web.MasterUrl = $masterPage.ServerRelativeUrl  
      3. $web.Update()  
      4. $ctx.Load($web)  
      5. $ctx.ExecuteQuery()  
The above steps will help us in uploading and setting the master page. The article focused on setting master pages for root level sites. If the master page needs to be set for subsite, then corresponding web object needs to be created before applying master page.