Microsoft 365 Community PnP CSOM Core Component Training, 29 Aug 2016

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: PnP Core Component - Remote Timer Job Framework

Description

This is one of the modules targeted on the PnP CSOM Core component, which is community driven extension for SharePoint CSOM APIs. This component increases the productivity of the developers, by simplifying typical operations. PnP Core CSOM component is available as NuGet package (http://nuget.org/profiles/officedevpnp) and development happens in GitHub (https://github.com/OfficeDev/PnP-sites-core) together with the community.

- PnP Core Component - Introduction - https://www.youtube.com/watch?v=RDd2q7Ze9ME
- PnP Core Component - Basic Operations - https://www.youtube.com/watch?v=W-HzEnjDZwU
- PnP Core Component - Site Provisioning Framework - https://www.youtube.com/watch?v=N5y5qHqwYj4
- PnP Core Component - Remote Timer Job Framework - https://www.youtube.com/watch?v=nzL6jCv0dKQ
- PnP Core Component - PnP PowerShell for scripting with Core component - https://www.youtube.com/watch?v=Hi1QxfQ4ZfQ
- PnP Core Component - How to contribute to the PnP initiative - https://www.youtube.com/watch?v=ELeGFILRFfQ

A

Hello, welcome to office developer patterns and practices, core training, my name is Anton. Miss lavish I am a senior consultant working for Microsoft consulting services and in this module we will talk about remote time a job framework, as you are going through this course I. Believe you already know what of his death PNP is, and why should you care so I will not spend much time on introductions, and here is our plan for this module. We first briefly discuss time jobs and remote operations in SharePoint.

A

Then we look at how PNP coal library can help you implementing your custom diamond jobs. And finally, we talked a bit about Microsoft Azure and why it is good to deploy your timely jobs to Azure platform. With this, let's get started.

A

First, let's do a quick recap on timely jobs and remote operations in SharePoint time a jobs are remote, a synchronous long-running operations in SharePoint. There is a number of out-of-the-box timing, jobs which you can monitor and manage by going into SharePoint central administration portal. It is also possible to develop your own custom Tammy jobs. In order to do this, you need to create a class that inherits from SP job definition, provide your custom implementation and deploy it as a full trust code DLL on sharpen servers.

A

As a result, your time, your job will be available on the single list without of the box, once many of our customers have developed their own custom Tammy jobs. This way- and this is why, when I have discussions on migrating existing customizations from full trust code to cloud add-in model, usually customers are asking ok Anton, but what shall we do with our custom? Tammy jobs? These are deployed as full trust code solutions, and there is no way to implement time jobs. We are clouded in model.

A

I recommend them to take a look at remote image or pattern from office. Def PNP here is how it works. You have a SharePoint environment where all your site's data and functionality is hosted. Then you have a remote environment to run, provide a hosted, apps remote imager is a component that is deployed on external environment. It runs on some schedule, connects the sharepoint via client, set object model and performs needed operations.

A

This way the next question I usually get is ok, it looks interesting, but what is the key differences of this approach from regular timer jobs? Let's take a look here is what regular timer job gives you. First, it has scope that defines what sites to run the timer job against. Then it has a schedule that defines when to run it next, it has a host that defines on which machines in the farm willya code run. Finally, there is authentication that defines what are the credentials with which the code is executed.

A

Let's take a closer look at this four aspects. Here we have a comparison table, timer jobs, remote timer jobs and for aspects we've introduced before scope, schedule, host and authentication. Now, let's go through them one by one and see what are the differences scope, regular timer jobs can be scoped to specific web application or the entire farm remote timer jobs can be targeted to specific site collections. You can also use wildcards to include all site collections that match specific naming pattern.

A

I will show you this later in a demo schedule for regular timer job schedules configure to a central administration, full remote timer job scheduling can be done using any mechanism on hosting environment, for example, you can use as your web jobs or regular windows. Scheduler host, regular timey jobs run on servers in SharePoint farm remote timer jobs can be executed on any remote environment as either a Windows server and finally authentication regular timer jobs run with credentials of the farm account.

A

You can obviously also do impersonation in the code if needed, for remote, timer jobs, you can create specific service and run the code with credentials of this account or you can use upon later oaken's. We will look into both of these options later in more detail. As you can see, remote timer jobs give you even more options, comparing two regular timer jobs, and this is why our customers are successfully using them to implement various business scenarios. Good examples here are governance, related tasks, some regular maintenance tasks or implementing fallback for remote event receivers.

A

As you perhaps already know, for remote event receivers. We do not have guaranteed delivery. This means that if some event occurs, SharePoint sends a call to your remote web service and if the service cannot be reached, serpent will not try to resend this call later. This is why you need to implement the fallback logic, and this is where remote timer jobs can help. The final concern you might have is performance. I get asked this a lot as well.

A

If the code runs outside of SharePoint, does this mean that performance of remote timer jobs is lower, comparing to regular timing jobs? This is correct, but I would add few more considerations to this. First, there are already hundreds of native timey jobs running on sharpen servers. This means that your timer job has to compete for resources with other native and custom time, jobs and I've seen customers spending a lot of time adjusting schedules in order to avoid conflicts among timer jobs.

A

The second thing is that, for me, performance and scalability usually come hand-in-hand. If you are concerned about performance, you should be concerned about scalability as well. What happens when your timer job needs more hardware resources? The problem with regular timer jobs is that, if you want to scale out, you have to add additional SharePoint Server to the farm with remote timer jobs. You don't have these two issues, your timing, job runs on dedicated hardware, so it is not competing with anyone and scaling should not be a problem as well.

A

You can use built-in as your abilities or if you run your code on premises, you just need to add another Windows server. This is much easier. Finally, time jobs by definition are long-running and a synchronous, so slight drop in performance because of remote execution model should not be an issue.

A

Now, let's see how PNP Cole library can help you to implement remote timer jobs. This is how the process looks. Like you, create new visual studio project, add nougat package for PMP call component. Then you create a new class inheriting from time a job base class, and you write your custom code here after this, you need to configure authentication, create a service account or register the app and grant upon the permissions.

A

Then you specify the list of site collections on which the timer job should be executed and, finally, you deploy and run the timer job. Let me show you this process in a simple demo: here we are in visual studio, environment and I'll go and create a new project. Let's select console application and type a name, hello, world time, job.

A

The first thing we should do is adding a reference to his death PMP no get package, let's go to and references search for of his def P and P.

A

And here you have two versions: one for on-premises and one for sharepoint online. Let's pick the one for sharepoint online.

A

That's accept license agreements, and now you can see that the package is installed and in references all new references to a micro, serpent client until his death PMP corps are successfully added the next thing. What we need to do is add a new class that will implement our time job, add new class. Let's call it hello world time, a job ad.

A

We first need to make it public and then we need to hear it from time job class. Let's resolve naming here ad using statement now, let's add a default constructor hello, world time, a job constructor that uses base constructor and specifies the name of the time job.

A

And here specify the method that provides actual implementation of the timer job or the time your job will be doing. Let's implement the method, we don't do anything complicated here. We just connect to the web object, get a title and write it out. We write URL and title of the web. Let's add using statements off is def PMP, obviously, and another thing what we need to use is microsoft, servant client for sure.

A

Let's try to build a solution it built successfully and now let's go back to program CS and in program CS. First, let's add a helper method that will help us to generate secure password.

A

And now, in the main method, first, let's type out the message that the application is running and that the application is done and finally, let's instantiate our timer job hello world time. Job job is new, hello, hello, let's add authentication. We will use office. 365 authentication for this sample and I will be using my development.

A

And now, let's add a scope, so on which side will this time a job run at site and for the outside method? For this demo, I have created a bunch of sites already here they are. The URL is like this and on some deaf sharpen that come sides deaf, and we also have deaf one dev, 2 and F 3, and on the left side we also have some sub sites. Let me go back to visual studio and just paste in this URL. Here it is and then what we need to do.

A

We just need to say job run and let's execute the code.

A

You can see the time a job was executed. We were able to connect to the site, and here is the name, the title of the web. Now, let's try using wildcards if I add a star here. This will mean that now the timer job will run on all site collections where URL matches this pattern. Let's execute the code and, as you can see here are all site collections, dev, dev 3. Therefore just there for the 5 and f1, you can see that these are not in alphabetical order.

A

This happens because by default time a job is executed in multi-threaded fashion. Here.

A

You may set a parameter use threading to false, and in this case the entire job will be executed in a single thread. If you want to run multi-threaded, you can also set a value for parameter maximum threats, and this is how you may define how many parallel threads do you want to have let's rerun the code without multi-threading, and you should see that the sites are now being processed in alphabetical order, and also you may see that execution now takes longer because we're doing it in a single thread.

A

The last thing I want to show you is expand. Sub-Sites property by default is false, but if you set it to true, the timer job will run not only on site collections but on every sub site inside site collection. Let's rerun the code, and what we see here is that for dev site collection, we have sub sites web 1 web to web 3, and all of these now have been processed by our time. Job.

A

As you could also see from the demo, here are some benefits. What you get from PMP time. Job framework authentication is easily configurable. You can dynamically specify the list of site collections to be processed. The time job runs on site collection level. You can optionally run it on every sub site as well. We have a built-in configurable multi-threaded execution model. We also have a state management.

A

This means that the timer job can store additional information in property bags of site collections, so when it process a specific site collection, it knows when was the last time when this site collection was processed and what was the execution result? Development experience is pretty easy and we also have built-in logging capabilities. Let's take a closer look at our sent occation with remote timer jobs. You have two options using specific accounts or upon lis tokens. Using specific accounts is similar to classic service account model in on-premises.

A

You have to create a new account, configure required permissions and then remote timer job uses login and password of this account access, SharePoint environment. With upon lis tokens, you need to register app ID and secret for remote I'm, a job application grant permissions to this app. This can be done on the entire tenant or specific site collections. Then you usually put app ID and secret in app config and remote timer job uses these to access SharePoint environment.

A

Please note that not all functionalities work with upon lis tokens, so you might need to use specific accounts for some operations. World cars inside URLs is one example here and I'll talk about this in the next slide. Let's take a closer look at dynamic scopes. The framework allows you to add site URLs to timely jobs dynamically. You can also remove URLs that have already been added and, as you have seen from the demo, you can also use expand, sub sites property to process, not only site collections but all sub webs.

A

Finally, you can use wildcards in site URLs, as in this example, the timey job will process all site collections under sites managed paths. Please note that this does not work with upon the authentication. So if your time a job uses upon layer, authentication, you have to provide so-called enumeration account, what will be used to find all matching sites? I will show you this in the next demo time for a demo. Let me show you a good example of a real remote time.

A

Job for this demo, I will be using code time, a jobs, sample solution from office def PNP. Here we have many samples of time jobs and the one I will be showing you here is sample 5 governance job. What this job does, let's jump straight to the code and take a look at implementation.

A

Basically, we get the list of administrators for specific web and then, if there are less than two administrators we mark this site as in compliant and we add a GS link, so visitor of the site will see a notification bar showing that the site is non complying and then potentially it may have, for example, link to instructions on how to fix that. What is interesting about this sample also is that we are using state management for time job.

A

We set a managed state property to true and, as a result of this, when the time job is executed, we store JSON, serialize state information in a web property. The name is time, a job name underscore properties and the information we store there, for example, is last run date time a job version which was it and if execution was successful or not. In addition, I've also created few sites on which we can test this time. Job here is the URL gov test graph test, 1 and graph test 2.

A

Let me copy this URL for graph test 2 and let's jump to visual studio. Here is the project, and here is the implementation of our time, a job. So basically the same code I was showing you in a web browser and interesting that these get administrators, for example, is of his death being peak or extension method.

A

So you can see that we are using this extension methods in our code. Extensively at GS link is extension method as well. Here is the JavaScript file, which contains all logic for the notification bar what users will see. We actually upload this JavaScript file into the style library.

A

Now what we should do so first I've copied the URL of the site. Let's go back to problems here and paste the here, so this is all familiar stuff. We already. We create a new instance of site governance job. Then we use up only authentication, and for this we need to provide client, ID and client secret. We will do it right now and then, in order to use wildcards, we need to set credentials for enumeration account setting operation credentials.

A

For this we need to have username and passwords, because otherwise we cannot use wildcards here in site URLs.

A

Now what we need to do. We need to register our application, so it has permissions on the side. Let's go back to internet explorer and what I will do first, I'll go to.

A

Layouts 15 up reg new.

A

I'll generate new client, ID and new client secret. The name of the timer job will be governance, timer job, let's put some URL and some redirect URL. Let's click create, and now here is the information here. We have client, ID and client secret I'll copy this. Now, let's go back to visual studio and in visual studio we need to go to app config.

A

Here you see we have username and password for enumeration account already, and here we will put our client, ID and secret. This is our client ID. This is our secret.

A

And finally, what we need to do, we need to grant these app permissions on our SharePoint environment. Let me go back to internet browser and here I'll go to.

A

A

I'll paste application, ID press lookup: this is our application and what I'll do I'll put XML here that grants these up permissions to run with up only and also I'll grant permissions to the entire tenant, and this will be full control permissions. So this app will have permissions to access all site collections inside the tenant.

A

I'll trust this application, and now the application is registered. So as we are in graph test site, let's go to site collection administrators. We can see that here we have only one administrator, so this site is not compliant. Let's go back to visual studio and let's run the code.

A

You could see that this site is not compliant. We can go back here and if we go to the Welcome page of our site, we should see this information bar your site is not following company policies. Two or more administrators are needed. Click here to learn more I'll, go back to site settings and I'll, go to site collection, administrators and add additional administrator here.

A

So now we have two administrators, and this means that the next time, when the time a job will run, let me start it with control of five. So the window is not closed.

A

We will see that our site now is compliant, and what this means is that when we go back to the site and I press refresh, this notification bar is not here now, because the site has two administrators: let's go back to visual studio and here what I will do I will replace these two with a wild card. So, as a result of this this time, a job will now process not only one site collection but all three site collections. What we have control f5 again.

A

And now you can see that our graph test two side is compliant. It has two administrators, but other two sites are marked as in compliant, because only one administrator is there.

A

Now, let's talk a bit about Microsoft Azure, there are several options: how you can host your remote timer jobs for SharePoint on-premises. You can just deploy executable file and use built-in windows scheduler to run it on a regular basis, or you can build your own Windows service that stymie jobs for sharepoint online. You can use web jobs in Azure website or you can use any of the on premises. Options. Let me show you how to deploy a remote time job azure.

A

We are back in a visual studio environment and now, let's publish our governance job to Asia. To do this, I right-click on the project and select, publish as Asia web job, then I need to provide the name of the job and then I can select how the job should run, should I run continuously or on specific schedule or on demand for this demo, I'll select continuously for real production deployments. You usually want to specify a schedule how you want your job to run and now I click OK.

A

Now, let's select a target where the web job will be published. I select, Microsoft, Azure web application.

A

New web application- let's use the same name, create new up service plan, create new resource group and, let's host it in north Europe, create.

A

Now I click publish and we can see that web app was published successfully to this URL. Now, let's go into the web browser here we are in Microsoft Azure management portal. Let's refresh this view, and we should see new web application available here. It is as I open it up and in settings. If we scroll down.

A

We see web jobs, let's open it up.

A

We see our web job deployed. It's executed continuously and here is a link to see logs.

A

And now you can see that our timer job is not working, because it cannot load some assemblies. What we need to do. We need to go back to visual studio and now in Visual Studio. We need to make sure that all refer to, as implies I, actually copied locally. So let me select this nice copy local. Let's set it to true and Microsoft SharePoint client. Our supplies are already set to true office, def PMP core as well. Now, let's republish the project.

A

It was published successfully, let's go back to the web browser and refresh the log. Now you can see that our timer job is running, and here is the log with similar output. What we've seen in a console window so graft s2, is compliant go test. One marked as in compliant in gov test is Marcos in compliant. Here are our sites gov test? Let's refresh it, you can see that notification bar is here.

A

We are not following company policies to a mode ministry: tour, son, Edith: let's go to site settings, site collection, administrators, that's add second administrator here now: let's do the same for gov, test one site, site, settings, site collection, administrators and, let's add another administrator here now all our sites should be fixed.

A

Let's go back to the log of our web job, let's refresh the log, and now you can see our timely job was executed once again and now all of our sites are compliant and if I go back to the home page of each side, I should not see this notification bar anymore. This is true for this side.

A

Gov test one. It's true for this site as well and gap test two was compliant as you could see from the demo deploying remote time. Jobs to edger is really straightforward. Now one final topic I would want to discuss. You can actually use the same remote image or pattern for a synchronous tasks. This would allow you to ensure that UI is responsive and fast and long-running operations are not affected by web request timeouts. It is really easy to implement this in Azure, using storage queues and web jobs. Let's take a look at how this works.

A

You have SharePoint provide a hosted app, which is a web application, storage queue and web job user clicks on a link in SharePoint site and is redirected to a web page in a provider hosted app. Then he fills in some form and clicks submit button.

A

The web page puts a message in the storage queue and immediately returns response to end-user saying that the request is being processed, so we will not get a timeout here. Then a web job picks a message from the queue and performs needed actions. Good real-life example of such solution is site provisioning. You request new site fill in required metadata and then the site is being created. Creating the site potentially can take some time, so it is wise doing it as synchronously and not in a web request.

A

Threat here are some links to additional resources on office, def PMP time job framework I encourage you to go and look through this after completing this module.

A

With this hope, you are now ready to build your own remote, timer jobs. Let's keep in touch, we have a rise of his def PMP communication channels and thank you very much for your time.