SharePoint REST HTTP Notification Listener

The following list shows the event handling and data refresh functions provided by the activity:

• Event Handler: The activity responds to the events triggered on the Microsoft SharePoint server. The event types supported in this activity include the added, updated, deleting, and deleted a list item.

  To enable this function, you must use the SharePoint Notification Configuration Management tool to bind the selected list to the event handler first. See SharePoint HTTP Notification Configuration Management Tool for more details.

  Note: When an add operation is triggered in the Microsoft SharePoint Picture library and Wiki Page library, or when you use the SharePoint REST Add ListItem activity to add the same list item to the Microsoft SharePoint Document list, the SharePoint REST Notification Listener activity can be triggered more than once.

• Refresh Data: The activity is triggered by clicking the TIBCO Refresh Data custom web part that is inserted into a custom Microsoft SharePoint list. After successfully installing the custom web part solution on the Microsoft SharePoint server and inserting the custom web part into a custom Microsoft SharePoint list, the Refresh Data From External Application button is displayed on the web page that renders the custom list. You can use the activity to work with other activities, such as Request-Response Service of TIBCO ActiveMatrix® Adapter for Siebel, to fetch data and populate the custom list with the data from an external source.

  To enable this function, you must use the SharePoint HTTP Notification Configuration Management tool to bind custom lists with the Refresh Data notification type, set the destination information and deploy the custom web part in the Microsoft SharePoint custom list.

  Note: When you log on to the Microsoft SharePoint portal with read-only access and try to use the TIBCORefreshData custom web part, the Refresh Data From External Application button is disabled. To use this web part and fetch the data from an external application, you must have read/write access privileges.

General

On the General tab, you can establish a connection to a Microsoft SharePoint server and specify the list item that you want to listen to.

The following table lists the configurations on the General tab of the SharePoint REST HTTP Notification Listener activity:

Field	Module Property?	Description
Name	No	(Required) Specify the name to be displayed as the label for the activity in the process. The default value is SharePointRESTNotificationListener.
SharePoint REST Connection	Yes	(Required) Click the icon to select a SharePoint REST Connection shared resource. The SharePoint REST Connection shared resource creates a connection between the plug-in and a Microsoft SharePoint server. If no matching SharePoint REST Connection shared resources are found, click Create Shared Resource to create one. See Creating a SharePoint REST Connection for more details.
Web Name	No	(Required) Get the target website. Click Fetch Webs to get available websites from the site collection specified in the SharePoint REST Connection shared resource in the web Name attribute.
List Name	No	(Required) Get the list that you want to operate on. Click Fetch Lists to get available lists from the website selected in the Web Name field.
Notification Type	No	(Required) Get the notification type. The following options of the notification type are available: Event Handler: it can be used to capture events, such as added, updated, deleting, and deleted that are triggered in Microsoft SharePoint lists. Refresh Data: it can be used to refresh the data, generated from an external application in a Microsoft SharePoint custom list representation.
SharePoint REST Event	No	(Required) Specify which kind of events that the activity responds to. This field is displayed only when the Event Handler notification type is selected. The following options of the SharePoint REST event are available: Select All: it is triggered when any events occur in a list in Microsoft SharePoint. ItemAdded: it is triggered when a new list item is added to a list in Microsoft SharePoint. ItemUpdated: it is triggered when an existing item in a Microsoft SharePoint list is updated. ItemDeleting: it is triggered when an existing list item is about to be deleted from a list in Microsoft SharePoint server. ItemDeleted: it is triggered when an existing list item is deleted from a Microsoft SharePoint list.
Http Connection	Yes	Specify an HTTP Connector shared resource. (Required) Click the icon to select a HTTP Connection Resource shared resource. The HTTP Connection Resource shared resource creates a connection between the plug-in and a Microsoft SharePoint server. If no matching HTTP Connection Resource shared resources are found, click Create Shared Resource to create one. See Creating an HTTP Connector Shared Resource for more details.
Relative Path	Yes	Specify a URL path relative to the REST HTTP Notification Listener instance. Note: Relative Path is case sensitive, and must be unique when there are multiple entity event source instances. The relative path must be consistent with the value configured for the SharePoint HTTP Notification Management tool.
Username	Yes	Specify the user name that is used for basic authentication to the runtime SharePoint REST HTTP Notification Listener activity. Note: The user name must be consistent with the value configured for the SharePoint HTTP Notification Management tool.
Password	Yes	Specify the password that is used for basic authentication to the runtime SharePoint REST HTTP Notification Listener activity. Note: The password must be consistent with the value configured for the SharePoint HTTP Notification Management tool.

Description

On the Description tab, you can enter a short description for the SharePoint REST Notification Listener activity.

Advanced

On the Advanced tab, you can specify the running sequence of processes and custom job ID for the process instance.

The following table lists the configurations on the Advanced tab of the SharePoint REST HTTP Notification Listener activity:

Output

On the Output tab, you can find the event that is triggered results.

The following table lists the output elements on the Output tab of the SharePoint REST HTTP Notification Listener activity:

Fault

On the Fault tab, you can find the error code and error message of the SharePoint REST HTTP Notification Listener activity. See Error Codes for more detailed explanation of errors.

The following table lists error schema elements on the Fault tab of the SharePoint REST Notification Listener activity: