Export-PnPClientSidePageMapping

Get's the built-in maping files or a custom mapping file for your publishing portal page layouts. These mapping files are used to tailor the page transformation experience.

Syntax

Export-PnPClientSidePageMapping
      [-BuiltInWebPartMapping [<SwitchParameter>]]
                                     [-BuiltInPageLayoutMapping [<SwitchParameter>]]
                                     [-CustomPageLayoutMapping [<SwitchParameter>]]
                                     [-PublishingPage <PagePipeBind>]
                                     [-AnalyzeOOBPageLayouts [<SwitchParameter>]]
                                     [-Folder <String>]
                                     [-Overwrite [<SwitchParameter>]]
                                     [-Logging [<SwitchParameter>]]
                                     [-Web <WebPipeBind>]
                                     [-Connection <PnPConnection>]

Examples

------------------EXAMPLE 1------------------

Export-PnPClientSidePageMapping -BuiltInPageLayoutMapping -CustomPageLayoutMapping -Folder c:\\temp -Overwrite

Exports the built in page layout mapping and analyzes the current site's page layouts and exports these to files in folder c:\temp

------------------EXAMPLE 2------------------

Export-PnPClientSidePageMapping -CustomPageLayoutMapping -PublishingPage mypage.aspx -Folder c:\\temp -Overwrite

Analyzes the page layout of page mypage.aspx and exports this to a file in folder c:\temp

------------------EXAMPLE 3------------------

Export-PnPClientSidePageMapping -BuiltInWebPartMapping -Folder c:\\temp -Overwrite

Exports the built in webpart mapping to a file in folder c:\temp. Use this a starting basis if you want to tailer the web part mapping behavior.

Parameters

-AnalyzeOOBPageLayouts

Set this flag if you also want to analyze the OOB page layouts...typically these are covered via the default mapping, but if you've updated these page layouts you might want to analyze them again

Type:SwitchParameter
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-BuiltInPageLayoutMapping

Exports the builtin pagelayout mapping file (only needed for publishing page transformation)

Type:SwitchParameter
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-BuiltInWebPartMapping

Exports the builtin web part mapping file

Type:SwitchParameter
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-Connection

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
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-CustomPageLayoutMapping

Analyzes the pagelayouts in the current publishing portal and exports them as a pagelayout mapping file

Type:SwitchParameter
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-Folder

The folder to created the mapping file(s) in

Type:String
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-Logging

Outputs analyser logging to the console

Type:SwitchParameter
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-Overwrite

Overwrites existing mapping files

Type:SwitchParameter
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-PublishingPage

The name of the publishing page to export a page layout mapping file for

Type:PagePipeBind
Position:0
Accept pipeline input:True
Accept wildcard characters:False
-Web

This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.

Type:WebPipeBind
Position:Named
Accept pipeline input:False
Accept wildcard characters:False