Skip to main content

Sitecore Powershell script to get all pages that contain the keyword

In this post, I am going to share a script which can help you find all the pages which contain a keyword in its content. This requirement came from the business team who wanted some insights about pages which use keywords like finance, commerce etc.
One can easily get this information from search functionality on Sitecore site or client. Or one can always create a powershell script and generate a report that can be shared with business users (yes, they love reports).

We had a few assumptions - 
  • We looked for keyword only in Rich text fields. You can modify script to include more field types.
  • We needed the page links rather than Sitecore content path as the business users were not familiar with Sitecore.
  • Mostly, the keyword was present in content items placed within _content folder under the page. For such items, we preferred to resolve the URL to the page ancestor to the content item. For this, we checked if the item path contains _content. If yes, then we limited the URL to page item only by removing the part containing the path to the content item in the url.
  • E.g. For item, /sitecore/content/SiteA/AboutUs/_content/heroBannerItem. Page Url - https://<domain>/AboutUs 
So, here is the script - 

$reportData = [System.Collections.ArrayList]@()
$reportFields = "ID|Name"
$reportFieldsArray = ($reportFields).Split("|");
$url="Url";

Write-Host "---Starting the Script---" -ForegroundColor DarkCyan

$sites = Get-Item -Path "/sitecore/content/SiteA"
$items = Get-ChildItem -Path $sites.ProviderPath -Recurse -Language * | Where-Object { $_.Fields | Where-Object {$_.Type -eq "Rich Text"} | Where-Object {$_.Value -like "*commercial*"}}

function Get-ItemUrl($itemToProcess){
     [Sitecore.Context]::SetActiveSite("website")
     $urlop = New-Object ([Sitecore.Links.UrlOptions]::DefaultOptions)
     $urlop.AddAspxExtension = $false
     $urlop.AlwaysIncludeServerUrl = $true
     $linkUrl = [Sitecore.Links.LinkManager]::GetItemUrl($itemToProcess,$urlop)
     $linkUrl
}

#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 Use Headers field in report before updating its standard value
foreach($item in $items){
$pageUrl=Get-ItemUrl($item);
$separator = [string[]]@("_content") 
if ($pageUrl -match $separator) { 
$tempArray = $pageUrl.Split($separator,[System.StringSplitOptions]::RemoveEmptyEntries);
$pageUrl=$tempArray[0];
}
$newReportRecord = Create-Report-Record -item $item  -fields $reportFieldsArray;
$newReportRecord.$url=$pageUrl;
$reportData.Add($newReportRecord)
}

Write-Host "---Script Completed---" -ForegroundColor DarkCyan
Write-Host "-----------------------------------------"


$reportProperties = @{
Title = "List of items containing - Commercial"
InfoTitle ="List of items containing - Commercial"
InfoDescription = "List of items containing - Commercial"
PageSize = 250
}
### END generate report ###
$reportData | Show-ListView @reportProperties -Property ($reportFieldsArray+=@($url))

Hope this helps you! Please like and subscribe the blog :)
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