Skip to main content

Sitecore Powershell script to update standard value of field without impacting existing item values

So, sometimes, the content authors and marketers feel that the default value of one of the fields mentioned in template standard values should be updated. The problem here is that the standard value for the field is already being used in hundreds of items derived from this template in the site. Updating the value for field in standard values will update the field value in all these items (if they have not been updated by an author ever). But we want that all the existing items should retain their current value, even if it is derived from standard value item. 
The easiest way to execute such updates is via Powershell :) 
The below script basically looks for ContainsStandardValue flag in the fields which tells Sitecore that the field value for item is derived from standard values. So our script shall reassign the value to the field programmatically whenever the flag is set to true. Reassigning will set the flag to false. The script generates a report comparing the values before the script is run with the values after the script has run.

$templateIds = '{D1F25FAF-9ECB-4447-A9F6-1F64E3E59B19}' #list of templateIds in which the Standard Value needs to be looked
$global:updatefield = $true
$global:fieldName = "My Field" #name of the field for which standard value needs to be updated
$global:fieldValue = "<value of the field eg. an Id or string>"
$global:languageVersion = "en-us"
$global:contentPath = "/sitecore/content/<site path>"
$reportData = [System.Collections.ArrayList]@()
$reportFields = "ID|FullPath|$($global:fieldName)"
$reportFieldsArray = ($reportFields).Split("|");
$UseHeaderAfter = "UseHeaders Value after updating Standard Value";
Write-Host "---Starting Update Field $($global:fieldName)  Script---" -ForegroundColor DarkCyan
Write-Host "Update $($global:fieldName) Field Setting = $($global:updatefield)"
$pages = Get-ChildItem -Path $($global:contentPath) -Language $($global:languageVersion) -Recurse | Where-Object {$templateIds -contains $_.TemplateID} 
#Reusable function to create record for the report
function Create-Report-Record {
    param(
        $item,        
        $fields
        ) 
    
    [System.Collections.Hashtable]$newReportRecord = @{}
    $fields | ForEach-Object {
        $currentField = $_
        $newReportRecord.$currentField = $item.$currentField;
    }    
   return $newReportRecord;
}
#capturing all of the values of the field in report before updating its standard value
foreach($page in $pages){
	$newReportRecord = Create-Report-Record -item $page  -fields $reportFieldsArray;
	$reportData.Add($newReportRecord)
}
#Looping through all the items to check if the value of the field is derived from Standard value. If yes, then programatically reassign the same value
foreach($page in $pages){
   
    #check if field is using the standard values or not
    $field = Get-ItemField -Item $page -ReturnType Field -Name $($global:fieldName)
	$val = $($field.Value)
    if ($field.ContainsStandardValue){        
        
        Write-Host "$($page.Name) is using standard value - $($field.Name) $val" -ForegroundColor Yellow
        if($global:updatefield){
            New-UsingBlock (New-Object Sitecore.Data.BulkUpdateContext) {
                #temp update the field programatically to its temp value to force "ContainsStandardValue" to be changed to false. This will ensure these values remain unchanged when Standard Value is updated for this field
                $page.Editing.BeginEdit()
                $page["$($global:fieldName)"] = "-1"
                $page.Editing.EndEdit() | Out-Null
                Write-Host "Use Headers field Updated To temp Value: 1 - $($page.Paths.FullPath)" -ForegroundColor DarkGreen
                #now set it back to original value again
                $page.Editing.BeginEdit()
                $page["$($global:fieldName)"] = $val
                $page.Editing.EndEdit() | Out-Null
                Write-Host "Use Headers Updated To original value: $val" -ForegroundColor Green
            }
        }
    }
    else{
        
        Write-Host "$($page.Name) - is NOT using standard value - Skipping Page Item. $($field.Name) $val"  -ForegroundColor Magenta
    }
}
#Update the standard value for Use Headers field
New-UsingBlock (New-Object Sitecore.Data.BulkUpdateContext) {
                $standardValueItem = Get-Item -Path "master:" -ID "{E36EEB09-F751-400A-A2BD-03F94ACDAFC5}" -Language $($global:languageVersion)
                $standardValueItem.Editing.BeginEdit()
                $standardValueItem["$($global:fieldName)"] = $($global:fieldValue);
                $standardValueItem.Editing.EndEdit() | Out-Null
}
#populating the values in report after updating the standard value
foreach($page in $pages){
    foreach($record in $reportData){
        if($record.ID -eq $page.ID){
            $field = Get-ItemField -Item $page -ReturnType Field -Name $($global:fieldName)
	        $record.$UseHeaderAfter = $($field.Value)
        }
    }    	
}
Write-Host "---Script Completed---" -ForegroundColor DarkCyan
Write-Host "-----------------------------------------"

$reportProperties = @{
	Title = "$($global:fieldName) Field Values"
	InfoTitle ="$($global:fieldName) Field Values"
	InfoDescription = "$($global:fieldName) Field Values"
	PageSize = 250
}
### END generate report ###
$reportData | Show-ListView @reportProperties -Property ($reportFieldsArray += @($UseHeaderAfter) )

I hope it helps you :)
Labels:

Popular posts from this blog

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
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 ;)
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
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 write
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 update it. • To avoid s
Read more