Skip to main content

Sitecore PowerShell script to remove rendering parameters

This blog introduces you to concept of updating rendering and rendering parameters using Sitecore PowerShell Extension. If you are maintaining a web application based on Sitecore with loads of content items, you may be familiar with content cleanup or update requests that comes from business. This is where Sitecore PowerShell Extension comes very handy and saves our life.

A little background ..

We were using Media Framework based connector for Brightcove videos integration in Sitecore 8.2 website. When we upgraded to Sitecore 10.1, connector for Brightcove videos integration was also migrated from Media Framework to Data Exchange Framework. So far so good. But we realized that Media Framework based integration involved storing some video and video player related data in rendering parameters as in snapshot below - 


We did not see these rendering parameters getting used anymore in Data Exchange Framework based integration. Hence, it was decided to remove these rendering parameters from renderings.

The Solution..

We started developing a PowerShell script which can do the job. So I needed some commands which can get me the rendering I am looking for. Below commands do the job - 

Basically, first we get the rendering item present in Renderings folder which we want to look up in page items
$renderingItem =  Get-Item -Path "master" -ID <item ID for rendering in Renderings folder goes here>

Now, we have the rendering item that we need to look into pages. So, we use below command to get instances of rendering item from the page item. 
Note: Below command will return an array of items or an item depending on the whether the rendering has multiple instance on the page or single instance on the page. 
$rendering = Get-Rendering -Item $item -Rendering $renderingItem -FinalLayout -Device $defaultLayout

Next you need to find if this rendering instance has any rendering parameters in it. Below command helps with that. This is true only if rendering parameters have some value -
if($params = $rendering.Parameters)

And then you need to remove these renderings from the page item. We do this by setting Parameters to null as below - 
$rendering.Parameters = $null;

Finally, we set the updated rendering on the page item using below command - 
Set-Rendering -Item $item  -Instance $rendering -FinalLayout -Device $defaultLayout

Collectively, if you need to run the script in a part of content tree, the script will look like this - 

$currentDatabase = $SitecoreContextItem.Database.Name
$siteRoot = "/sitecore/content/<path to your Site or item whose children you want to crawl>/";
$pageBaseTemplateID = "<base page template ID to identify page items>"
$RenderingID = "<item ID of the rendering from which you want to remove rendering parameters>"
$defaultLayout = Get-LayoutDevice "Default"

#below line gets only the page items from content tree
$items = @(Get-ChildItem -Path $siteRoot -Language * -Recurse) | Where-Object { [Sitecore.Data.Managers.TemplateManager]::GetTemplate($_).InheritsFrom($pageBaseTemplateID) }

if ($items -ne $null -and $items.Count -gt 0) {
$renderingItem =  Get-Item -Path "master" -ID $RenderingID

New-UsingBlock (New-Object Sitecore.Data.BulkUpdateContext){
foreach($item in $items)
{
if($rendering = Get-Rendering -Item $item -Rendering $renderingItem -FinalLayout -Device $defaultLayout)
{
if($rendering -is [system.array]){ #a page item can have multiple rendering instances
foreach($renderingInstance in $rendering){
if($params = $renderingInstance.Parameters)
{
Write-Messages -Message "Removing parameters from $($item.Paths.Path) for $($renderingInstance.UniqueID)"
Write-Messages -Message "Parameters Value :: $($params)"
$renderingInstance.Parameters = $null;
Set-Rendering -Item $item  -Instance $renderingInstance -FinalLayout -Device $defaultLayout
}
}
}
elseif($params = $rendering.Parameters)
{
Write-Messages -Message "Removing parameters from $($item.Paths.Path)"
Write-Messages -Message "Parameters Value :: $($params)"
$rendering.Parameters = $null;
Set-Rendering -Item $item  -Instance $rendering -FinalLayout -Device $defaultLayout
}
}
}
}
} 
else {
Write-Messages -Message "Content tree crawl complete; no items found.";
exit
}

In this example, we have removed rendering parameters from a rendering. You can do other updates too like updating the datasource etc. by similar approach.

It is always fun to work with PowerShell scripts in Sitecore. Hope it helps you. Thanks for reading!!



Labels:

Comments

Post a Comment

POPULAR POSTS

Sitecore PowerShell Script to create all language versions for an item from en version

  We have lots of media items and our business wants to copy the data from en version of media item to all other language versions defined in System/Languages. This ensures that media is available in all the languages. So, we created the below powershell script to achieve the same -  #Get all language versions defined in System/Languages $languages = Get-ChildItem /sitecore/System/Languages -recurse | Select $_.name | Where-Object {$_.name -ne "en"} | Select Name #Ensuring correct items are updated by comparing the template ID  $items = Get-ChildItem -Path "/sitecore/media library/MyProjects" -Recurse | Where-Object {'<media item template id>' -contains $_.TemplateID} #Bulk update context to improve performance New-UsingBlock (New-Object Sitecore.Data.BulkUpdateContext) { foreach($item in $items){    foreach($language in $languages){ $languageVersion = Get-Item -Path $item.Paths.Path -Language $language.Name #Check if language versi...
Post a Comment
Read more

Export Sitecore media library files to zip using SPE

If you ever require to export Sitecore media files to zip (may be to optimize them), SPE (Sitecore Powershell Extension) has probably the easiest way to do this for you. It's as easy as the below 3 steps -  1. Right click on your folder (icons folder in snap)>Click on Scripts> Click on Download 2. SPE will start zipping all the media files placed within this folder. 3. Once zipping is done, you will see the Download option in the next screen. Click Download Zip containing the media files within is available on your local machine. You can play around with the images now. Hope this helps!! Like and Share ;)
Post a Comment
Read more

Make Sitecore instance faster using Roslyn Compiler

When we install the Sitecore instance on local, the first load is slow. After each code deploy also, it takes a while for the Sitecore instance to load and experience editor to come up. For us, the load time for Sitecore instance on local machines was around 4 minutes. We started looking for ways to minimize it and found that if we update our Web.config to use Roslyn compiler and include the relevant Nugets into the project, our load times will improve. We followed the simple steps - Go to the Project you wish to add the NuGet package and right click the project and click 'Manage NuGet Packages'. Make sure your 'Package Source' is set to nuget.org and go to the 'Browse' Tab and search Microsoft.CodeDom.Providers.DotNetCompilerPlatform. Install whichever version you desire, make sure you note which version you installed. You can learn more about it  here . After installation, deploy your project, make sure the Microsoft.CodeDom.Providers.DotNetCompilerPlatform.d...
1 comment
Read more

Experience of a first time Sitecore MVP

The Journey I have been working in Sitecore for almost 10 years now. When I was a beginner in Sitecore, I was highly impressed by the incredible community support. In fact, my initial Sitecore learning path was entirely based on community written blogs on Sitecore. During a discussion with my then technology lead Neeraj Gulia , he proposed the idea that I should start giving back to developer community whenever I get chance. Just like I have been helped by many developers via online blogs, stackoverflow etc., I should also try to help others. Fast forward a few years and I met  Nehemiah Jeyakumar  (now an MVP). He had a big archive of his technical notes in the form Sitecore blogs. I realized my first blog dont have to be perfect and it can be as simple as notes to a specific problem for reference in future. That's when I probably created my first blog post on Sitecore. At that time, I didn't knew about the Sitecore MVP program. Over the years, I gained more confidence to writ...
2 comments
Read more

Clean Coding Principles in CSharp

A code shall be easy to read and understand. In this post, I am outlining basic principles  about clean coding after researching through expert recommended books, trainings and based on my experience. A common example to start with is a variable declaration like - int i  The above statement did not clarify the purpose of variable i. However,  the same variable can be declared as -  int pageNumber The moment we declared the variable as int pageNumber, our brain realized that the variable is going to store the value for number of pages. We have set the context in our brain now and it is ready to understand what the code is going to do next with these page numbers. This is one of the basic advantages of clean coding. Reasons for clean coding -  • Reading clean code is easier - Every code is revisited after certain amount of time either by the same or different developer who created it. In both the cases, if the code is unclean, its difficult to understand and u...
Post a Comment
Read more