SharePointEventsProcessor
The Microsoft Graph API allows you to register event handlers, so that notifications are sent to a web server when various events take place. The SharePointEventsProcessor is a NiFi Ingest processor that handles these events.
There are many use cases for this processor - for example you could use it to ingest new content as soon as it is created (real-time ingestion), rather than having a connector retrieve data at regular intervals.
To receive notifications from Microsoft, you must have a public-facing web server with a trusted SSL certificate. The SharePointEventsProcessor starts its own web server but you must provide the certificate, and you might want to set up a reverse proxy.
Properties
| Name | Description |
|---|---|
| IDOL License Service |
An IdolLicenseServiceImpl that provides a way to communicate with a Knowledge Discovery License Server. |
| SharePoint URL | The URL to a SharePoint personal site collection, site collection, primary site collection (tenant admin), or web application. |
| SharePoint URL Type | The type of URL specified by "SharePoint URL". |
| Event Web Server Host | The processor starts a web server to receive event notifications from Microsoft. This parameter specifies the host name to bind to. |
| Event Web Server Port | The processor starts a web server to receive event notifications from Microsoft. This parameter specifies the port number to use. |
| Process Event Timeout | When notified about some types of event, you must provide a response by routing event FlowFiles back to this processor. This property specifies the maximum time limit for that response, before events are allowed to continue regardless. Specify a time duration, for example "15 seconds". |
| ReceiverName | The processor adds an event handler in SharePoint, requesting that events are sent to the "Receiver URL". Specify a name to use to identify the event handler. |
| SharePoint domain | The domain of the user specified by "SharePoint username". |
| Proxy Configuration Service | A ProxyConfigurationServiceImpl to use when connecting to the Microsoft Graph API. The processor has to register the Event Web Server with Microsoft. |
| SSL Config Service | An IdolSSLConfigServiceImpl to use to configure the SSL settings for the Event Web Server. The web server must have a trusted SSL certificate (not a self-signed certificate). |
| SharePoint Online | Specifies whether you are retrieving data from SharePoint Online. |
| SharePoint Admin URL | The URL of the admin site collection. (SharePoint Online only) |
| SharePoint MySite URL | The URL of the "MySites" site collection. (SharePoint Online only) |
| Event Web Server Max Request Size | The maximum size (in bytes) for incoming requests to the web server. |
| Event Web Server Threads | The number of threads to use for processing incoming requests. |
| Event Web Server Trace Logging Enabled | To log debug-level information about incoming requests, set this property to TRUE. |
| Event Web Server Use SSL | To configure the events web server to accept secure connections, set this property to TRUE. |
| OAuth2 site name | The processor must be able to use the Microsoft Graph API. To configure OAuth authentication, right-click the processor and click Advanced, and then follow the instructions on the GUIDED SETUP tab. |
| OAuth2 sites file | The processor must be able to use the Microsoft Graph API. To configure OAuth authentication, right-click the processor and click Advanced, and then follow the instructions on the GUIDED SETUP tab. |
| One Way Event Types |
A list of one-way event types to request from SharePoint. You do not need to provide a response for these events. Allowable values: SiteDeleted, WebDeleted, WebMoved, WebProvisioned, WebRestored, ListAdded, ListDeleted, ItemAdded, ItemUpdated, ItemDeleted, ItemCheckedIn, ItemCheckedOut, ItemUncheckedOut, ItemAttachmentAdded, ItemAttachmentDeleted, ItemFileMoved, ItemFileConverted, ItemVersionDeleted. |
| Process Event Types |
A list of event types to request from SharePoint. IMPORTANT: A response must be returned to this processor for these events. Allowable values: SiteDeleting, WebDeleting, WebMoving, WebAdding, ListAdding, ListDeleting, ItemAdding, ItemUpdating, ItemDeleting, ItemCheckingIn, ItemCheckingOut, ItemUncheckingOut, ItemAttachmentAdding, ItemAttachmentDeleting, ItemFileMoving, ItemVersionDeleting. |
| Receiver Location | The processor adds an event handler in SharePoint, requesting that events are sent to the "Receiver URL". Specify whether to request events at the Site, Web, or List level. |
| Receiver URL | The URL for Microsoft to send events to. |
| Site collection URL cant have regex | If the absolute URL of a site collection matches the regular expression, the site collection is ignored. |
| Site collection URL must have regex | The absolute URL of a site collection must match the regular expression, or the site collection is ignored. |
| TenantAdminSitesIncludeTypes |
The type of sites to include when you specify a tenant admin URL in the property "SharePoint URL":
|
| SharePoint username | The user name for authentication with the SharePoint API. (OpenText recommends using OAuth instead). |
| SharePoint password | The password for authentication with the Sharepoint API. (OpenText recommends using OAuth instead). |
Relationships
| Name | Description |
|---|---|
| success | Successfully handled ProcessEvent FlowFiles. |
| failure | Unsuccessfully handled ProcessEvent FlowFiles. |
| <event type> | Other relationships are created dynamically based on the event types that you choose to process, so that you can route them separately. |