id
stringlengths
14
16
text
stringlengths
2
3.14k
source
stringlengths
45
175
5339a31f6590-4
ModernizationInfoPathScanResults.csv Full, InfoPathOnly One row per found InfoPath usage, explains the type of InfoPath usage. ModernizationBlogWebScanResults.csv Full, BlogOnly One row per found blog site containing last change information and blog site language. ModernizationBlogPageScanResults.cs...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-scanner-reports
4c4fd0c7cac8-0
Using the SharePoint Modernization scanner you can prepare your classic sites for modernization. The scanner will help you prepare for the following modernization efforts: Optimizing the usage of modern list and libraries Connecting these sites to a Microsoft 365 group Modernizing the wiki and web part pages by...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-scanner
4c4fd0c7cac8-1
Step 1: Get the latest version of the SharePoint modernization scanner Since SharePoint Online continuously evolves and more and more modern capabilities are added, it's important to always download the latest version of the scanner. Download the SharePoint Modernization Scanner executable and get started. This pag...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-scanner
4c4fd0c7cac8-2
If you want to report on site collections that have a Teams team linked then you also need to add the Group.Read.All permission (as of version 2.7). Once the preparation work is done, let's continue with doing a scan. Using Initialize-PnPPowerShellAuthentication to setup Azure AD App-Only To configure Azure A...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-scanner
4c4fd0c7cac8-3
Step 3: Launch a scan using the user interface option The easiest approach is to simply launch SharePoint.Modernization.Scanner.exe as the scanner does have a UI. Alternatively you can start a (PowerShell) command prompt and navigate to that folder so that you can use the scanner via command line. This chapter will w...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-scanner
4c4fd0c7cac8-4
Note You can also opt to install the certificate on your computer and reference it via the -w command line parameters. To reference the certificate you would use this value for the -w parameter "My|CurrentUser|1FG498B468AV3895E7659C8A6F098FB701C8CDB1". You can use My/Root and CurrentUser/LocalMachine to identify the ...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-scanner
4c4fd0c7cac8-5
Authenticate via credentials Using a regular user/password combo works fine as well, assuming the provided user does have the needed permissions. As of version 2.9 of the scanner the user/password based authentication does not rely anymore of legacy auth being enabled on the scanned tenant. The only reason why this...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-scanner
4c4fd0c7cac8-6
Scanning the complete tenant is often the recommended approach as that will give you modernization reports for all. If that's your choice, then simply fill your tenant name. This approach doesn't work if your tenant is using URLs that do not end on sharepoint.com , if that's the case you need to use one of the two bel...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-scanner
4c4fd0c7cac8-7
Select the option you want in the dropdown and then the checkboxes will show which components will be included in the scan. The "Microsoft 365 group connection readiness" component is the main component that will be included all scan modes. Page 4: Scanner options As a last step you can tweak the scanner options. D...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-scanner
4c4fd0c7cac8-8
Date format : the default date format in the generated CSV files is month/day/year. You can optionally switch this to day/month/year Step 3 (alternative option): Launch a scan using command line Below option is the default usage of the tool for most customers: you specify the mode, your tenant name, and the creat...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-scanner
4c4fd0c7cac8-9
ListOnly Includes a deep list scan + includes the Microsoft 365 group connection readiness component HomePageOnly Includes a scan from wiki and web part pages home pages + includes the Microsoft 365 group connection readiness component PageOnly Includes a scan from wiki and web part pages + includes t...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-scanner
4c4fd0c7cac8-10
See the sp-dev-modernization repo for more information at: https://github.com/SharePoint/sp-dev-modernization/tree/master/Tools/SharePoint.Modernization Let the tool figure out your urls (works only for SPO MT): ========================================================== Using Azure AD app-only: SharePoint.Modernizatio...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-scanner
4c4fd0c7cac8-11
Specifying url to your sites and tenant admin (needed for SPO with vanity urls): ================================================================================ Using Azure AD app-only: SharePoint.Modernization.Scanner.exe -r <wildcard urls> -a <tenant admin site> -i <your client id> -z <Azure AD domain> -f <PFX file...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-scanner
4c4fd0c7cac8-12
-i, --clientid Client ID of the app-only principal used to scan your site collections -s, --clientsecret Client Secret of the app-only principal used to scan your site collections -u, --user User id used to scan/enumerate your site coll...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-scanner
4c4fd0c7cac8-13
-v, --csvfile CSV file name (e.g. input.csv) which contains the list of site collection urls that you want to scan -h, --threads (Default: 10) Number of parallel threads, maximum = 100 -e, --separator ...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-scanner
4c4fd0c7cac8-14
-q, --dateformat (Default: M/d/yyyy) Date format to use for date export in the CSV files. Use M/d/yyyy or d/M/yyyy -w, --storedcertificate (Default: ) Path to stored certificate in the form of ...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-scanner
923e32e6baa8-0
Each source page that gets transformed does have a certain layout, typically one of the predefined layouts offered out-of-the-box by SharePoint. When a page is transformed to a modern page the modern page will take over the layout of the source page. The target modern pages do have different layout capabilities, hence ...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-layout
923e32e6baa8-1
3 column row 1 column row + 3 column row 1 column row + 3 column row + 1 column row Publishing page layout mapping As publishing pages do not have a fixed layout the default layout manager used by the publishing page transformator does work differently: it generates the needed rows and columns...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-layout
923e32e6baa8-2
public MyLayout(ClientSidePage page) { this.page = page; } public void Transform(PageLayout layout) { // custom layout transformation...add sections to the target page based upon the recieved page layout switch (layout) { case PageLayout.Wiki_OneColumn: case PageLayout.WebPart_F...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-layout
f4e425895e76-0
Term mapping is the mechanism that translates managed metadata terms in the source environment to an applicable term in the target environment. The cases in where term mapping applies are: You're transforming from on-premises SharePoint to SharePoint Online You're doing a cross site transformation (e.g. from clas...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-termmapping
f4e425895e76-1
SourceTermGroup|SourceTermSet|SourceTerm|SourceChildTerm1|SourceChildTerm2,TargetTermGroup|TargetTermSet|TargetTerm|TargetChildTerm1|TargetChildTerm2 f0b1b6aa-b00b-4198-b8dd-ef4393e3ad05,fec05391-6a39-4ad5-a2a1-a01020d94efd Some things to note: You can either choose a mapping based upon a path (a | delimited str...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-termmapping
87f50bb8de43-0
When you perform a cross site page transformation then by default URL mapping is used. Cross site page transformation is mandatory when you modernize your publishing pages as you always create the modern pages inside a modern (communication) site. When you do in-place team site modernization there's no reason to map UR...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-urlmapping
87f50bb8de43-1
/sites/portal -> /sites/hr /sites/portal/pages -> /sites/hr/sitepages http://contoso.com/sites/portal/hr -> https://contoso.sharepoint.com/sites/hr http://contoso.com/sites/portal/hr/pages -> https://contoso.sharepoint.com/sites/hr/sitepages /sites/portal/hr -> /sites/hr /sites/portal/hr/pages -> /sites/h...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-urlmapping
87f50bb8de43-2
Custom URL mapping is executed before the default URL mapping, which allows you to change the default URL mapping behavior by specifying a custom mapping for the default rewritten urls When you disable URL mapping you also disable custom URL mapping. If you only want to use your custom URL mapping then use the -Sk...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-urlmapping
694391aa8bcf-0
When you're transforming pages from your on-premises SharePoint you typically are using Active Directory accounts (e.g. CONTOSO\JOE) to grant access to SharePoint while in SharePoint Online you use Azure Active Directory accounts to grant access. User mapping is a component of page transformation that enables you to ma...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-usermapping
694391aa8bcf-1
Important Given the mapping depends on domain lookups it will only work if the machine/account running the page transformation are joined to the same Active Directory domain as the one holding the accounts/groups that are used to authorize access to the on-premises SharePoint environment. If you want to completel...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-usermapping
694391aa8bcf-2
You can map the system account via sharepoint\system Groups have to be specified via the group sid as source. Group targets can be specified by Azure AD group name but it's better to unique identify them via using the Azure AD group id like shown in c:0t.c|tenant|b0f984d9-e9d5-432a-bec9-896f910254ba Creating th...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-usermapping
00230b16933d-0
Summary The default page transformation configuration (webpartmapping.xml) uses built-in functions and selectors to drive the mapping from classic web parts to modern 1st party and 3rd party web parts. This page lists all the available functions. Note This page is auto-generated, if you see issues please create...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-api
00230b16933d-1
{UsePlaceHolders} Value true ReturnFalse Description: Simply returns the string false. Example: {UsePlaceHolders} = ReturnFalse() Output parameters Name Description {UsePlaceHolders} Value false ReturnServerRelativePath Description: Transforms the incoming path into a...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-api
00230b16933d-2
Name Description {String1} First string {String2} Second string Output parameters Name Description {CompleteString} Concatenation of the passed strings ConcatenateWithSemiColonDelimiter Description: Concatenates 2 strings with a semicolon in between. Exam...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-api
00230b16933d-3
Concatenation of the passed strings StaticString Description: Returns an the (static) string provided as input Example: StaticString('static string') Input parameters Name Description {'static string'} Static input string Output parameters Name Description ...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-api
00230b16933d-4
Name Description {HasScript} True is the html contains script, false otherwise ListCrossSiteCheck Description: Returns the cross site collection save list id. Example: {ListId} = ListCrossSiteCheck({ListId}) Input parameters Name Description {ListId} Guid of the list...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-api
00230b16933d-5
Output parameters Name Description {ListWebRelativeUrl} Web relative url of the list ListHideToolBar Description: Checks if an XSLTListView web part has a hidden toolbar. Example: {HideToolBar} = ListHideToolBar({XmlDefinition}) Input parameters Name Description ...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-api
00230b16933d-6
Id of the view to be used ImageLookup Description: Does lookup a file based on the given server relative path and return needed properties of the file. Returns null if file was not found. Example: ImageLookup({ServerRelativeFileName}) Input parameters Name Description {ServerRelativ...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-api
00230b16933d-7
Name Description {Anchor} Original anchor tag fetched from the source image {ImageUrl} Original image url {ServerRelativeFileName} New image url Output parameters Name Description {Anchor} The url after url rewrite. If the anchor and original image url were th...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-api
00230b16933d-8
Description {DocumentListId} Id of the list holding the file {DocumentUniqueId} UniqueId of the file {DocumentAuthor} User principal name of the document author {DocumentAuthorName} Name of the file author ContentEmbedCrossSiteCheck Description: Throws an exception when li...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-api
00230b16933d-9
Example: SiteDocumentsToHighlightedContentProperties() Output parameters Name Description {JsonProperties} Properties collection for the contentrollup (= Highlighted Content) web part {SearchablePlainTexts} SearchablePlainTexts nodes to be added in the serverProcessedContent node ...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-api
00230b16933d-10
{ImageSources} ImageSources nodes to be added in the serverProcessedContent node ContentByQueryToHighlightedContentProperties Description: Maps content by query web part data into a properties collection and supporting serverProcessedContent nodes for the content rollup (= Highlighted Content) web part E...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-api
00230b16933d-11
{FilterField3Value} {FilterOperator3} {SortBy} {SortByDirection} {GroupBy} {GroupByDirection} {ItemLimit} {DisplayColumns} {DataMappings} Output parameters Name Description {JsonProperties} Properties collection for the cont...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-api
00230b16933d-12
SummaryLinksToQuickLinksProperties Description: Maps summarylinks web part data into a properties collection and supporting serverProcessedContent nodes for the quicklinks web part Example: SummaryLinksToQuickLinksProperties({Text},{QuickLinksJsonProperties}) Input parameters Name Description ...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-api
00230b16933d-13
{PersonEmail} User's email {PersonUPN} UPN of the user {PersonRole} Role of the user {PersonDepartment} User's department {PersonPhone} Phone number of the user {PersonSip} SIP address of the user EmptyString Description: Returns an empty string Example: EmptyStr...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-api
00230b16933d-14
Static input string which will be used as prefix {PublishingPageContent} The actual publishing page HTML field content to prefix {'static boolean value'} Static bool ('true', 'false') to indicate if the prefixing still needs to happen when the {PublishingPageContent} field content is emty Output...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-api
00230b16933d-15
PrefixAndSuffix Description: Prefixes and suffixes the input text with another text. The applyIfContentIsEmpty parameter controls if the prefix/suffix also needs to happen when the actual content is empty Example: PrefixAndSuffix('&lt;H1&gt;Prefix some extra text&lt;/H1&gt;','&lt;H1&gt;Suffix some extra text&lt;...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-api
00230b16933d-16
Name Description {return value} Server relative image url ToImageAltText Description: Returns the image alternate text of a Publishing Image field value. Example: ToImageAltText({PublishingPageImage}) Input parameters Name Description {PublishingPageImage} Publishing...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-api
00230b16933d-17
{return value} Image caption ToPreviewImageUrl Description: Returns a page preview image url. Example: ToPreviewImageUrl({PreviewImage}) Input parameters Name Description {PreviewImage} A publishing image field value or a string containing a server relative image path Ou...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-api
00230b16933d-18
Description {Taxonomy Field} The taxonomy field to update {'term ids split by |'} List of term id's to set, multiple values can also be used when the taxonomy field is configured to accept multiple terms {'static boolean value'} Static bool ('true', 'false') to indicate if the default term v...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-api
00230b16933d-19
Guid of the list to use {ViewXml} Definition of the selected view Output values Name Description Library The list is a document library List The list is a document list Issue The list is an issue list TaskList The list is an task list DiscussionBoard ...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-api
00230b16933d-20
Name Description {ContentLink} Link value if set {Content} Content embedded inside the web part {FileContents} Text content of the file. Return empty string if file was not found {UseCommunityScriptEditor} The UseCommunityScriptEditor mapping property provided via the PageTransform...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-api
00230b16933d-21
Name Description {ListGuid} Guid of the list used by the CBQ web part {ListName} Name of the list used by the CBQ web part Output values Name Description Default Transform the list NoTransformation Don't transform the list SummaryLinkSelector Descrip...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-api
00230b16933d-22
Name Description UseCommunityScriptEditor Transform to the community script editor web part NoScriptEditor Don't transform as there's no script editor UserExistsSelector Description: Checks if the passed value is a user or not Example: UserExistsSelector({PersonEmail}) Input param...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-api
2a2c9e471116-0
Publishing pages are always based upon a page layout and a master page. Those two pages combined with fields containing data make up the page a user sees in the browser. When transforming publishing pages it's therefor mandatory to map the used page layouts into a publishing page transformation model. The publishing pa...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-model-publishing
2a2c9e471116-1
Using the Export-PnPPageMapping cmdlet you can: Export the built in mapping file ( -BuiltInPageLayoutMapping parameter): this file will be used for the out of the box page layouts. If you specify a custom mapping for an out of the box page layout in your own mapping file, than that mapping will take preference ...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-model-publishing
2a2c9e471116-2
# Analyze and export the page layout mapping files Export-PnPPageMapping -BuiltInPageLayoutMapping -CustomPageLayoutMapping -Folder c:\temp Using .Net In .Net you need to use the PageLayoutAnalyser class to analyze page layouts. Below two snippets show how to analyze either all page layouts or the page layouts u...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-model-publishing
2a2c9e471116-3
analyzer.GenerateMappingFile("c:\\temp", "custompagelayoutmapping.xml"); } The page layout mapping model explained When you open a page layout mapping file the following top level elements are present: AddOns : as user of page transformation you might have the needed to apply custom logic to realize your needs...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-model-publishing
2a2c9e471116-4
<Field Name="ArticleByLine" HeaderProperty="TopicHeader" Functions=""/> <Field Name="PublishingContact" HeaderProperty="Authors" Functions="ToAuthors({PublishingContact})"/> </Header> <MetaData ShowPageProperties="true" PagePropertiesRow="1" PagePropertiesColumn="4" PagePropertiesOrder="1"> ...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-model-publishing
2a2c9e471116-5
<WebPartZoneLayout> <WebPartOccurrence Type="Microsoft.SharePoint.WebPartPages.ContentEditorWebPart, Microsoft.SharePoint, Version=16.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c" Row="3" Column="2"/> <WebPartOccurrence Type="Microsoft.SharePoint.WebPartPages.ContentEditorWebPart, Mic...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-model-publishing
2a2c9e471116-6
</FixedWebParts> </PageLayout> Note It's recommended that you use the pagelayoutmapping.xsd schema while editing these files. To files you provide to page transformation will be validated against that schema and transformation will fail when the provided page layout mapping file is invalid. PageLayout ...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-model-publishing
2a2c9e471116-7
The following properties are used on the optional SectionEmphasis element: VerticalColumnEmphasis : use this property to set the vertical column emphasis to None, Neutral, Soft or Strong For each section you optionally can specify a section emphasis via the Section element: Row : indicates the row number of...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-model-publishing
2a2c9e471116-8
HeaderProperty : the name of the header property to set Functions : If set to empty then the field value from the classic publishing page is taken as is, however if you specify a function here then the output of that function is used. If you've specified multiple fields (so using the field override option), then you ...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-model-publishing
2a2c9e471116-9
<Header Type="FullWidthImage" Alignment="Left" ShowPublishedDate="true"> <!-- Note that static values do require specifying them between '' --> <Field Name="PublishingRollupImage" HeaderProperty="ImageServerRelativeUrl" Functions="StaticString('/sites/classicportal/images/myimage.jpg')" /> <Field Name="ArticleByL...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-model-publishing
2a2c9e471116-10
TargetFieldName : the name of the field in the target modern page Functions : If set to empty then the field value from the classic publishing page is taken as is, however if you specify a function here then the output of that function is used. If you've specified multiple fields (so using the field override option),...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-model-publishing
2a2c9e471116-11
Order : the order of the target web part in the defined row/column. Depending the chosen TargetWebPart you'll need to provide the web part properties holding the data needed during transformation. Each property has the following properties: Name : Name of the property. These property names need to match with pr...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-model-publishing
2a2c9e471116-12
<WebPartZoneLayout> <WebPartOccurrence Type="Microsoft.SharePoint.WebPartPages.ContentEditorWebPart, Microsoft.SharePoint, Version=16.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c" Row="3" Column="2"/> <WebPartOccurrence Type="Microsoft.SharePoint.WebPartPages.ContentEditorWebPart, Microsoft.SharePoint, V...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-model-publishing
2a2c9e471116-13
FixedWebParts element Sometimes page layouts contain "fixed" web parts, this are web parts which are hard coded inside the page layout and therefore these are present on all pages that use the page layout. As there's no API's to detect these "fixed" web parts they need to be defined as part of the page layout mapping...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-model-publishing
2a2c9e471116-14
Create your custom functions/selectors assembly To create your own functions you'll need to reference the SharePoint.Modernization.Framework assembly in your project and then create a class inheriting the SharePointPnP.Modernization.Framework.Functions.FunctionsBase class: using Microsoft.SharePoint.Client; using...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-model-publishing
2a2c9e471116-15
namespace Contoso.Modernization { public class MyCustomFunctions: FunctionsBase { public MyCustomFunctions(ClientContext clientContext) : base(clientContext) { } public string MyListAddServerRelativeUrl(Guid listId) { if (listId == Guid.Empty) { ...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-model-publishing
2a2c9e471116-16
} } Declare your custom assembly Before custom functions can be used they need to be declared in the model by adding one reference per library/class into the AddOns element: <AddOn Name="Custom" Type="Contoso.Modernization.MyCustomFunctions" Assembly="Contoso.Modernization.dll" /> or (note the fully qualified...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-model-publishing
2a2c9e471116-17
I want to promote the created pages as news Promoting pages created from a page layout as news pages can be be done by using the -PostAsNews parameter on the -KeepPageCreationModificationInformation cmdlet (when you're using the PnP PowerShell approach ) or alternatively by setting the PostAsNews parameter to ...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-model-publishing
2a2c9e471116-18
I want to prefix or suffix the content from field The approach used in the previous chapter allows you to add extra text on a page, but has as downside that the extra text will be added in it's own text part. If you want the extra text to be integrated with the actual text being transformed then the below approach al...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-model-publishing
2a2c9e471116-19
</Field> ... <Field Name="PublishingPageContent" TargetWebPart="SharePointPnP.Modernization.WikiTextPart" Row="1" Column="2"> <Property Name="Text" Type="string" Functions="Suffix('&lt;H1&gt;Suffix some extra text&lt;/H1&gt;',{PublishingPageContent},'false')" /> </Field> ... </WebParts> I want to populate ...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-model-publishing
2a2c9e471116-20
I want to add an extra web part on the created page When you transform you classic publishing page to a modern page you sometimes want to add an additional modern web part on the created page, without that there's a classic version of that web part on the classic publishing page. This can be done by adjusting your ...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-model-publishing
2a2c9e471116-21
<Mappings> <Mapping Default="true" Name="default"> <ClientSideWebPart Type="Custom" ControlId="157b22d0-8006-4ec7-bf4b-ed62383fea76" Order="10" JsonControlData="&#123;&quot;serverProcessedContent&quot;:&#123;&quot;htmlStrings&quot;:&#123;&#125;,&quot;searchablePlainTexts&quot;:&#123;&#125;,&quot;imageSources&...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-model-publishing
2a2c9e471116-22
The ControlId guid value is the value of the id json property Delete the following json properties from the copied snippet: id, instanceIf, title and description. At this point you have the following left: {"serverProcessedContent":{"htmlStrings":{},"searchablePlainTexts":{},"imageSources":{},"links":{}},"dataV...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-model-publishing
2a2c9e471116-23
If needed insert web part parameters in this string (e.g. {HelloWorld} in above sample): &#123;&quot;serverProcessedContent&quot;:&#123;&quot;htmlStrings&quot;:&#123;&#125;,&quot;searchablePlainTexts&quot;:&#123;&#125;,&quot;imageSources&quot;:&#123;&#125;,&quot;links&quot;:&#123;&#125;&#125;,&quot;dataVersion&quot;:&...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-model-publishing
2a2c9e471116-24
The default behavior of page transformation is simply take over the add-in part on the modern page as add-in's do work on modern pages. If you however want to selectively transform some add-in parts to custom SPFX based web parts, drop some of add-in parts and keep the remaining add-in parts then the default mapping wi...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-model-publishing
2a2c9e471116-25
<!-- We keep this web part --> <ClientSideWebPart Type="ClientWebPart" Order="10" JsonControlData="{}"/> </Mapping> <Mapping Name="News Ticker" Default="false"> <!--This web part will be transformed to a custom SPFX based web part --> <ClientSideWebPart Type="Custom" ControlId="157b22d0-8006-4...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-model-publishing
2a2c9e471116-26
<WebPart Type="Microsoft.SharePoint.WebPartPages.ClientWebPart, Microsoft.SharePoint, Version=16.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c" CrossSiteTransformationSupported="true"> <!-- Note: the add-in can depend on assets that live in the source site, which is not something we can detect --> <Proper...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-model-publishing
2a2c9e471116-27
<!-- When you do have a hard coded preview image already available on the target site. Note that the source field name (PublishingContactEmail in below sample) must exist, although it's not used here --> <Field Name="PublishingContactEmail" TargetFieldName="BannerImageUrl" Functions="StaticString('https://contoso.shar...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-model-publishing
2a2c9e471116-28
<!-- When you want to refer a static image living in the source site --> <Field Name="PreviewImage" TargetFieldName="BannerImageUrl" Functions="ToPreviewImageUrl('/sites/classicportal/images/myimage.jpg')" /> I want to use different defaults for the QuickLinks web part When transformation results in a modern Quic...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-model-publishing
2a2c9e471116-29
<Property Name="Title" Type="string" Functions="EmptyString()"/> <Property Name="QuickLinksJsonProperties" Type="string" Functions="StaticString('{&quot;isMigrated&quot;: false, &quot;layoutId&quot;: &quot;Button&quot;, &quot;shouldShowThumbnail&quot;: true, &quot;buttonLayoutOptions&quot;: { &quot;showDescription&...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-model-publishing
020b5ac6758a-0
The heart of the page transformation solution is the model that feeds the transformation: the model tells the engine which web part properties are important, allows you to manipulate these properties and dynamically choose a mapping for your web part. The page transformation model is expressed in XML and comes with a s...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-model
020b5ac6758a-1
The information retrieved from the analysis in step 2 is often not sufficient to map the web part to a modern equivalent and therefor in step 3 we'll enhance the information by calling functions: these functions take properties retrieved in step 2 and generate new properties based upon the inputted properties from step...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-model
020b5ac6758a-2
WebParts : this element contains information for each web part that you want to transform. For each web part you'll find a definition of the properties to use, the functions to execute on those properties, the possible mappings that define the target of the transformation combined with a selector that you dynamically s...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-model
020b5ac6758a-3
<Mapping Name="List" Default="true"> <ClientSideText Text="You can map a source web part ({Title}) to a combination of modern web parts :-)" Order="10" /> <ClientSideWebPart Type="List" Order="20" JsonControlData="&#123;&quot;serverProcessedContent&quot;&#58;&#123;&quot;htmlStrings&quot;&#58;&#1...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-model
020b5ac6758a-4
</Mapping> <Mapping Name="Library" Default="false"> <ClientSideWebPart Type="List" Order="10" JsonControlData="&#123;&quot;serverProcessedContent&quot;&#58;&#123;&quot;htmlStrings&quot;&#58;&#123;&#125;,&quot;searchablePlainTexts&quot;&#58;&#123;&#125;,&quot;imageSources&quot;&#58;&#123;&#125;,&qu...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-model
020b5ac6758a-5
A function can have one or more input values which can be: Properties defined on this web part (e.g. {ListId}) Properties defined on the base web part (e.g. {Title}) Properties that were the output of previous function executions (e.g. {ListWebRelativeUrl}) Default site scoped properties: {Host}, {Web}, {Site...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-model
020b5ac6758a-6
Mappings element This element defines one or more possible target configurations for the given source web part. Since you can define multiple targets there needs to be a mechanism to determine which mapping to use: If the mapping element contains a filled Selector attribute then the output of the selector executi...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-model
020b5ac6758a-7
<ClientSideWebPart Type="List" Order="20" JsonControlData="&#123;&quot;serverProcessedContent&quot;&#58;&#123;&quot;htmlStrings&quot;&#58;&#123;&#125;,&quot;searchablePlainTexts&quot;&#58;&#123;&#125;,&quot;imageSources&quot;&#58;&#123;&#125;,&quot;links&quot;&#58;&#123;&#125;&#125;,&quot;dataVersion&quot;&#58;&quot;1....
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-model
020b5ac6758a-8
AddOns definition in the page transformation model Add-ons allow you to insert your custom logic into the mapping model by following these 2 steps: Create a custom assembly hosting your custom functions/selectors Declare this custom assembly in the AddOns elements Create your custom functions/selectors asse...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-model
020b5ac6758a-9
namespace Contoso.Modernization { public class MyCustomFunctions: FunctionsBase { public MyCustomFunctions(ClientContext clientContext) : base(clientContext) { } public string MyListAddServerRelativeUrl(Guid listId) { if (listId == Guid.Empty) { ...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-model
fe648a5fac23-0
Important SharePoint PnP Modernization is part of the PnP Framework and is continuously evolving, checkout the release notes to stay up to date on the latest changes. If you encounter problems please file an issue in the PnP Framework GitHub issue list . Before an existing wiki or web part page can be transf...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-security
d4c468a56075-0
When you use page transformation then you can either do an in-place transformation or a cross-site page transformation. Depending on the type of page you're transforming the only option is cross-site page transformation, but there are situations where you choose. In-place transformation During an in-place transform...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-approach
d4c468a56075-1
In-place transformation versus cross-site transformation Below table provides an overview on whether you need to use in-place transformation, cross-site transformation or whether you can choose. Source\Type Wiki page Web part page Publishing page Blog page SharePoint Online In-place (prefe...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-approach
af5159c2769b-0
Important SharePoint PnP Modernization is part of the PnP Framework and is continuously evolving, checkout the release notes to stay up to date on the latest changes. If you encounter problems please file an issue in the PnP Framework GitHub issue list . When a page is transformed from a classic page into a ...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-webparts
af5159c2769b-1
News web part This web part typically is used to show news on a home page, hence it's replaced with the OOB news web part Yes Microsoft.SharePoint.WebPartPages.ContentEditorWebPart (embedding content) Embed web part, Text web part and/or a community open source script editor as optional target web part ...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-webparts
af5159c2769b-2
Highlighted content web part No Microsoft.SharePoint.Publishing.WebControls.ResultScriptWebPart (searching data and presenting it) Highlighted content web part No Microsoft.Office.Excel.WebUI.ExcelWebRenderer (embedding from Excel files) File viewer web part No Microsoft.Office.Visi...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-webparts
af5159c2769b-3
People web part Yes Microsoft.SharePoint.WebPartPages.UserDocsWebPart (user documents) Highlighted content web part Yes Microsoft.SharePoint.WebPartPages.XmlWebPart (using xml and xsl to produce html) Removed ( Text web part added to explain why) Yes Microsoft.SharePoint.WebPartPage...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-webparts
af5159c2769b-4
Removed Sandboxed web parts are not possible anymore in SPO Yes Microsoft.SharePoint.Publishing.WebControls.TableOfContentsWebPart Removed This data should be integrated into the site navigation if still relevant Yes Note All other web parts not listed in the above table will get a "default"...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-webparts
af5159c2769b-5
Set the UseCommunityScriptEditor mapping flag You need to tell the page transformation engine you've installed the community script editor and that you want to use it during transformation. When using the ConvertTo-PnPPage PnP PowerShell cmdlet you can specify the -UseCommunityScriptEditor flag. When you're usi...
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-webparts
af5159c2769b-6
pti.MappingProperties["UseCommunityScriptEditor"] = "true";
https://learn.microsoft.com/en-us/sharepoint/dev/transform/modernize-userinterface-site-pages-webparts