ConvertTo-PnPPage

SYNOPSIS

Converts a classic page (wiki or web part page) into a modern page

SYNTAX

ConvertTo-PnPPage -Identity <PagePipeBind>
                            [-Library <String>]
                            [-Folder <String>]
                            [-WebPartMappingFile <String>]
                            [-Overwrite [<SwitchParameter>]]
                            [-TakeSourcePageName [<SwitchParameter>]]
                            [-ReplaceHomePageWithDefault [<SwitchParameter>]]
                            [-AddPageAcceptBanner [<SwitchParameter>]]
                            [-SkipItemLevelPermissionCopyToClientSidePage [<SwitchParameter>]]
                            [-SkipUrlRewriting [<SwitchParameter>]]
                            [-SkipDefaultUrlRewriting [<SwitchParameter>]]
                            [-UrlMappingFile <String>]
                            [-ClearCache [<SwitchParameter>]]
                            [-CopyPageMetadata [<SwitchParameter>]]
                            [-AddTableListImageAsImageWebPart [<SwitchParameter>]]
                            [-UseCommunityScriptEditor [<SwitchParameter>]]
                            [-SummaryLinksToHtml [<SwitchParameter>]]
                            [-TargetWebUrl <String>]
                            [-LogType <PageTransformatorLogType>]
                            [-LogFolder <String>]
                            [-LogSkipFlush [<SwitchParameter>]]
                            [-LogVerbose [<SwitchParameter>]]
                            [-DontPublish [<SwitchParameter>]]
                            [-KeepPageCreationModificationInformation [<SwitchParameter>]]
                            [-SetAuthorInPageHeader [<SwitchParameter>]]
                            [-PostAsNews [<SwitchParameter>]]
                            [-DisablePageComments [<SwitchParameter>]]
                            [-PublishingPage [<SwitchParameter>]]
                            [-BlogPage [<SwitchParameter>]]
                            [-DelveBlogPage [<SwitchParameter>]]
                            [-DelveKeepSubTitle [<SwitchParameter>]]
                            [-PageLayoutMapping <String>]
                            [-PublishingTargetPageName <String>]
                            [-TargetPageName <String>]
                            [-TargetPageFolder <String>]
                            [-TargetPageFolderOverridesDefaultFolder [<SwitchParameter>]]
                            [-RemoveEmptySectionsAndColumns [<SwitchParameter>]]
                            [-TargetConnection <PnPConnection>]
                            [-SkipUserMapping [<SwitchParameter>]]
                            [-UserMappingFile <String>]
                            [-TermMappingFile <String>]
                            [-SkipTermStoreMapping [<SwitchParameter>]]
                            [-LDAPConnectionString <String>]
                            [-SkipHiddenWebParts [<SwitchParameter>]]

                            [-Connection <PnPConnection>]

EXAMPLES

EXAMPLE 1

ConvertTo-PnPPage -Identity "somepage.aspx" -Overwrite

Converts a wiki/web part page named 'somepage' to a client side page

EXAMPLE 2

ConvertTo-PnPPage -Identity "somepage.aspx" -Overwrite -WebPartMappingFile c:\contoso\webpartmapping.xml

Converts a wiki/web part page named 'somepage' to a client side page using a custom provided mapping file

EXAMPLE 3

ConvertTo-PnPPage -Identity "somepage.aspx" -Overwrite -AddPageAcceptBanner

Converts a wiki/web part page named 'somepage' to a client side page and adds the page accept banner web part on top of the page. This requires that the SPFX solution holding the web part (https://github.com/SharePoint/sp-dev-modernization/blob/master/Solutions/PageTransformationUI/assets/sharepointpnp-pagetransformation-client.sppkg?raw=true) has been installed to the tenant app catalog

EXAMPLE 4

ConvertTo-PnPPage -Identity "somepage.aspx" -Overwrite -CopyPageMetadata

Converts a wiki/web part page named 'somepage' to a client side page, including the copying of the page metadata (if any)

EXAMPLE 5

ConvertTo-PnPPage -Identity "somepage.aspx" -PublishingPage -Overwrite -TargetWebUrl "https://contoso.sharepoint.com/sites/targetmodernsite"

Converts a publishing page named 'somepage' to a client side page in the https://contoso.sharepoint.com/sites/targetmodernsite site

EXAMPLE 6

ConvertTo-PnPPage -Identity "somepage.aspx" -PublishingPage -Overwrite -TargetConnection $target

Converts a publishing page named 'somepage' to a client side page in the site specified by the TargetConnection connection. This allows to read a page in one environment (on-premises, tenant A) and create in another online location (tenant B)

EXAMPLE 7

ConvertTo-PnPPage -Identity "somepage.aspx" -Library "SiteAssets" -Folder "Folder1" -Overwrite

Converts a web part page named 'somepage' living inside the SiteAssets library in a folder named folder1 into a client side page

EXAMPLE 8

ConvertTo-PnPPage -Identity "somepage.aspx" -Folder "<root>" -Overwrite

Converts a web part page named 'somepage' living inside the root of the site collection (so outside of a library)

EXAMPLE 9

ConvertTo-PnPPage -Identity "somepage.aspx" -Overwrite -TargetWebUrl "https://contoso.sharepoint.com/sites/targetmodernsite"

Converts a wiki/web part page named 'somepage' to a client side page in the https://contoso.sharepoint.com/sites/targetmodernsite site

EXAMPLE 10

ConvertTo-PnPPage -Identity "somepage.aspx" -LogType File -LogFolder c:\temp -LogVerbose -Overwrite

Converts a wiki/web part page named 'somepage' and creates a log file in c:\temp using verbose logging

EXAMPLE 11

ConvertTo-PnPPage -Identity "somepage.aspx" -LogType SharePoint -LogSkipFlush

Converts a wiki/web part page named 'somepage' and creates a log file in SharePoint but skip the actual write. Use this option to make multiple ConvertTo-PnPPage invocations create a single log

EXAMPLE 12

ConvertTo-PnPPage -Identity "My post title" -BlogPage -LogType Console -Overwrite -TargetWebUrl "https://contoso.sharepoint.com/sites/targetmodernsite"

Converts a blog page with a title starting with 'my post title' to a client side page in the https://contoso.sharepoint.com/sites/targetmodernsite site

EXAMPLE 13

ConvertTo-PnPPage -Identity "My post title" -DelveBlogPage -LogType Console -Overwrite -TargetWebUrl "https://contoso.sharepoint.com/sites/targetmodernsite"

Converts a Delve blog page with a title starting with 'my post title' to a client side page in the https://contoso.sharepoint.com/sites/targetmodernsite site

EXAMPLE 14

ConvertTo-PnPPage -Identity "somepage.aspx" -PublishingPage -Overwrite -TargetConnection $target -UserMappingFile c:\\temp\user_mapping_file.csv

Converts a publishing page named 'somepage' to a client side page in the site specified by the TargetConnection connection. This allows to read a page in on-premises environment and create in another online locations including using specific user mappings between the two environments.

PARAMETERS

-AddPageAcceptBanner

Adds the page accept banner web part. The actual web part is specified in webpartmapping.xml file

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-AddTableListImageAsImageWebPart

When an image lives inside a table/list then it's also created as separate image web part underneath that table/list by default. Use this switch set to $false to change that

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-BlogPage

I'm transforming a blog page

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-ClearCache

Clears the cache. Can be needed if you've installed a new web part to the site and want to use that in a custom webpartmapping file. Restarting your PS session has the same effect

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-CopyPageMetadata

Copies the page metadata to the created modern page

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-DelveBlogPage

I'm transforming a Delve blog page

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-DelveKeepSubTitle

Transform the possible sub title as topic header on the modern page

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-DisablePageComments

Disable comments for the created modern page

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-DontPublish

Don't publish the created modern page

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-Folder

The folder to load the provided page from. If not provided all folders are searched

Type: String
Parameter Sets: (All)

Required: False
Position: 0
Accept pipeline input: True

-Identity

The name of the page to convert

Type: PagePipeBind
Parameter Sets: (All)

Required: True
Position: 0
Accept pipeline input: True

-KeepPageCreationModificationInformation

Keep the author, editor, created and modified information from the source page (when source page lives in SPO)

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-LDAPConnectionString

Specifies a LDAP connection string e.g. LDAP://OU=Users,DC=Contoso,DC=local

Type: String
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-Library

The name of the library containing the page. If SitePages then please omit this parameter

Type: String
Parameter Sets: (All)

Required: False
Position: 0
Accept pipeline input: True

-LogFolder

Folder in where the log file will be created (if LogType==File)

Type: String
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-LogSkipFlush

By default each cmdlet invocation will result in a log file, use the -SkipLogFlush to delay the log flushing. The first call without -SkipLogFlush will then write all log entries to a single log

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-LogType

Allows to generate a transformation log (File | SharePoint)

Type: PageTransformatorLogType
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-LogVerbose

Configure logging to include verbose log entries

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-Overwrite

Overwrites page if already existing

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-PageLayoutMapping

Path and name of the page layout mapping file driving the publishing page transformation

Type: String
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: True

-PostAsNews

Post the created, and published, modern page as news

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-PublishingPage

I'm transforming a publishing page

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-PublishingTargetPageName

Name for the target page (only applies to publishing page transformation)

Type: String
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-RemoveEmptySectionsAndColumns

Remove empty sections and columns after transformation of the page

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-ReplaceHomePageWithDefault

Replaces a home page with a default stock modern home page

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-SetAuthorInPageHeader

Set's the author of the source page as author in the modern page header (when source page lives in SPO)

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-SkipDefaultUrlRewriting

Set this flag to prevent the default URL rewriting while you still want to do URL rewriting using a custom URL mapping file

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-SkipHiddenWebParts

Set this flag to skip hidden webparts during transformation

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-SkipItemLevelPermissionCopyToClientSidePage

By default the item level permissions on a page are copied to the created client side page. Use this switch to prevent the copy

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-SkipTermStoreMapping

Disables term mapping during transformation

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-SkipUrlRewriting

If transforming cross site then by default urls in html and summarylinks are rewritten for the target site. Set this flag to prevent that

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-SkipUserMapping

Disables user mapping during transformation

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-SummaryLinksToHtml

By default summarylinks web parts are replaced by QuickLinks, but you can transform to plain html by setting this switch

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-TakeSourcePageName

Created client side page takes name from previous classic page. Classic page gets renamed to previous_<Page>.aspx

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-TargetConnection

Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.

Type: PnPConnection
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-TargetPageFolder

Folder to create the target page in (will be used in conjunction with auto-generated folders that ensure page name uniqueness)

Type: String
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-TargetPageFolderOverridesDefaultFolder

When setting a target page folder then the target page folder overrides possibly default folder path (e.g. in the source page lived in a folder) instead of being appended to it

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-TargetPageName

Name for the target page (only applies when doing cross site page transformation)

Type: String
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-TargetWebUrl

Url of the target web that will receive the modern page. Defaults to null which means in-place transformation

Type: String
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-TermMappingFile

Specifies a taxonomy term mapping file

Type: String
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-UrlMappingFile

File holding custom URL mapping definitions

Type: String
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-UseCommunityScriptEditor

Uses the community script editor (https://github.com/SharePoint/sp-dev-fx-webparts/tree/master/samples/react-script-editor) as replacement for the classic script editor web part

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-UserMappingFile

Specifies a user mapping file

Type: String
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-WebPartMappingFile

Path and name of the web part mapping file driving the transformation

Type: String
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: True

-Connection