Keyword | 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.