SharePoint | Alex Ø. T. Hansen

Alex Ø. T. Hansen

08/11/2018

SharePoint – Get all terms/keywords from the taxonomy store

Yesterday I publish an article how to replace/add keywords on documents. But one of the requirements was that you needed the ID of the term you want to find and add/replace. So yet again I created a small function that allows you to return all terms from the store.

You still need the PnP SharePoint cmdlets, which you can download here.

Function Get-SPTaxKeyword
{
    #Object array.
    $TermsCollection = @();

    #Get all term groups.
    $TermGroups = Get-PnPTermGroup;

    #Foreach term group.
    Foreach($TermGroup in $TermGroups)
    {
        #Get all term sets.
        $TermSets = $TermGroup | Get-PnPTermSet;

        #Foreach term set.
        Foreach($TermSet in $TermSets)
        {
            #Get all terms.
            $Terms = Get-PnPTerm -TermGroup $TermGroup.Name -TermSet $TermSet.Name;

            #Foreach term.
            Foreach($Term in $Terms)
            {
                #If a term is present.
                If($Term)
                {
                    #Create a new object.
                    $TermCollection = New-Object -TypeName PSObject;

                    #Add value to the object.
                    Add-Member -InputObject $TermCollection -Membertype NoteProperty -Name "TermGroupName" -Value ($TermGroup.Name);
                    Add-Member -InputObject $TermCollection -Membertype NoteProperty -Name "TermGroupId" -Value ($TermGroup.Id);
                    Add-Member -InputObject $TermCollection -Membertype NoteProperty -Name "TermGroupSetName" -Value ($TermSet.Name);
                    Add-Member -InputObject $TermCollection -Membertype NoteProperty -Name "TermGroupSetId" -Value ($TermSet.Id);
                    Add-Member -InputObject $TermCollection -Membertype NoteProperty -Name "TermName" -Value ($Term.Name);
                    Add-Member -InputObject $TermCollection -Membertype NoteProperty -Name "TermId" -Value ($Term.Id);

                    #Add to the object array.
                    $TermsCollection += $TermCollection;
                }
            }
        }
    }

    #Return terms.
    Return $TermsCollection;
}

#Get all keywords.
$Keywords = Get-SPTaxKeyword;

Function Get-SPTaxKeyword

{

#Object array.

$TermsCollection = @();

#Get all term groups.

$TermGroups = Get-PnPTermGroup;

#Foreach term group.

Foreach($TermGroup in $TermGroups)

{

#Get all term sets.

$TermSets = $TermGroup | Get-PnPTermSet;

#Foreach term set.

Foreach($TermSet in $TermSets)

{

#Get all terms.

$Terms = Get-PnPTerm -TermGroup $TermGroup.Name -TermSet $TermSet.Name;

#Foreach term.

Foreach($Term in $Terms)

{

#If a term is present.

If($Term)

{

#Create a new object.

$TermCollection = New-Object -TypeName PSObject;

#Add value to the object.

Add-Member -InputObject $TermCollection -Membertype NoteProperty -Name "TermGroupName" -Value ($TermGroup.Name);

Add-Member -InputObject $TermCollection -Membertype NoteProperty -Name "TermGroupId" -Value ($TermGroup.Id);

Add-Member -InputObject $TermCollection -Membertype NoteProperty -Name "TermGroupSetName" -Value ($TermSet.Name);

Add-Member -InputObject $TermCollection -Membertype NoteProperty -Name "TermGroupSetId" -Value ($TermSet.Id);

Add-Member -InputObject $TermCollection -Membertype NoteProperty -Name "TermName" -Value ($Term.Name);

Add-Member -InputObject $TermCollection -Membertype NoteProperty -Name "TermId" -Value ($Term.Id);

#Add to the object array.

$TermsCollection += $TermCollection;

}

#Return terms.

Return $TermsCollection;

}

#Get all keywords.

$Keywords = Get-SPTaxKeyword;

Alex Ø. T. Hansen

07/11/2018

SharePoint – Adding keywords to documents with PowerShell

Ever needed to replace or add keywords to documents in a SharePoint site?
Recently I was in charge of migrating site collections from a on-premise environment to SharePoint online.

After the migration we needed to replace a certain taxonomy keyword on all documents. So I created a small PowerShell function to facilitate the company to do so. The function takes 5 parameters:

Url
- URL to the site collection.
Credential
- Credentials to contact the site collection.
TermGuid
- The guid of the keyword that you want to find.
AddTermGuid
- The guid of the new keyword you want to add/replace.
Replace (switch)
- If this switch is set, it will substitute TermGuid with AddTermGuid

In order for the function to work you need to download the SharePoint PnP cmdlets here.

#Replace SharePoint keywords.
Function Add-SPTaxKeyword
{
    [cmdletbinding()]	
		
    Param
    (
        [Parameter(Mandatory=$true)][string]$Url,
        [Parameter(Mandatory=$true)][PSCredential]$Credential,
        [Parameter(Mandatory=$true)][string]$TermGuid,
        [Parameter(Mandatory=$true)][string]$AddTermGuid,
        [Parameter(Mandatory=$false)][switch]$Replace
    )

    #Connect to SharePoint site.
    Connect-PnPOnline -Url $Url -Credentials $Credential;

    #Get all libraries/list.
    $Lists = Get-PnPList;

    #Foreach list.
    Foreach($List in $Lists)
    {
        #Get all list items that have specific term guid.
        $ListItems = Get-PnPListItem -List $List.Title | Where-Object {$TermGuid -in $_.FieldValues.TaxKeyword.TermGuid};

        #Foreach list item.
        Foreach($ListItem in $ListItems)
        {
            #If remove source term is set.
            If($Replace)
            {
                #Add keyword and remove source.
                [array]$TermGuids = $ListItem.FieldValues.TaxKeyword.TermGuid;
                [array]$TermGuids += $AddTermGuid;
                [array]$TermGuids = $TermGuids | Where-Object {$_ -ne $TermGuid}
            }
            Else
            {
                #Don't remove anyone.
                [array]$TermGuids = $ListItem.FieldValues.TaxKeyword.TermGuid;
                [array]$TermGuids += $AddTermGuid;
            }

            #Set the keyword on the item.
            Set-PnPListItem -List $List.Title -Identity $ListItem.Id -Values @{"TaxKeyword"=$TermGuids};
        }
    }
}

#Add the keyword.
Add-SPTaxKeyword -Url "https://contoso.sharepoint.com/sites/intranet" -Credential (Get-Credential) -TermGuid "fd9e6751-e7c2-4a71-80ec-486a65eb1ed2" -AddTermGuid "6564c2fe-b39e-4454-b11c-5507a7568948" -Replace;

#Replace SharePoint keywords.

Function Add-SPTaxKeyword

{

[cmdletbinding()]

Param

(

[Parameter(Mandatory=$true)][string]$Url,

[Parameter(Mandatory=$true)][PSCredential]$Credential,

[Parameter(Mandatory=$true)][string]$TermGuid,

[Parameter(Mandatory=$true)][string]$AddTermGuid,

[Parameter(Mandatory=$false)][switch]$Replace

)

#Connect to SharePoint site.

Connect-PnPOnline -Url $Url -Credentials $Credential;

#Get all libraries/list.

$Lists = Get-PnPList;

#Foreach list.

Foreach($List in $Lists)

{

#Get all list items that have specific term guid.

$ListItems = Get-PnPListItem -List $List.Title | Where-Object {$TermGuid -in $_.FieldValues.TaxKeyword.TermGuid};

#Foreach list item.

Foreach($ListItem in $ListItems)

{

#If remove source term is set.

If($Replace)

{

#Add keyword and remove source.

[array]$TermGuids = $ListItem.FieldValues.TaxKeyword.TermGuid;

[array]$TermGuids += $AddTermGuid;

[array]$TermGuids = $TermGuids | Where-Object {$_ -ne $TermGuid}

}

Else

{

#Don't remove anyone.

[array]$TermGuids = $ListItem.FieldValues.TaxKeyword.TermGuid;

[array]$TermGuids += $AddTermGuid;

}

#Set the keyword on the item.

Set-PnPListItem -List $List.Title -Identity $ListItem.Id -Values @{"TaxKeyword"=$TermGuids};

}

#Add the keyword.

Add-SPTaxKeyword -Url "https://contoso.sharepoint.com/sites/intranet" -Credential (Get-Credential) -TermGuid "fd9e6751-e7c2-4a71-80ec-486a65eb1ed2" -AddTermGuid "6564c2fe-b39e-4454-b11c-5507a7568948" -Replace;

You are able to get the SharePoint taxonomy keyword GUID through the Get-PnPTerm cmdlet, find more information here.

Alex Ø. T. Hansen

13/07/2018

PowerShell – Add an item to a list in SharePoint through REST

Need to add a item to a list in SharePoint with PowerShell?

I have create a small function that allows you to use the REST API in SharePoint to create a list item.

################################################
<# Function - Start #>

#Creates a PS credential object.
Function Create-PSCredential
{
    [cmdletbinding()]	
		
    Param
    (
        [Parameter(Mandatory=$true, HelpMessage="Please provide a valid username, example 'Domain\Username'.")]$Username,
        [Parameter(Mandatory=$true, HelpMessage="Please provide a valid password, example 'MyPassw0rd!'.")]$Password
    )

    #Convert the password to a secure string.
    $SecurePassword = $Password | ConvertTo-SecureString -AsPlainText -Force;

    #Convert $Username and $SecurePassword to a credential object.
    $Credential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $Username,$SecurePassword;

    #Return the credential object.
    Return $Credential;
}

#Adds a SharePoint List Item using REST.
Function Create-SPListItem
{
    [cmdletbinding()]

    Param
    (
        [Parameter(Mandatory=$True)]$Credential,
        [Parameter(Mandatory=$True)][string]$Site,
        [Parameter(Mandatory=$True)][string]$List,
        [Parameter(Mandatory=$True)][HashTable]$Content
    )

    #Construct path to list API.
    $ListSvc = ($Site + "/_vti_bin/listdata.svc/" + $List);

    #Webrequest headers.
    $Headers = @{
        "Accept" = "application/json;odata=verbose";
    }

    #Convert hashtable to JSON.
    $Body = $Content | ConvertTo-Json;

    #Invoke the REST API.
    $Result = Invoke-WebRequest -Uri $ListSvc -Method Post -Credential $Credential -Headers $Headers -ContentType "application/json" -Body $Body;

    #If the status description is set to created.
    If($Result.StatusDescription -eq "Created")
    {
        #True.
        Return $true;
    }
    Else
    {
        #False.
        Return $false
    }
}

<# Functions - End #>
################################################
<# Main - Start #>

#SharePoint site.
$SPSite = "https://sharepoint.contoso.com/site/123";

#SharePoint list name.
$SPList = "MyList";

#Credentials.
$Username = “Contoso\User”;
$Password = “MyPassword”;
$Credential = Create-PSCredential -Username $Username -Password $Password;

#List Item Data.
$Content = @{
    Column1 = "Data1";
    Column2 = "Data2";
    Column3 = "Data3";
}

Create-SPListItem -Credential $Credential -Site $SPSite -List $SPList -Content $Content;

<# Main - End #>
################################################

################################################

<# Function - Start #>

#Creates a PS credential object.

Function Create-PSCredential

{

[cmdletbinding()]

Param

(

[Parameter(Mandatory=$true, HelpMessage="Please provide a valid username, example 'Domain\Username'.")]$Username,

[Parameter(Mandatory=$true, HelpMessage="Please provide a valid password, example 'MyPassw0rd!'.")]$Password

)

#Convert the password to a secure string.

$SecurePassword = $Password | ConvertTo-SecureString -AsPlainText -Force;

#Convert $Username and $SecurePassword to a credential object.

$Credential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $Username,$SecurePassword;

#Return the credential object.

Return $Credential;

}

#Adds a SharePoint List Item using REST.

Function Create-SPListItem

{

[cmdletbinding()]

Param

(

[Parameter(Mandatory=$True)]$Credential,

[Parameter(Mandatory=$True)][string]$Site,

[Parameter(Mandatory=$True)][string]$List,

[Parameter(Mandatory=$True)][HashTable]$Content

)

#Construct path to list API.

$ListSvc = ($Site + "/_vti_bin/listdata.svc/" + $List);

#Webrequest headers.

$Headers = @{

"Accept" = "application/json;odata=verbose";

}

#Convert hashtable to JSON.

$Body = $Content | ConvertTo-Json;

#Invoke the REST API.

$Result = Invoke-WebRequest -Uri $ListSvc -Method Post -Credential $Credential -Headers $Headers -ContentType "application/json" -Body $Body;

#If the status description is set to created.

If($Result.StatusDescription -eq "Created")

{

#True.

Return $true;

}

Else

{

#False.

Return $false

}

<# Functions - End #>

################################################

<# Main - Start #>

#SharePoint site.

$SPSite = "https://sharepoint.contoso.com/site/123";

#SharePoint list name.

$SPList = "MyList";

#Credentials.

$Username = “Contoso\User”;

$Password = “MyPassword”;

$Credential = Create-PSCredential -Username $Username -Password $Password;

#List Item Data.

$Content = @{

Column1 = "Data1";

Column2 = "Data2";

Column3 = "Data3";

}

Create-SPListItem -Credential $Credential -Site $SPSite -List $SPList -Content $Content;

<# Main - End #>

################################################

Alex Ø. T. Hansen

21/09/2016

SharePoint – User Profile Image Cross-Site with ADFS

If you have spread the MySite and a web application into separated SharePoint Web Application and both of these is using AD FS for authentication. You maybe noticed that you are not able to load user profile thumbnails from the MySite. This is because a token is not issued from the MySite web application and Cross-Origin Resource Sharing (CORS) that is a security measure.

But luckily Microsoft have acknowledged this and have added a PowerShell command that allows to load pictures/resources from other SharePoint web applications on the same farm.

Alex Ø. T. Hansen

13/09/2016

SharePoint – Reduce the search system impact

It’s possible to set the performance for a SharePoint search crawl with PowerShell. This becomes handy if you are on a developing environment where performance isn’t crucial.

There are 3 valid modes:

Reduced
- Total number of threads = number of processors, Max Threads/host = number of processor.
PartlyReduced (default)
- Total number of threads = 4 times the number of processors , Max Threads/host = 16 times the number of processors
Maximum
- Total number of threads = 4 times the number of processors , Max Threads/host = 16 times the number of processors (threads are created at HIGH priority)

Use the following PowerShell commands in a SharePoint Management Shell.

Alex Ø. T. Hansen

06/09/2016

SharePoint – Enable BLOB Cache with PowerShell

Disk-based caching controls caching for binary large objects (BLOBs) such as image, sound, and video files, as well as code fragments. Disk-based caching is extremely fast and eliminates the need for database round trips. BLOBs are retrieved from the database once and stored on the Web client. Further requests are served from the cache and trimmed based on security.

Disk-based caching is disabled by default. To enable and customize the disk-based cache, you can run the following script.

Alex Ø. T. Hansen

01/09/2016

SharePoint – Disable throttling on a list

If you ever need to disable SharePoint throttling on a specific list instead of the whole web-application.

Alex Ø. T. Hansen

10/01/2016

SharePoint – WAS – Event ID 5021

I just had a customer who’s SharePoint application pool keep stopping.

We had the following output in the event log on the server:

The identity of application pool [AppPoolID] is invalid. The user name or password that is specified for the identity may be incorrect, or the user may not have batch logon rights. If the identity is not corrected, the application pool will be disabled when the application pool receives its first request.  If batch logon rights are causing the problem, the identity in the IIS configuration store must be changed after rights have been granted before Windows Process Activation Service (WAS) can retry the logon. If the identity remains invalid after the first request for the application pool is processed, the application pool will be disabled. The data field contains the error number.

The identity of application pool [AppPoolID] is invalid. The user name or password that is specified for the identity may be incorrect, or the user may not have batch logon rights. If the identity is not corrected, the application pool will be disabled when the application pool receives its first request. If batch logon rights are causing the problem, the identity in the IIS configuration store must be changed after rights have been granted before Windows Process Activation Service (WAS) can retry the logon. If the identity remains invalid after the first request for the application pool is processed, the application pool will be disabled. The data field contains the error number.

There can be 2 resolutions to this error, the following needs to be done.