SharePoint Notification Listener

The SharePoint Notification Listener activity not only supports listening to the events occurring on the Microsoft SharePoint server but also refreshing data from an external enterprise system in a custom list.

Notice: Online server does not support SharePoint Notification Listener activity from this palette. If you want to use this activity, you must use it from the REST palette.

Important: Before you can use the SharePoint Notification Listener activity, a user with administrative privileges must deploy .NET Solutions on the Microsoft SharePoint server. See TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint Installation for details.

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 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 Add ListItem activity to add the same list item to the Microsoft SharePoint Document list, the SharePoint 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 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 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 SharePointNotificationListener.
SharePoint Connection Yes (Required) Click the icon to select a SharePoint Connection shared resource. The SharePoint Connection shared resource creates a connection between the plug-in and a Microsoft SharePoint server.

If no matching SharePoint Connection shared resources are found, click Create Shared Resource to create one. See Creating a SharePoint 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 shared resource.

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 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 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.

Destination Name Yes (Required) Specify the destination name.

Click Get Destination Configuration to get the destination name and its connection factory type.

Note: Ensure that you have configured the appropriate destination name for the selected list and selected the connection factory type by using the SharePoint Notification Configuration Management tool deployed on the Microsoft SharePoint server. See SharePoint Notification Configuration Management Tool for details about how to create a topic or queue destination.

Connection Factory Type No (Required) Specify the connection factory type.

The following options of the connection factory type are available:

  • Topic: it is used to create connections for publishing or subscribing messaging when the SharePoint Notification Listener activity communicates with the JMS server.
  • Queue: it is used to create connections for point-to-point messaging when the SharePoint Notification Listener activity communicates with the JMS server.

Note: The activity supports the durable subscribers for topics. The durable subscriber ensures that the messages sent from the Microsoft SharePoint server cannot be lost when the activity subscribes to the topic, even if the activity is not currently running.

Durable Subscription No (Optional) Specify whether you want to create the durable subscription for the topic. This check box is displayed when you select the Topic connection factory. If it is selected, you have to configure the Durable Name field.
Durable Name Yes (Required) The name used to access the durable subscription for the topic. This field is displayed when you select the Durable Subscription check box.

Description

On the Description tab, you can enter a short description for the SharePoint 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 Notification Listener activity:

Field Module Property? Description
Sequence Key No This field contains an XPath expression that specifies which processes run in order. Process instances with sequencing keys that evaluate to the same value are performed sequentially in the order the process instance was created.
Custom Job ID No This field contains an XPath expression that specifies a custom job ID for the process instance. This ID is displayed in the TIBCO Administrator View Service dialog, and it is also available in the $_processContext process variable.

Output

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

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

Output Item Data Type Description
EventType String The type of the event. The event type values contains Refresh Data , ItemAdded, ItemUpdated, ItemDeleting, and ItemDeleted.
TriggerDateTime String The date and time when the event is triggered.
CurrentUserId String The ID of the user who initializes the event in Microsoft SharePoint.
CurrentUserName String The name of the user who initializes the event in Microsoft SharePoint.
WebSiteID String The ID of the site, which the selected list belongs to.
WebSiteURL String The URL of the site, which the selected list belongs to.
ListId String The ID of the list, which the list item belongs to.
ListTitle String The title of the list, which the list item belongs to.
Event Handler Notification Type Only

The following output items are displayed only when you select the Event Handler notification type.

ListItemId String The ID of the list item where the event is triggered.
ListItemDisplayName String The ID of the list item where the event is triggered.
Note: This field is not available for the ItemDeleted event.
ListItemData N/A The attributes of the list item where the event occurs. It varies with different content types. For the meaning of each attribute, see the Microsoft SharePoint documentation for more details.
Note: This field is not available for the ItemDeleted event.

Fault

On the Fault tab, you can find the error code and error message of the SharePoint 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 Notification Listener activity:

Error Schema Element Data Type Description
SharePointPluginException
msg String Displays the error message returned by the plug-in.
msgCode String Displays the error code returned by the plug-in.