Sunday, July 6, 2014

PowerShell: Script to update solution

Solution deployment is one important task for SharePoint developer/admin, being it in local environment or any other Production/non-production farm.
Here is a script to automate this job and avoid errors. Only manual task here is to provide “Variable Values”, i.e. – name of WSP, path, web application URL etc.
In this case WSP is already added to farm solution store and deployed. We did some changes in existing code and need to update the solution. The Update-SPSolution cmdlet upgrades a deployed SharePoint solution in the farm. Use this cmdlet only if a new solution contains the same set of files and features as the deployed solution. If files and features are different, the solution must be retracted and redeployed.

1.       Copy the script below, save it as PS file, i.e. – UpdateSolution.ps1
2.       Edit it in any compatible editor; change Declaration of the Variables section as per your requirement.
3.       Open PS prompt/SharePoint management Shell with admin rights.
4.       Navigate to the folder where PS file is saved
5.       Execute the PS file as .\UpdateSolution.ps1


# ***********Script Start*********************************************
## Function – Solution Update
## Author – Deepak Solanki (deepaksinghsolanki@gmail.com)
## Version – 1.0
##
## Checks to ensure that Microsoft.SharePoint.Powershell is loaded, if not, adding pssnapin
## Checks if solution is already exists or deployed in Farm and give appropriate message
## The Update-SPSolution cmdlet upgrades a deployed SharePoint solution in the farm.
## Use this cmdlet only if a new solution contains the same set of files and features as the deployed solution.
## If files and features are different, the solution must be retracted and redeployed.
# ********************************************************************

 #########################Declaration of the Variables###############################
#Solution Name
$SolutionName = “MySolution.wsp”;
#Literal Path
$SolutionPath = “C:\Deployment\MySolution.wsp”;
############################ Declaration of the (helper) function   # ####################
Function UpdateSolution([string] $SolutionName, [string] $SolutionPath)
{  
if($SolutionName.ToLower().EndsWith(“.wsp”) -and $SolutionPath.ToLower().EndsWith(“.wsp”))  
{     
$count = 0     
##check to ensure that Microsoft.SharePoint.Powershell is loaded     
$snapin = get-pssnapin | where-object{$_.Name -eq “Microsoft.SharePoint.Powershell”}    if($snapin -eq $null) 
{     
write-host “Loading SharePoint snapin”     
add-pssnapin “Microsoft.SharePoint.Powershell”      } 
     ##check if WSP already exists in Farm     
$WSPExist = Get-SPSolution | Where {  ($SolutionName -eq $_.Name)} 
     if($WSPExist -eq $null)     
{        
Write-Host “$SolutionName Solution does not exist in solution store, can not be updated.” -ForegroundColor Red     
}     
elseif ((Get-SPSolution $SolutionName).Deployed)   
{    
Write-Host “$SolutionName Solution already exists in solution store and has been deployed. Starting update…” -ForegroundColor Green    
$SolutionTocheck = Get-SPSolution -identity $SolutionName    
if ($SolutionToCheck.ContainsGlobalAssembly)         
{     
Update-SPSolution -Identity $SolutionTocheck -LiteralPath $SolutionPath -GACDeployment    
}    
else    
{     
Update-SPSolution -Identity $SolutionTocheck -LiteralPath $SolutionPath    
}    
Write-Host “Operation completed.”  
 }     
else     
{      
Write-Host “$SolutionName Solution exists in solution store but has not been deployed, can not be updated” -ForegroundColor Red   
}  
}  
else  
{  Write-Host “Please provide a valid parameter” -ForegroundColor Red  }
}
############################Actual Function Call  # ###########################
UpdateSolution $SolutionName $SolutionPath;

# ***********Script End here*****************************


PowerShell – Reading from CSV file

Reading from a csv, and doing some operation on the records returned by csv is one of the most common tasks in PowerShell. I’ll try to explain different cases here with sample code.
Below is the sample csv file “Sourcedata.csv” we’ll be using as example

TaskID, AssignTo, Duration
001, Tom, 55
002, Rand, 230
003, Mat, 86

##Script Starts here
 ##First declare a variable to store full path of  csv file
$SourceFile = “C:\Sourcedata.csv”;

##Use Test-Path to ensure that given file exists
if(Test-Path $SourceFile)
{
## Case 1 – Read the full CSV file and store result in a variable
$allRecords = Import-csv -path $SourceFile

##Case 2 – If csv has huge data and you want selected rows only, you can filter data with where condition
$selectedRecords = Import-csv -path $SourceFile|Where-Object {$_.AssignTo.Contains(“Rand”)}

##Case 3- If csv has data but no column headers and you want to put headers in order to manipulate data later, you can add headers while importing csv
$allRecordswithHeader = Import-csv -Header TaskID, AssignTo, Duration -path $SourceFile

#Now you have data with you and want to start operations on each of the row, simple- iterate through records
foreach($record in $allRecords)
{
$assignTo = $record.AssignTo;
Write-Host $assignTo
## Do your operation here..
}
##Script Ends here

Happy scripting 

PowerShell : Create Managed Properties in SharePoint Search Service Application

A common requirement in SharePoint search is to create Managed Properties and map it to crawled properties so that it can be used in search query.
Below is the approach to write a PS script that can be used to create one or more managed properties using an input XML file.
1. Create an xml file ‘ManagedProperties.xml’ as below and provide details.




2. Write the script in any suitable editor and save it as ”ManagedProperties.ps1′
# ******************************************************************* #
# Function – ManagedProperty Creation #
# Author – Deepak Solanki [deepaksinghsolanki@gmail.com]
# ********************************************************************
######################################################
# make sure to load SharePoint snapin if not defined #######################################################[System.reflection.Assembly]::LoadWithPartialName(“Microsoft.SharePoint”)
$snapin=”Microsoft.SharePoint.PowerShell”
if (get-pssnapin $snapin -ea “silentlycontinue”) 
{    
write-host -f Green “PSsnapin $snapin is loaded” 
}
elseif (get-pssnapin $snapin -registered -ea “silentlycontinue”) 
{    
write-host -f Green “PSsnapin $snapin is registered”     Add-PSSnapin $snapin     write-host -f Green “PSsnapin $snapin is loaded” 
}
else 
{     
write-host -f orange “PSSnapin $snapin not found” -foregroundcolor Red 
}

#################################################################
# Function definition #
function createManagedProperty($xmlFile,$searchApplicationName) 
{    
$configXml = [xml]( get-content $xmlFile)    
$searchapp = Get-SPEnterpriseSearchServiceApplication $searchApplicationName
$category = Get-SPEnterpriseSearchMetadataCategory -Identity SharePoint -SearchApplication $searchapp
 foreach($metaProp in  $configXml.managedproperties.managedproperty)
{        
Write-Host -ForegroundColor Green “Creating property: ” $metaProp.Name         $crawledPropName = $metaProp.crawlproperty           
##Check if Managed property already exist        
$ManagedProp = Get-SPEnterpriseSearchMetadataManagedProperty -SearchApplication  $searchapp -Identity $metaProp.name -ErrorAction SilentlyContinue
  ##Delete existing managed property        
if($ManagedProp -ne $null)         
{            
$ManagedProp.DeleteAllMappings()            
Remove-SPEnterpriseSearchMetadataManagedProperty -SearchApplication $searchapp -Identity $metaProp.name -Confirm:$false         
}   
else   
{    
##Create Managed property    
New-SPEnterpriseSearchMetadataManagedProperty -SearchApplication $searchapp -Name $metaProp.name -Type $metaProp.type -Queryable $true -Retrievable $true    
     
$ManagedProp = Get-SPEnterpriseSearchMetadataManagedProperty -SearchApplication  $searchapp -Identity $metaProp.name      
##Check if Crawled Property is available        
$crawledproperty = Get-SPEnterpriseSearchMetadataCrawledProperty -SearchApplication $searchapp -Name $crawledPropName -ErrorAction SilentlyContinue     
##Map managed property to crawl property        
if($crawledproperty -ne $null)         
{            
New-SPEnterpriseSearchMetadataMapping -SearchApplication $searchapp -ManagedProperty $ManagedProp -CrawledProperty $crawledproperty         
}   
else   
{    
Write-Host -ForegroundColor Red “Crawled property does not exist: ” $crawledPropName     
}           
}
}
###########################################
# Declaration of the constants            #
###########################################
$SearchApplicationName = “Search Service Application”
$configfile = “ManagedProperties.xml”
$executingScriptDirectory = Split-Path -Path $MyInvocation.MyCommand.Definition -Parent
$file = “$executingScriptDirectory/$configfile”
###Actual execution starts here###
Write-Host -foregroundcolor Green “***Script Started***”
createManagedProperty -searchApplicationName $SearchApplicationName -xmlFile $file
Write-Host -foregroundcolor Green “***Script Completed***”

3. Make sure that PS script and XML file are in same directory.
4. Ensure that you have provided correct “$SearchApplicationName” in PS script.
5. Open the PowerShell/SharePoint PowerShell console and run the PS script.
6. While Copying XML and script from this blog, verify if special characters (“-$ etc) are correct.
Happy Scripting!!!