Notes on Event Handlers in SharePoint Add-Ins

In SharePoint 2010 world, most of the custom SharePoint application used EventReceiver. This guy played a vital role during that timeframe. EventReceiver is very simple. You can consider this as based on your trigger event, what action you want to execute – this could be a validation, schema change, item entry, workflow initiation, or even communicate with other application.

In respect to SharePoint Online, we call this as RemoteEventReceiver(RER). Same utilization through different channel. SharePoint Online utilize different DLLs, interface, and the implementation through add-ins.

In this post, I walk through some notes about RemoteEventReceiver(RER).

Provider-hosted Add-ins

Custom code can handle three categories of events in provider-hosted add-ins:

·       List events, such as the adding or deleting of a list on a website.

·       List item events, such as the editing of an item in a list.

·       Add-in events, such as the installation of an add-in.

SharePoint-hosted SharePoint Add-ins do not support event handling, but you can turn a workflow into a kind of list or list item event handler by setting an event to trigger the workflow.

Workflows cannot be triggered by add-in events, so add-in events cannot be handled with a SharePoint-hosted add-in.

Website events and site collection events are not supported in SharePoint Add-ins.


An RER must be a SOAP web service. A web service is added to the web application to handle the remote event that you specified. A remote event receiver is added to the SharePoint Add-in, and the list item event is referenced in the receiver's Elements.xml file that is itself contained in the add-in web feature.

Following two are major DLLs used for RER

  • Microsoft.SharePoint.Client;
  • Microsoft.SharePoint.Client.EventReceivers;

Name of the interface of Remote Event Receiver >> IremoteEventService

Following are two different types of method implemented through RER.

ProcessEvent(SPRemoteEventProperties properties) - // When a "before" event occurs (such as ItemAdding)

ProcessOneWayEvent(SPRemoteEventProperties properties) - // When an "after" event occurs (such as ItemAdded)


Now, how do you debug remote event receiver in a SharePoint Add-in? -  This requires some Azure configuration. Remember, this is onetime configuration only and you do not have to repeat the Azure configuration for every project that has an RER or add-in event. In your visual studio project, you need to select the check box for Enable debugging via Microsoft Azure Service Bus.

A web service is added to the web application to handle the remote event that you specified. A remote event receiver is added to the SharePoint Add-in. The receiver references the web service and the list item event in the event receiver's Elements.xml file.

Common Error Message

"The remote event receiver callout failed. Details: There was no endpoint listening at https://<yourdomain>:PORTNO/<path>/AppEventReceiver.svc that could accept the message." – Root cause of this error is an incorrect address or SOAP action.

SharePoint requires that there be no explicit port in the URL of the handler in production. This means that you must use either port 443 for HTTPS, which we recommend, or port 80 for HTTP.

 And there are many more....Happy learning!

Comments

Post a Comment

Popular posts from this blog

How to fix Azure DevOps error MSB4126

Image
Setting up build and release pipeline always tedious and we face many build related issues. Here is one common error I face couple of times while setting app Web or windows apps in Azure DevOps After placing the code in repos, and creating the build pipeline and run it, you can face the following error ##[error]D:\a\8\s\<your solution file>.sln.metaproj(0,0): Error MSB4126: The specified solution configuration "release|$(BuildPlatform)" is invalid. Please specify a valid solution configuration using the Configuration and Platform properties (e.g. MSBuild.exe Solution.sln /p:Configuration=Debug /p:Platform="Any CPU") or leave those properties blank to use the default solution configuration. To understand what is target platform defined in your project you need to visit or open the solution(.sln) file and review the following sections. In my case, this has been defined as x86 as target platform.         ...
Read more

How to create Custom Visuals in Power BI – Initial few Steps

Image
This post will help you to know the steps to create custom visuals in PowerBI. Microsoft defined them as well at https://docs.microsoft.com/en-us/power-bi/service-custom-visuals-getting-started-with-developer-tools . First things first, and you need to download and install NodeJS , in case if you do not have npm setup in your machine.  Second step is to run couple of npm commands to install Power BI Visual Tools and create & publish the cert. Finally, create your own package and upload with the help of npm. 1.       npm install -g powerbi-visuals-tools 2.       pbiviz --create-cert pbiviz --install-cert 3.       pbiviz new My Visual name – This will create the file under the name of your visual file. 4.      pbiviz start – You need to go to the folder where your custom visual  resides, and run this command. You can change a few things in...
Read more

SharePoint Admin Center

Image
 SharePoint Admin Center allows you to view your organization's SharePoint site including communication sites, channel sites, and sites that belong to Microsoft 365 group. This is same like Site Admin in earlier days of SharePoint versions. You can search organizational site, sort them or filter sites the way you want. Easy way to find and apply/change site settings. Under Policies, click on Sharing - This will allow you to create rules/ set control sharing at the organization level in SharePoint and OneDrive Here, in this page, you can apply settings to restrict how users are allowed to access content in SharePoint and OneDrive. Term store, the word getting populated from SharePoint 2010. You can feed metadata of metadata information of your organization level, program level, project level in Term store. helps your organization's knowledge better.  AI soon will play a vital role here and using AI, you can acyually find collect and process and finally yoour organization's d...
Read more