Microsoft 365 Community Transform SharePoint Add-in model solutions to modern development patterns, 30 Mar 2023

Previous Meeting

⏯

youtube image

►

From YouTube: Using PnP Libraries to simplify SharePoint solution design and implementation

Description

This module introduces you to the development of SharePoint Online modern solutions using the Microsoft 365 & Power Platform Community (aka PnP) libraries. In particular, you can learn how to use PnP Framework and PnP Core SDK on top of or instead of the Client Side Object Model (CSOM) for SharePoint Online.

This video is part of a series in a playlist about "Transform SharePoint Add-in model solutions to modern development pattern": https://www.youtube.com/playlist?list=PLR9nK3mnD-OXJLA29Q0Xk7psbAUqzQZwe

➡️ Next video on this series - https://www.youtube.com/watch?v=q-FolBYQDMM&list=PLR9nK3mnD-OXJLA29Q0Xk7psbAUqzQZwe&index=12
⬅️ Previous video on this series - https://www.youtube.com/watch?v=ipqQiJ_MbNM&list=PLR9nK3mnD-OXJLA29Q0Xk7psbAUqzQZwe&index=10

#Microsoft365 #AzureAD #MicrosoftGraph #PnP #SharePointOnline #CSOM

In this video, you will learn about

- Transforming your code from CSOM to PnP libraries
- Understanding how to use PnP Framework
- Understanding how to use PnP Core SDK
- Using PnP Framework and PnP Core SDK together

📖 All guidance content including code samples can be found here: https://aka.ms/[short-link-to-guidance-repo]

✨ Presenter
• Paolo Pialorsi (PiaSys.com)

📃 Agenda
0:00 Introduction
1:36 Understanding the PnP Libraries
4:10 Demo
6:14 Using PnP Framework
8:10 Using PnP Core SDK
13:13 Using PnP Framework and PnP Core SDK together

📝 Learn more
• YouTube playlist for this video series - https://www.youtube.com/playlist?list=PLR9nK3mnD-OXJLA29Q0Xk7psbAUqzQZwe
• PnP PowerShell - https://pnp.github.io/powershell/
• PnP Framework - https://github.com/pnp/pnpframework
• PnP Core SDK - https://pnp.github.io/pnpcore/
• Introducing the PnP provisioning engine - https://learn.microsoft.com/en-us/sharepoint/dev/solution-guidance/introducing-the-pnp-provisioning-engine

💡 Learn more about the Microsoft 365 & Power Platform community
• Microsoft 365 Unified Sample gallery - https://aka.ms/community/samples
• Microsoft 365 & Power Platform Community in YouTube - https://aka.ms/community/videos
• Microsoft 365 & Power Platform - http://aka.ms/community/home

Sharing is caring! You are awesome! 🧡

A

A

Client side of the model to the PMP libraries, to improve the quality of your life and of your development just to set the context. The client side of the model or season is the library provided by Microsoft to access from a client platform, a Target SharePoint environment. It used to be based, on.net framework only and to Target the SharePoint on premises and SharePoint online.

A

Nowadays, we still have an old season library for SharePoint on premises, which target.net framework only, and we also have a new one, which is now cross-platform, which supports.net standard 2.0, and.net, 5, 6 and 7, which Target SharePoint online. Only with the client side of the model of SharePoint. We have a library that somehow mimics the behavior of the server SharePoint object model of SharePoint, but consuming it from the client side.

A

Moreover, the season Library requires a good knowledge of SharePoint and how SharePoint works and article over in order to being able to properly use it to consume SharePoint content, and let me say that the season Library are deeply used in the classic SharePoint add-in model, but are not really good options.

A

If you want to create a modern Solution, that's why we are talking about a set of libraries provided by the Microsoft 55 and Power Platform Community, also known as PMP parallel practices Community for micro 65, and this group of libraries is made of PMP framework, which is again a library that targets multiple platforms, so close platform. You can develop using it in.net standard, 2.2 or net five, six or seven.

A

It targets SharePoint online only and it extends the season Library, providing a rich set of extension methods which will make your life easier in your development faster.

A

It also includes the PMP provisioning engine, which is a really famous engine that you can use to extract a template from a live site and reuse, the same template to create and provision many more sites. Based on that initial template, so really useful. Whenever you want to replicate the same information architecture across multiple site, Collections and our tenants and customers, then we also have the PMP core SDK, which still target.net standard, 2.0 and net five.

A

Six and seven it is still cross-platform then, and it is the SharePoint online only, but the main difference between PMP framework and PMP core SDK is that in PMP core SDK, we implemented a fully modern development approach based on dependence, injection asynchronous code development. Internally PMP core SDK relies on micrograph in order to have a graph first approach, meaning that whenever you will consume SharePoint or any other microsd5 workloads, we will give priority to micrograph and we will try to use Microsoft graph for you.

A

And if you are going to use something which is not yet available in Microsoft graph, we will fall back to the SharePoint rest apis. So it is fully disconnected from season and it relies only on rest and open authorization so fully modern, faster and better organized for modern solutions. So let me move to the demo environment and let me show you how to transition from the old season experience to PMP framework and PMP core SDK.

A

So here we have a classic solution built with the client-side object model of SharePoint. As you can see in the packages we have microsoft.sharepoint online dot season, as well as we use micro.identity.client to use the modern authentication with season. In fact, here we create a client context, object based on the URL of a Target site and on executing web requests. For that context, we get the access token from an acquired token.

A

Async function defined right here, which relies on msal and the public client application Builder to get an actual access token for the currently connected user. With an interactive login. As such, we can use season with modern authentication, but then once we have the context, we can easily play with the context and season to get the web object and the ID and the title of the web object. We can show them on the console.

A

We can get a list by title and the list will be the documents document library and we can show the information about the document Library as well as we can make a query for the top 10 items, so the top 10 documents in the Target document library and we can show all of them.

A

So if we execute these application just for the sake of it, we can see that in the console window we have the application running and we have to authenticate using the interactive, login and I will use this account, which is targeting my tenant. I will have to provide my credentials and once I've done, that I will see that I can get the list of items in the document library and that's it now.

A

Let's say that we want to do the same with the PMP framework Library, so that you can see how it is easier to do that using the PMP framework instead of using just native season and for the sake of completeness I've built another example which uses exactly the same core functionalities, but relying on PMP framework. So, first of all, instead of having to implement yourself the modern authentication logic, you can simply reference in the packages, the PMP framework package that one will include a reference to season when msil.

A

So here you simply need to use the authentication manager type provided by PMP framework to get a create with interactive login method, providing the client ID the tenant, ID enter and direct URL of the site or actually of the authentication. You will get back an authentication manager which will allow you to do the get context async, providing the URL of the site and getting back a client context of season.

A

So rather than having to implement all of the modern authentication logic, you simply rely on the authentication manager of PMP framework once you've done that you can still use season as like, as you are used to do. But, for example, here again you can play with the season Library using the extension methods provided by PMP framework. So, for example, here on the web, you can simply say get list by title and you will provide a title and you will specify the properties that you want to load.

A

So you have a shorter syntax and easier to write, syntax and the result will be still to get the document Library the end title with just one request. Then you can get all of the items and browse through all of them. If we execute these console application again. Just for the sake of completeness, you will see that you have again to authenticate using interactive login and so I will have to provide micro credentials, one more time and once I'm authenticated in the console application. I can see that I have the documents in the document.

A

Library simple, as that now, let's see that we want to make one more step and we want to use the PMP core SDK. So let me switch to another demo and this time I'm going to show you how you can Leverage The Modern development technique of PMP core SDK again in the dependencies in the packages you have to reference, the pmp.core.auth, which implicitly will also reference the pmp.core package and this statue will have both the authentication and the actual and realtnp core SDK.

A

Library I also have a reference here to the microsoft.extensions.hosting, because in the PMP core SDK, we created it with dependence injection in mind.

A

So here we configure a host and we create a default builder for the host and we configure the services that we will inject through dependency injection and specifically, we have these Services dot rpmp core, which is an extension method provided by the PMP core Library, which will register all of the services needed by PMP core SDK to properly do what you need to do, then we also configure the settings of PMP core SDK through a specific type, PMP core options, and we say that we want to read the settings from the default settings provider, which will be an app settings.json file in this solution.

A

As such, we have a PMP core section where we can Define the default authentication method which will be called interactive and which will use the interactive authentication mode and decide that we want to use. That will be just one called.

A

This is just an internal name for our own reference, so I have to work with, and this is the URL of the site that I'm going to consume so that once I have properly configured also the authentication part of PMP core and the settings of the authentication, we can simply say: okay, start asynchronously, the host and in the host we get a scope. So as such, we can then get a reference to this service that we need. Specifically, we get a reference to the ipmp context, Factory implementation.

A

This will be a service which will give us a PMP context, object, which is a new object, specific of PMP core SDK through which we can access a Target cycle action, a Target team and, generally speaking, our Target environment in instead, through the PMP context. Factory object instance that we get from the service provider. We can simply say, create a synchronously, a PMP context for what for the site that we called, we Define the site to work with meaning this one defined in our settings.

A

Once you have done that in this context, object you will have an instance of a PMP context. Type, as you can see right here and through the PMP context, you can leverage the fully asynchronous and modern development technique that we provide and you can, for example, asynchronously get the web associated with the current context and retrieve the title and all of the lists in that site and eventually also the master page URL. This is just for the sake of showing you that we can make multiple requests at once. Then we show that information.

A

We get the list of lists that we requested before so right here and we browse through all of the lists and eventually we can also play with the team settings associated with the team that is backing our SharePoint site, something completely new that you were not able to do with season or with the TMP framework library, and, for example, here we'll read in the team what these set fun settings are just to show if we allow gifi or not, but we can also play with language integrated query and we can make, for example, a query in the context.web dot lists.

A

This is a collection of lists. We can make a link query to get all of the list of type document library, and then we can browse the list and see the output so really modern, new and Powerful syntax available for you. Let me execute this sample as well. Just for the sake of completeness- and this is the console application again here- I have to authenticate interactively.

A

Like always, let me provide my credentials for this target tenant and now that I'm out indicated you can see here in the console that I can get the whole list of lists in my site, as well as I can get just those of type document Library, using the link query and under the cover in this demo, you can see also the requests that are made by the PMP core SDK. There could be graph requests or SharePoint the rest API request, depending on what you want to get back from your target environment.

A

Last but not least, I just want to show you that you can also use both PMP framework and PMP core SDK together it can switch from one to the other. So, for example, here we have as like, as before, the dependence injection and the host configured. We also have some settings for the PMP framework and here, for example, using PMP framework and using the authentication manner that we have just seen before in the previous demo.

A

We can get a season context, but if you need to transition from the PNP framework to the PMP core SDK using a specific type called pmpcor SDK dot instance and using the get PMP context method, you can transform the system context into a PMP context and from there you can start playing with PMP core SDK or the other way around. So if you have a PMP context of PMP core SDK and suddenly you need to switch to a PMP framework, a set of objects, including the system client context.

A

Well, you can still use PNP or sdk.instance dot, get client contacts from the PMP context, and you will get back a season kind context that you can use from their own, so you can use both of them in your Solutions. Depending on what you need to do here, you can find additional links if you want to dig into the topics that we covered in this video and like always, thank you for watching.