Overview

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint plugs into TIBCO ActiveMatrix BusinessWorks™. You can use the plug-in to add, delete, update, and query data in the Microsoft SharePoint On-Premises server and Microsoft SharePoint Online server and listen to events that are triggered in the Microsoft SharePoint Online or On-Premises server.

ActiveMatrix BusinessWorks™ is a leading integration platform that can integrate a wide variety of technologies and systems within enterprise and on cloud. ActiveMatrix BusinessWorks™ includes an Eclipse-based graphical user interface (GUI) provided by TIBCO Business Studio™ for design, testing, and deployment. If you are not familiar with ActiveMatrix BusinessWorks™, see the TIBCO ActiveMatrix BusinessWorks™ documentation for more details.

ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint plugs into ActiveMatrix BusinessWorks™ and adds SharePoint Palette and SharePoint REST Palette to TIBCO Business Studio. You can create a connection between the plug-in and Microsoft SharePoint server, and then configure a process using the activities in the SharePoint palette / SharePoint REST palette to manage and query data in the Microsoft SharePoint server, and publish events and refresh data from external systems.

Note: The existing Microsoft SharePoint Palette is also called Microsoft SharePoint SOAP Palette. The activities in this palette use SOAP calls to communicate with the server.
Note: The activities in the Microsoft SharePoint REST palette use REST API calls to communicate with the server.

Communication between the Plug-in and Microsoft SharePoint Server

The plug-in with SOAP Palette activities communicates with the Microsoft SharePoint server in the following ways:
  • Through web service or Windows Communication Foundation (WCF) over HTTP or HTTPS
  • Through a JMS server

When the plug-in queries metadata from the Microsoft SharePoint server, the plug-in communicates with the Microsoft SharePoint server through WCF over HTTP or HTTPS.

When the plug-in manages data, such as adding, deleting, updating, and deleted list items in the Microsoft SharePoint server, the plug-in communicates with the Microsoft SharePoint server through web services over HTTP or HTTPS.

When the plug-in listens to events occurring in the Microsoft SharePoint server, the plug-in communicates with the Microsoft SharePoint server through the JMS server. The plug-in and Microsoft SharePoint server support using JNDI or SSL to communicate with the JMS server.

Note: Only the SharePoint Notification Listener activity depends on JMS to transfer messages between the plug-in and Microsoft SharePoint server.

The plug-in with REST Palette activities communicates with the Microsoft SharePoint server through REST API calls over HTTP or HTTPS.

When the plug-in queries REST metadata from the Microsoft SharePoint server, the plug-in communicates with the Microsoft SharePoint server through REST API calls over HTTP or HTTPS.

When the plug-in manages data, such as adding, deleting, updating, and deleted list items in the Microsoft SharePoint server, the plug-in communicates with the Microsoft SharePoint server through REST API calls over HTTP or HTTPS.

When the plug-in listens to events occurring in the Microsoft SharePoint server, the plug-in communicates with the Microsoft SharePoint server through the HTTP or HTTPS servers. The REST HTTP Notification listener activity can use either the HTTP or HTTPS communication mode to communicate with a Microsoft SharePoint server when receiving user event messages.

Main Functions of the Plug-in

The plug-in provides various functions depending upon the palette you choose.

For SharePoint Palette, the plug-in mainly provides the following functions:

  • The SharePoint Connection shared resource can be reused for the SharePoint Get Metadata tool and different activities.
  • You can use the SharePoint Get Metadata tool to get or review Microsoft SharePoint metadata, which is used to configure various Microsoft SharePoint activities at design time.
  • You can use the SharePoint Notification Listener activity to listen to the events triggered on the Microsoft SharePoint server, such as added, updated, deleted, or deleting a list item. You can also use the activity to work with other activities to fetch data and populate the custom list with the data from an external source.
  • You can use the SharePoint Add ListItem, SharePoint Delete ListItem, and SharePoint Update ListItem activities to add, delete, and update list items in the Microsoft SharePoint servers. These activities also support batch operations, which mean that you can manage multiple list items at a time. Additionally, you can manage list items across Microsoft SharePoint sites on the condition that each list has the same name and the same column names with the same sequence order.
  • You can use different query conditions to select list items that belong to a specific list type from the Microsoft SharePoint server through the SharePoint Select ListItem activity.
  • You can use the SharePoint Query activity to query list items across different Microsoft SharePoint lists and websites in a specific site collection.
  • The SharePoint Notification Configuration Management tool is used to support the SharePoint Notification Listener activity. The tool is deployed on the Microsoft SharePoint server after you install the .NET solution components packaged within the ActiveMatrix BusinessWorks Plug-in for Microsoft SharePoint installer. You can use the SharePoint Notification Configuration Management tool to configure JMS or HTTP and destination information, set notification types, configure event handlers, and refresh data information.
For SharePoint REST Palette, the plug-in mainly provides the following functions:
  • The SharePoint REST Connection shared resource can be reused for the SharePoint REST Get Metadata tool and different activities.
  • You can use the SharePoint REST Get Metadata tool to get Microsoft SharePoint Rest metadata, which is used to configure various Microsoft SharePoint REST activities at design time.
  • You can use the SharePoint REST HTTP Notification Listener activity to listen to the events triggered on the Microsoft SharePoint server, such as adding, updating, deleted and deleting a list item. You can also use the activity to work with other activities to fetch data and populate the custom list with the data from an external source.
  • You can use the SharePoint REST Add ListItem, SharePoint REST Delete ListItem, and SharePoint REST Update ListItem activities to add, delete, and update list items in the Microsoft SharePoint servers. These activities also support adding, deleting, and updating multiple list items at a time using successive REST API calls but not using REST batch API calls.
  • You can use different query conditions to select list items that belong to a specific list type from the Microsoft SharePoint server through the SharePoint REST Select ListItem activity.
  • The SharePoint REST HTTP Notification Configuration Management tool is used to support the SharePoint REST HTTP Notification Listener activity. The tool is deployed on the Microsoft SharePoint server after you install the .NET solution components packaged within the ActiveMatrix BusinessWorks Plug-in for Microsoft SharePoint installer. You can use the SharePoint REST HTTP Notification Configuration Management tool to configure HTTP and destination information, set notification types, configure event handlers, and refresh data information.
Note: ActiveMatrix BusinessWorks Plug-in for Microsoft SharePoint has two installation types: Runtime and Typical. See TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint Installation for details.