How to Add Script Editor WebParts to SharePoint 2013 Publishing Pages using PowerShell.


Sathish Nadarajan
SharePoint MVP
Published On :   29 Aug 2015
Visit Count
Today :  3    Total :   9856
Plan, Migrate, Secure, Report
SharePoint & Office 365 Tool. Simple & Easy to Use. 15-Day Trial!

Sharegate: Kick-Ass Tool
Think Your SharePoint & Office 365 Are Secure ? Find Out Now!


Sometime back, we saw how to create the pages using powershell and how to Add some of the custom web parts to the Created Pages. Recently I met with another interesting requirement like, we need to add some script editor webpart to the publishing pages using PowerShell and the Script editor webpart should be inserted with some scripts as well.

Let us see how to do that. Here I am using a CSV File to Add the Script Editor WebParts in to the Page.

First let us see the CSV File Inputs.

PageURL

Script

Page1.aspx

<script>
//Any Script Here
</script>

Page2.aspx

<script>
//Any Script Here
</script>

And the Script would be

 ##================================================================================================
 ## Description	: Add the Script Editor WebParts to the Newly Created Pages based onthe Input from the CSV
 ## Author		: Sathish Nadarajan
 ## Date			: 13-Aug-2015
 ##================================================================================================
 
 # ============================================ Setup Input Paths ===========================================================
 
  
 $Host.UI.RawUI.WindowTitle = "-- Add Script Editor WebParts --"
 
 $StartDate = Get-Date
 Write-Host -ForegroundColor White "------------------------------------"
 Write-Host -ForegroundColor White "| Add Script Editor WebParts |"
 Write-Host -ForegroundColor White "| Started on: $StartDate |"
 Write-Host -ForegroundColor White "------------------------------------"
 
 $LogTime = Get-Date -Format yyyy-MM-dd_hh-mm
 $LogFile = ".\AddWebParts-$LogTime.rtf"
 
 #start-transcript $logfile
 
 $scriptBase = split-path $SCRIPT:MyInvocation.MyCommand.Path -parent
 Set-Location $scriptBase
 
 $ErrorActionPreference = "Stop"
 
 function AddPowerShellSnapin()
 {
     try
     {
         Write-Host "Adding PowerShell Snap-in" -ForegroundColor Green
         # Try to get the PowerShell Snappin.  If not, then adding the PowerShell snappin on the Catch Block
         Get-PSSnapin "Microsoft.SharePoint.PowerShell" 
     }
     catch
     {
         if($Error[0].Exception.Message.Contains("No Windows PowerShell snap-ins matching the pattern 'Microsoft.SharePoint.PowerShell' were found"))
         {
             Add-PSSnapin "Microsoft.SharePoint.PowerShell"
         }
     }
     Write-Host "Finished Adding PowerShell Snap-in" -ForegroundColor Green
 
 }
 
 function AddScriptEditorWebPart($webURL, $pageUrl, $script)
 {  
     $webPartProperty_Visible = $true  
     $web = get-spweb $webURL  
     $defaultPage = $web.GetFile("Pages/" + $pageUrl)  
   
     if($defaultPage.ListItem.File.CheckedOutByUser -eq $null)
     {           
         $defaultPage.CheckOut()
         # Get the LimitedWebPartManager  
         $webpartmanager=$defaultPage.GetLimitedWebPartManager([System.Web.UI.WebControls.WebParts.PersonalizationScope]::Shared)  
   
         #Create fancy GUID  
         $lvwpGuid1 = [System.Guid]::NewGuid().ToString()  
         $lvwpKey = "g_" + $lvwpGuid1.Replace("-","_")  
   
         # Instantiate wp  
         $lvwp =New-Object Microsoft.SharePoint.WebPartPages.ScriptEditorWebPart   
         $lvwp.ID = $lvwpKey  
         $code = "$"  
         $lvwp.Content =  $script
   
         $lvwp.Title = "Script Editor WebPart"   
         $lvwp.Visible = $webPartProperty_Visible   
         $lvwp.ChromeType = "None"  
         $lvwp.HorizontalAlign = "Center"   
         # Add the web part  
         $webpartmanager.AddWebPart($lvwp, "Main", 0);  
 
 
     # Check in the Page with Comments
                 $defaultPage.CheckIn("Checkin by PowerShell")
         
                 # Publish the Page With Comments
                 $defaultPage.Publish("Published by PowerShell")
                 }
 
 
   
     # Update the web  
     $web.Update();  
    
     write-host "success"  
     $web.Dispose()    
     write-host "Done"  
 }  
 
  
 try
 {
 
     AddPowerShellSnapin
     
     $ScriptEditorWebPartDetailsCSV = $scriptBase + "\data\Excel Data\" + "ScriptEditorWebPartDetails.csv"
 
     import-csv $ScriptEditorWebPartDetailsCSV | where {
         AddScriptEditorWebPart "https://MySiteCollection" $_.PageURL $_.Script
  
     }
 
     
 
      
 
     Write-Host "Script Execution Completed Successfully" -ForegroundColor Green 
 }
 catch
 {
     Write-Host "Custom Exception Happened on Main : " + $Error[0].Exception.Message -ForegroundColor Red  
 }
 

Make sure that the pages were not Checked Out by any other persons. If It is checked out, then the script will not consider that page. The webparts will not be added.

Apart from that, the script is very straight forward and nothing much to explain on it.

Download the CSV And the SCRIPT HERE

Happy Coding,

Sathish Nadarajan.

SharePoint Usage Reports
Usage reports, collaboration and audit for SharePoint.
Categories

KWizCom Scan