CSS in SPFx Archives - European Sharepoint 2013 Hosting Blog

SharePoint 2013 Hosting – HostForLIFE.eu :: File Server Migration To SharePoint Online Using SPMT PowerShell

Dec 10th

Posted by Peter in European SharePoint 2013 Hosting

Recently we had a project where we needed to migrate file server to SharePoint Online. So, we decided to go with SharePoint Migration Tool (SPMT). But we had 50 plus folders and all were needed to migrate to different site document libraries. As it takes long time to migrate using tool due to creating connection, we decided to use the PowerShell version.

Issue

We faced the below issues in this requirement,

The documentation for this is not that accurate or in single place. We need to search here and there for things.
SPMT tool migrates file server child items directly but when you use PowerShell, it migrates parent folder. Due to the curse of first point, it took some time for us to find the hidden solution. Go through this post to see that hidden gem.
The last but not least is permission migration. SPMT has all this functionality but as I said earlier it is not documented well.

So, we will try to explain all our knowledge in detail here.

Solution

First, we need to prepare a csv which will be read by PowerShell and It will have connection details of source and migration.

Important notes for preparing csv,

Do not include a header row in your CSV file.
Remember to account for all six columns in the file, even if you are not needing a value for a given field.
If you use the standard out-of-the-box Document library (“Shared Documents”), you must use the Display name “Documents” as the placeholder value for the Target Document Library in your CSV file. If you enter “Shared Documents” in that column, you will receive an “invalid document library” error.

Note

If the language of the destination SharePoint site is other than English, check the Display name of the “Shared Documents” Document library by browsing to Documents library.

The format of csv is as below,

Source,SourceDocLib,SourceSubFolder,TargetWeb,TargetDocLib,TargetSubFolder

1	Source,SourceDocLib,SourceSubFolder,TargetWeb,TargetDocLib,TargetSubFolder

As we are migrating from file server, we will not pass the “SourceDocLib” & “SourceSubFolder” details. So, our csv detail will look like below,

File server path,,, TargetWeb,TargetDocLib,TargetSubFolder

For example,

C:\MigrationTests\testfiles,,,https://contoso.sharepoint.com/sites/Sample/,DocLibraryName,DocLibraryName_subfolder

In case you don’t want to migrate it to sub folder, the subfolder part will be blank.

File server path,,, TargetWeb,TargetDocLib,

For example,

C:\MigrationTests\testfiles,,,https://contoso.sharepoint.com/sites/Sample/,DocLibraryName,

In next blog we will use this csv in the PowerShell.

SharePoint 2013 Hosting – HostForLIFE.eu :: How To Create a Copy Of Site Page And Update Property Of The Web Parts

Dec 3rd

Posted by Peter in European SharePoint 2013 Hosting

In this article, we will learn how to copy a site page and update the property of web parts while creating a copy of the site page.

How to create a copy of the page

Step 1

First, we need to install SharePoint Patterns and Practices client-side libraries.

Use the below command to install the PNP package in your react spfx solution,

npm i @pnp/sp

Step 2

We will need the current context of the page. So, make sure you have defined the property of context and it has an assigned value as this.context as shown below:

export interface ICopyPageProps {  
   description: string;  
   context: any;  
}

1

2

3

4

export interface ICopyPageProps {

description: string;

context: any;

}

We can assigna value to property as in the below code,

const element: React.ReactElement<ICopyPageProps> = React.createElement(  
CopyPage,  
   {  
      description: this.properties.description,  
      context: this.context  
   }  
);

1

2

3

4

5

6

7

const element: React.ReactElement<ICopyPageProps> = React.createElement(

CopyPage,

{

description: this.properties.description,

context: this.context

}

);

Step 3

Now we need to import the library into our SPFx web part and access the root sp object and other methods of client-side pages like @pnp/sp, @pnp/sp/webs, @pnp/sp/clientside-pages.

import { sp } from "@pnp/sp";  
import "@pnp/sp/webs";  
import { ClientsidePageFromFile, IClientsidePage, ClientsideWebpart  
} from "@pnp/sp/clientside-pages";

1

2

3

4

import { sp } from "@pnp/sp";

import "@pnp/sp/webs";

import { ClientsidePageFromFile, IClientsidePage, ClientsideWebpart

} from "@pnp/sp/clientside-pages";

Step 4

Now we need the URL of the source page, from which page we want to create a copy of the page. We will store the URL of the source page in a variable.

var sourcePageURL = “https://****.sharepoint.com/sites/Test/SitePages/sourcepage.aspx”;

1	var sourcePageURL = “https://****.sharepoint.com/sites/Test/SitePages/sourcepage.aspx”;

Step 5

Now we will get the template of the source page from the url as below:

const pageTemplate = await ClientsidePageFromFile(sp.web.getFileByServerRelativePath(sourcePageURL));

1	const pageTemplate = await ClientsidePageFromFile(sp.web.getFileByServerRelativePath(sourcePageURL));

Step 6

Now we will generate the copy of the source page using the copy method. Copy method will have 4 parameters,

copy(web: IWeb, pageName: string, title: string, publish?: boolean, promotedState?: PromotedState): Promise<IClientsidePage>

web: The web where we will create the copy
pageName: The file name of the new page
title: The title of the new page
publish: If true the page will be published

Below is an example of how to use copy method:

const newPage = await pageTemplate.copy(sp.web, “Page Name”, “Page Title”, false);

1	const newPage = await pageTemplate.copy(sp.web, “Page Name”, “Page Title”, false);

Step 7

Using the copy method, a copy of the page will be created. Now we need to save this new page.

To save this new page, we need to use save method of pnp client side pages library. Save method has one parameter which has boolean value.

save(publish?: boolean): Promise<boolean>

If true the page is published, if false the changes are persisted to SharePoint but not published [Default: true]

Now a copy of the page is created.

It will create a copy page without updating any property of your web part.

If you want to update a property while creating a copy of the page use the below steps.

How to update the property of web parts while creating a copy of page

Step 1

After creating a copy and before saving the page, you need to get an instance of all web parts of the new page.

To get this, use the below method,

let WebpartPageWebpartInstance: string[] = this.getPageCustomWebPartsInstances(newPage);

1	let WebpartPageWebpartInstance: string[] = this.getPageCustomWebPartsInstances(newPage);

The above line of code will give you array of all web parts of the seleced page.

Step 2

Now we will use loop ‘for each’ on the instance of the page which we get from step 1.

And in this loop we will get the property and we can update any property which you want to update. Here in the below code I am updating Category property. So, if there is Category property in any of the web parts it will update it to Accounts,

WebpartPageWebpartInstance.forEach(webpartInstanceId => {  
            const currentWebpart: ClientsideWebpart = newPageDraft.findControl((c) => c.id === webpartInstanceId);  
            let currentProps: any = howToControl.getProperties();  
            if (currentProps.Category != undefined) {  
                currentProps.Category = “Accounts”;  
            }  
        }

1

2

3

4

5

6

7

WebpartPageWebpartInstance.forEach(webpartInstanceId => {

const currentWebpart: ClientsideWebpart = newPageDraft.findControl((c) => c.id === webpartInstanceId);

let currentProps: any = howToControl.getProperties();

if (currentProps.Category != undefined) {

currentProps.Category = “Accounts”;

}

Step 3

After this loop, you can save your page using the page. save method.

Below is the full code snippet for all the processes. In this code I am updating the value of the category property. You can also update multiple properties of the web part. Make sure that the property name is case sensitive.

public async copyAndUpdateProperty(currentObj) {  
    var selectedPage = currentObj.state.selectedPage;  
    var currentContext: any = currentObj.props.context;  
    var siteUrl = currentContext.pageContext.web._serverRelativeUrl;  
    var sourcePageUrl = siteUrl + "/SitePages/" + selectedPage;  
    if (selectedPage != "Select" && this.state.category != "Select" && this.state.title != "" && this.state.name != "") {  
        this.setState({  
            isLoading: true  
        });  
        var siteUrl = currentContext.pageContext.web._serverRelativeUrl;  
        var sourcePageUrl = siteUrl + "/SitePages/" + selectedPage;  
        const pageTemplate = await ClientsidePageFromFile(sp.web.getFileByServerRelativePath(sourcePageUrl));  
        const newPageDraft = await pageTemplate.copy(sp.web, this.state.title, this.state.name, false);  
        const howToWebpartId = "E8DFA76D-1752-46CB-9844-AADF4D18F698";  
        let howToWebpartPageWebpartInstanceId: string[] = this.getPageCustomWebPartInstanceIdByWebpartId(howToWebpartId.toLowerCase(), newPageDraft);  
        howToWebpartPageWebpartInstanceId.forEach(webpartInstanceId => {  
            const howToControl: ClientsideWebpart = newPageDraft.findControl((c) => c.id === webpartInstanceId);  
            //update properties as needed... this should be a typed object to make it easier...  
            let currentProps: any = howToControl.getProperties();  
            currentProps.Category = this.state.category;  
        });  
        newPageDraft.save(true);  
        alert("Page copied successfully");  
        this.setState({  
            isLoading: false  
        });  
    } else {  
        alert("Please select all values");  
    }  
}  
private getPageCustomWebPartInstanceIdByWebpartId(webpartId: string, page: IClientsidePage): string[] {  
    const instances: string[] = [];  
    page.sections.forEach(section => {  
        section.columns.forEach(column => {  
            column.controls.forEach(control => {  
                if (control.data.webPartId == webpartId) {  
                    instances.push(control.id);  
                }  
            });  
        });  
    });  
    return instances;  
}

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

public async copyAndUpdateProperty(currentObj) {

var selectedPage = currentObj.state.selectedPage;

var currentContext: any = currentObj.props.context;

var siteUrl = currentContext.pageContext.web._serverRelativeUrl;

var sourcePageUrl = siteUrl + "/SitePages/" + selectedPage;

if (selectedPage != "Select" && this.state.category != "Select" && this.state.title != "" && this.state.name != "") {

this.setState({

isLoading: true

});

var siteUrl = currentContext.pageContext.web._serverRelativeUrl;

var sourcePageUrl = siteUrl + "/SitePages/" + selectedPage;

const pageTemplate = await ClientsidePageFromFile(sp.web.getFileByServerRelativePath(sourcePageUrl));

const newPageDraft = await pageTemplate.copy(sp.web, this.state.title, this.state.name, false);

const howToWebpartId = "E8DFA76D-1752-46CB-9844-AADF4D18F698";

let howToWebpartPageWebpartInstanceId: string[] = this.getPageCustomWebPartInstanceIdByWebpartId(howToWebpartId.toLowerCase(), newPageDraft);

howToWebpartPageWebpartInstanceId.forEach(webpartInstanceId => {

const howToControl: ClientsideWebpart = newPageDraft.findControl((c) => c.id === webpartInstanceId);

//update properties as needed... this should be a typed object to make it easier...

let currentProps: any = howToControl.getProperties();

currentProps.Category = this.state.category;

});

newPageDraft.save(true);

alert("Page copied successfully");

this.setState({

isLoading: false

});

} else {

alert("Please select all values");

}

private getPageCustomWebPartInstanceIdByWebpartId(webpartId: string, page: IClientsidePage): string[] {

const instances: string[] = [];

page.sections.forEach(section => {

section.columns.forEach(column => {

column.controls.forEach(control => {

if (control.data.webPartId == webpartId) {

instances.push(control.id);

}

});

return instances;

}

Now your new page will have updated properties.

SharePoint Hosting – Document Sets In Modern SharePoint Libraries

Nov 26th

Posted by Peter in European SharePoint 2013 Hosting

Document Sets are “special” folders in Document Libraries that allow you to associate metadata to it and pass on this metadata to documents inside a Document Set. This has been one of the features that have not been widely popular among SharePoint Users. That could have been the reason that Document Sets capability was not available in Modern SharePoint Libraries until late 2019.

Earlier on, even though the Document Sets were available in SharePoint Online, it used to take the user into a Classic SharePoint Experience instead of the Modern SharePoint Experience. However, now you will see that the Modern Experience is retained for Document Sets as well.

Enabling Document Sets in a Modern SharePoint Site

The steps to enable the Document Sets in Modern SharePoint Sites are the same as what we used to do in Classic SharePoint Site.

Step 1

Activate the Document Set Feature – Go to Site Information > View all site settings > Site Collection Administration (group) > Site collection features. Activate the “Document Sets” feature on the site collection.

Step 2

Enable Document Set Content Type in Library – Go to Library settings > Advanced Settings > Allow management of content types? > Yes. Add the Document Set Content Type from the list of Existing Content Types.

If you have used document sets before, you would find that almost all the capabilities from a Classic Experience are carried over to the Modern Experience.

Users can select the Shared Columns, these are the columns that will sync the metadata properties from Document Set to the documents inside it
Users can select the columns to be displayed in Welcome Page View. This capability specifically differs from the folders. While folders will follow the same view, document sets give users an option to have a separate view that can have columns different from the parent view
Users can run Workflows on Document Sets. This capability is especially helpful in scenarios where you have multiple documents under a project or agreement that needs to be approved together. If you approve the document set, it can then be applied to all the documents inside it

However, there are still some features that are missing when compared to Document Sets in Classic Experience. I don’t think this has any huge impact on the usability of document sets in Modern Experience but they are worth mentioning.

No welcome page in Modern Document Sets. Technically, you still have the Welcome Page option in Document Set settings, but when the Welcome Page is customized, it changes the experience to Classic Mode.
No versioning on Modern Document Sets. Since document sets have metadata associated with it, it would have been better if we could see the versions to identify the property changes. Versioning would still work on the documents inside the Document Sets though.

I am glad that finally, we have another powerful feature now available in Modern SharePoint.

SharePoint Hosting – What Is SharePoint Framework (SPFx)?

Nov 19th

Posted by Peter in European SharePoint 2013 Hosting

We have done, a lot of coding on Server Side programming using .NET and other server-side technologies. Many systems were designed and developed in the server-side programming era. But today, I am sharing information about Client-Side SharePoint Development using SharePoint Framework (SPFx).

The SharePoint Framework (SPFx) development is a great milestone for SharePoint Client Side development. It is a page and web part model. This provides full support for client-side SharePoint development. It allows to easily integrating component with SharePoint data and supports for open source tooling.

With SharePoint Framework, you can use any of your preferred web technologies and tools in your preferred development environment. It is to build responsive and mobile-friendly SharePoint products and apps.

At Microsoft Ignite, the top discussed item was SharePoint Framework on Twitter among Microsoft Technologies at the event.

Background

SharePoint acts as an application or development platform for a long time and has become very popular. You will surprise because as per Microsoft, more than 200 thousand organizations have built their intranet on SharePoint. There is over 1 M active SharePoint developers helping their businesses.

SharePoint provided a lot of options to develop and customize from full-trust code execution on SharePoint Server itself, to Sandbox solutions, to Add-ins, to interface customization using CSS and JavaScript embedding.

Within a multi-tenant SharePoint Online environment, there is no support for full-trust code. Microsoft has depreciated Sandbox solutions. Add-ins or remote code execution (code getting executed somewhere else e.g. Azure) are the most common SharePoint Online development through standard API and JavaScript embedding.

It has made it difficult to keep up the evergreen model of SharePoint Online.

Objective

SharePoint Framework (SPFx) has the objective to solve all these issues using a standardized framework. It helps to build custom user interface extensions on top of SharePoint Online in a supportive and future prepared way as SharePoint Online keeps itself updated from time to time.

The SharePoint Framework was initially focusing only on client-side Web Parts which were already successful for the last 10+ years. But, the new model of SharePoint Framework is build up on the latest web technologies. It works well with new modern pages as well as in classical pages and SharePoint mobile apps.

SharePoint Framework comes with a new set of tooling which is based on cross-platform and open source technologies such as Node.js, Gulp, Webpack and Yeoman.

These frameworks are helpful at build time to streamline the developer experience for building, packaging, and deploying; but the actual execution of the SharePoint Framework code doesn’t have SharePoint Framework (SPFx) involvement.

Now, it has become feasible to work with SharePoint. It is very helpful for those developers as well who have never build SharePoint solutions previously.

Because of the above advantages, the SharePoint Framework (SPFx) has become popular.

SharePoint Hosting – Upload Nested Folder Structure And Files On A SP Online Library

Aug 31st

Posted by Peter in European SharePoint 2013 Hosting

Hi guys, let’s explore some amazing ways to completely migrate a nested folder structure with lots of different files which is from your local path to a SP online library using PnP PowerShell.

Here is the script to run on Windows ISE Powershell:

#Function to Copy Multiple Files with Folder structure to SharePoint Online Document Library
Function Migrate - PnPFolderToSPO() {
param(
[Parameter(Mandatory = $true)][string] $SiteURL,
[Parameter(Mandatory = $true)][string] $SourceFolderPath,
[Parameter(Mandatory = $true)][string] $LibraryName,
[Parameter(Mandatory = $true)][string] $LogFile)
Try {
Add - content $Logfile - value "`n---------------------- File Upload Script Started: $(Get-date -format 'dd/MM/yyy hh:mm:ss tt')-------------------"
#Connect to PnP Online
Connect - PnPOnline - Url $SiteURL - UseWebLogin
#Get the Target Folder to Upload
$Web = Get - PnPWeb
$List = Get - PnPList $LibraryName - Includes RootFolder
$TargetFolder = $List.RootFolder
$TargetFolderSiteRelativeURL = $TargetFolder.ServerRelativeURL.Replace($Web.ServerRelativeUrl, "")
#Get All Items from the Source
$Source = Get - ChildItem - Path $SourceFolderPath - Recurse
$SourceItems = $Source | Select FullName, PSIsContainer, @ {
Label = 'TargetItemURL';
Expression = {
$_.FullName.Replace($SourceFolderPath, $TargetFolderSiteRelativeURL).Replace("\"," / ")}}
Add - content $Logfile - value "Number of Items Found in the Source: $($SourceItems.Count)"
#Upload Source Items from Fileshare to Target SharePoint Online document library $Counter = 1 $SourceItems | ForEach - Object {
#Calculate Target Folder URL
$TargetFolderURL = (Split - Path $_.TargetItemURL - Parent).Replace("\"," / ")
$ItemName = Split - Path $_.FullName - leaf #Replace Invalid Characters $ItemName = [RegEx]::Replace($ItemName, "[{0}]" - f([RegEx]::Escape([String]
'\"*:<>?/\|')), '_') #Display Progress bar $Status = "uploading '" + $ItemName + "' to " + $TargetFolderURL + " ($($Counter) of $($SourceItems.Count))"
Write - Progress - Activity "Uploading ..." - Status $Status - PercentComplete(($Counter / $SourceItems.Count) * 100) If($_.PSIsContainer) {
#Ensure Folder
$Folder = Resolve - PnPFolder - SiteRelativePath($TargetFolderURL + "/" + $ItemName)
Write - host "Ensured Folder '$($ItemName)' to Folder $TargetFolderURL"
Add - content $Logfile - value "Ensured Folder '$($ItemName)' to Folder $TargetFolderURL"
}
Else {
#Upload File
$File = Add - PnPFile - Path $_.FullName - Folder $TargetFolderURL
Write - host "Uploaded File '$($_.FullName)' to Folder $TargetFolderURL"
Add - content $Logfile - value "Uploaded File '$($_.FullName)' to Folder $TargetFolderURL"
}
$Counter++
}
}
Catch {
Write - host - f Red "Error:"
$_.Exception.Message
Add - content $Logfile - value "Error:$($_.Exception.Message)"
}
Finally {
Add - content $Logfile - value "---------------------- File upload Script Completed: $(Get-date -format 'dd/MM/yyy hh:mm:ss tt')-----------------"
}
}
#Call the Function to Upload a Folder to SharePoint Online
Migrate - PnPFolderToSPO - SiteURL "https://samplesharenet.sharepoint.com/sites/classictest" - SourceFolderPath "C:\Users\Bharat\Documents\Bharat\General Works for Internal Requirements" - LibraryName "PnPCopytoLib" - LogFile "C:\Users\Bharat\PnPTest\Migration-LOG.log"

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

#Function to Copy Multiple Files with Folder structure to SharePoint Online Document Library

Function Migrate - PnPFolderToSPO() {

param(

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

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

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

[Parameter(Mandatory = $true)][string] $LogFile)

Try {

Add - content $Logfile - value "`n---------------------- File Upload Script Started: $(Get-date -format 'dd/MM/yyy hh:mm:ss tt')-------------------"

#Connect to PnP Online

Connect - PnPOnline - Url $SiteURL - UseWebLogin

#Get the Target Folder to Upload

$Web = Get - PnPWeb

$List = Get - PnPList $LibraryName - Includes RootFolder

$TargetFolder = $List.RootFolder

$TargetFolderSiteRelativeURL = $TargetFolder.ServerRelativeURL.Replace($Web.ServerRelativeUrl, "")

#Get All Items from the Source

$Source = Get - ChildItem - Path $SourceFolderPath - Recurse

$SourceItems = $Source | Select FullName, PSIsContainer, @ {

Label = 'TargetItemURL';

Expression = {

$_.FullName.Replace($SourceFolderPath, $TargetFolderSiteRelativeURL).Replace("\"," / ")}}

Add - content $Logfile - value "Number of Items Found in the Source: $($SourceItems.Count)"

#Upload Source Items from Fileshare to Target SharePoint Online document library $Counter = 1 $SourceItems | ForEach - Object {

#Calculate Target Folder URL

$TargetFolderURL = (Split - Path $_.TargetItemURL - Parent).Replace("\"," / ")

$ItemName = Split - Path $_.FullName - leaf #Replace Invalid Characters $ItemName = [RegEx]::Replace($ItemName, "[{0}]" - f([RegEx]::Escape([String]

'\"*:<>?/\|')), '_') #Display Progress bar $Status = "uploading '" + $ItemName + "' to " + $TargetFolderURL + " ($($Counter) of $($SourceItems.Count))"

Write - Progress - Activity "Uploading ..." - Status $Status - PercentComplete(($Counter / $SourceItems.Count) * 100) If($_.PSIsContainer) {

#Ensure Folder

$Folder = Resolve - PnPFolder - SiteRelativePath($TargetFolderURL + "/" + $ItemName)

Write - host "Ensured Folder '$($ItemName)' to Folder $TargetFolderURL"

Add - content $Logfile - value "Ensured Folder '$($ItemName)' to Folder $TargetFolderURL"

}

Else {

#Upload File

$File = Add - PnPFile - Path $_.FullName - Folder $TargetFolderURL

Write - host "Uploaded File '$($_.FullName)' to Folder $TargetFolderURL"

Add - content $Logfile - value "Uploaded File '$($_.FullName)' to Folder $TargetFolderURL"

}

$Counter++

}

Catch {

Write - host - f Red "Error:"

$_.Exception.Message

Add - content $Logfile - value "Error:$($_.Exception.Message)"

}

Finally {

Add - content $Logfile - value "---------------------- File upload Script Completed: $(Get-date -format 'dd/MM/yyy hh:mm:ss tt')-----------------"

}

#Call the Function to Upload a Folder to SharePoint Online

Migrate - PnPFolderToSPO - SiteURL "https://samplesharenet.sharepoint.com/sites/classictest" - SourceFolderPath "C:\Users\Bharat\Documents\Bharat\General Works for Internal Requirements" - LibraryName "PnPCopytoLib" - LogFile "C:\Users\Bharat\PnPTest\Migration-LOG.log"

Just enter your own respective details which are highlighted in the above script.

When it starts running, enter your Site Admin/Global Admin Tenant details to start the processing.

You can see the Uploading in Progress on your Windows Powershell ISE Interface. Just wait until it gets finished!

This script copies the contents of a folder to the SharePoint Online document library. It overwrites any existing file in the target SharePoint Online library. It creates a folder if it doesn’t exist on the target site already. We can also use this script to migrate files and folders from network file share to SharePoint Online document library!

Creative Idea

You can have the above script triggered through a Flow/Azure Flow[Logic Apps] to have an automated Copying and include Removal in the Source to establish an Automated Archival Process for your Business needs.

SharePoint Hosting – List All Content Editor Webparts Present In A SharePoint OnPremise Web Application Using PowerShell

Aug 24th

Posted by Peter in European SharePoint 2013 Hosting

In this article, I will provide information on how to get all the content editor webparts present under a web application using PowerShell.

Below are the components used in this document.

PowerShell
SharePoint 2016

Some time ago we get a request to collect an inventory on the current SharePoint environment; including how many content editor Webparts and the number of lists and libraries under a web application. Below is the step by step way to get all the content editor webparts present under a web application using PowerShell.

Power Shell File

Step 1

Create a text file. Name it as “GetTotalCEWP.ps1” file. Note that you will have to change the extension from “.txt” to “.ps1”

Step 2

Insert the below code to get the web application URL as an input from the user.

[CmdletBinding()]
param( [Parameter(Position=0,Mandatory=$true,ValueFromPipeline=$false,HelpMessage=“Input the Web Application URL.”)] [string]$WebApp)

Step 3

Insert the below code to load the SharePoint PowerShell snap in.

if ((Get - PSSnapin - Name Microsoft.SharePoint.PowerShell - ErrorAction SilentlyContinue) - eq $null) {  
    Write - Host "Loading SharePoint PowerShell"  
    Add - PSSnapin Microsoft.SharePoint.PowerShell  
}

1

2

3

4

if ((Get - PSSnapin - Name Microsoft.SharePoint.PowerShell - ErrorAction SilentlyContinue) - eq $null) {

Write - Host "Loading SharePoint PowerShell"

Add - PSSnapin Microsoft.SharePoint.PowerShell

}

Step 4

Insert the below code to get all the publishing pages and then fetch the content editor webparts from those pages.

$SPWebApp = Get - SPWebApplication $WebApp - EA SilentlyContinue  
if ($SPWebApp - eq $null) {  
    Write - Error "$WebApp url is not a valid!"  
} else {  
    $allsites = $SPWebApp.Sites  
    foreach($site in $allsites) {  
        try {  
            $allwebs = $site.AllWebs  
            foreach($web in $allwebs) {  
                try {  
                    if ([Microsoft.SharePoint.Publishing.PublishingWeb]::IsPublishingWeb($web)) {  
                        $pubpages = [Microsoft.SharePoint.Publishing.PublishingWeb]::GetPublishingWeb($web)  
                        $allpages = $pubpages.GetPublishingPages()  
                        foreach($page in $allpages) {  
                            GetCEWPFunction - url $page.Url  
                        }  
                    }  
                } catch {} finally {  
                    $web.Dispose()  
                }  
            }  
        } catch {} finally {  
            $site.Dispose()  
        }  
    }  
}

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

$SPWebApp = Get - SPWebApplication $WebApp - EA SilentlyContinue

if ($SPWebApp - eq $null) {

Write - Error "$WebApp url is not a valid!"

} else {

$allsites = $SPWebApp.Sites

foreach($site in $allsites) {

try {

$allwebs = $site.AllWebs

foreach($web in $allwebs) {

try {

if ([Microsoft.SharePoint.Publishing.PublishingWeb]::IsPublishingWeb($web)) {

$pubpages = [Microsoft.SharePoint.Publishing.PublishingWeb]::GetPublishingWeb($web)

$allpages = $pubpages.GetPublishingPages()

foreach($page in $allpages) {

GetCEWPFunction - url $page.Url

}

} catch {} finally {

$web.Dispose()

}

} catch {} finally {

$site.Dispose()

}

Step 5

There might be scenarios where we have added the content Editor webparts inside the List/Libraries forms (edit/view/display). Insert the below code to retrieve the same. We have to insert this code just before the first try/catch ends.

GetCEWPFunction - url $page.Url  
}  
}  
$lists = $web.GetListsOfType("DocumentLibrary") | ? {  
    $_.IsCatalog - eq $false  
}  
foreach($list in $lists) {  
    $allviews = $list.Views  
    foreach($view in $allviews) {  
        GetCEWPFunction - url $view.Url  
    }  
    $allforms = $list.Forms  
    foreach($form in $allforms) {  
        GetCEWPFunction - url $form.Url  
    }  
}  
}  
catch {} finally {  
    $web.Dispose()  
}  
}  
} catch {} finally {  
    $site.Dispose()  
}  
}  
}

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

GetCEWPFunction - url $page.Url

}

$lists = $web.GetListsOfType("DocumentLibrary") | ? {

$_.IsCatalog - eq $false

}

foreach($list in $lists) {

$allviews = $list.Views

foreach($view in $allviews) {

GetCEWPFunction - url $view.Url

}

$allforms = $list.Forms

foreach($form in $allforms) {

GetCEWPFunction - url $form.Url

}

catch {} finally {

$web.Dispose()

}

} catch {} finally {

$site.Dispose()

}

Step 6

Insert the below code to have the function named “GetCEWPFunction “ which would actually count the content editor webpart.

function GetCEWPFunction([string] $url) {  
    $manager = $web.GetLimitedWebPartManager($url, [System.Web.UI.WebControls.WebParts.PersonalizationScope]::Shared)  
    $allwebParts = $manager.WebParts  
    if ($allwebParts.Count - ne 0) {  
        foreach($webPart in $allwebParts) {  
            if ($webPart.GetType() - eq[Microsoft.SharePoint.WebPartPages.ContentEditorWebPart]) {  
                if ($webPart.ContentLink.Length - gt 0) {  
                    $file = $web.GetFile($webPart.ContentLink)  
                    $data = $file.OpenBinary()  
                    $encode = New - Object System.Text.ASCIIEncoding  
                    $contents = $encode.GetString($data)  
                    if ($contents.ToLower().Contains("<script>")) {  
                        Write - Output "$($web.Url)/$url (CONTENTLINK)"  
                    }  
                    break  
                }  
                if ($webPart.Content.InnerText.Contains("<script>")) {  
                    Write - Output "$($web.Url)/$url (HTML)"  
                }  
            }  
        }  
    }  
}

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

function GetCEWPFunction([string] $url) {

$manager = $web.GetLimitedWebPartManager($url, [System.Web.UI.WebControls.WebParts.PersonalizationScope]::Shared)

$allwebParts = $manager.WebParts

if ($allwebParts.Count - ne 0) {

foreach($webPart in $allwebParts) {

if ($webPart.GetType() - eq[Microsoft.SharePoint.WebPartPages.ContentEditorWebPart]) {

if ($webPart.ContentLink.Length - gt 0) {

$file = $web.GetFile($webPart.ContentLink)

$data = $file.OpenBinary()

$encode = New - Object System.Text.ASCIIEncoding

$contents = $encode.GetString($data)

if ($contents.ToLower().Contains("<script>")) {

Write - Output "$($web.Url)/$url (CONTENTLINK)"

}

break

}

if ($webPart.Content.InnerText.Contains("<script>")) {

Write - Output "$($web.Url)/$url (HTML)"

}

Step 7

The full file will look as attached with this article.

Step 8

Save your PowerShell File and test it by running below command. It will list down all the content editor webparts present under a web application

.\GetTotalCEWP.ps1 -WebApp http://portal.intranet.com

That is it. I hope you have learned something new from this article and will utilize this in your work.

Posts tagged CSS in SPFx

SharePoint 2013 Hosting – HostForLIFE.eu :: File Server Migration To SharePoint Online Using SPMT PowerShell

Issue

Solution

SharePoint 2013 Hosting – HostForLIFE.eu :: How To Create a Copy Of Site Page And Update Property Of The Web Parts

How to create a copy of the page

How to update the property of web parts while creating a copy of page

SharePoint Hosting – Document Sets In Modern SharePoint Libraries

Enabling Document Sets in a Modern SharePoint Site

SharePoint Hosting – What Is SharePoint Framework (SPFx)?

Background

Objective

SharePoint Hosting – Upload Nested Folder Structure And Files On A SP Online Library

SharePoint Hosting – List All Content Editor Webparts Present In A SharePoint OnPremise Web Application Using PowerShell

Power Shell File

BLOGROLL

Featured On

Posts tagged CSS in SPFx

SharePoint 2013 Hosting – HostForLIFE.eu :: File Server Migration To SharePoint Online Using SPMT PowerShell

Issue

Solution

SharePoint 2013 Hosting – HostForLIFE.eu :: How To Create a Copy Of Site Page And Update Property Of The Web Parts

How to create a copy of the page

How to update the property of web parts while creating a copy of page

SharePoint Hosting – Document Sets In Modern SharePoint Libraries

Enabling Document Sets in a Modern SharePoint Site

SharePoint Hosting – What Is SharePoint Framework (SPFx)?

Background

Objective

SharePoint Hosting – Upload Nested Folder Structure And Files On A SP Online Library

SharePoint Hosting – List All Content Editor Webparts Present In A SharePoint OnPremise Web Application Using PowerShell

Power Shell File

BLOGROLL

Featured On

Tags