Configure TotalAgility actions resulting from SharePoint events

You can configure and execute TotalAgility actions for SharePoint events. For example, you can configure a TotalAgility job that starts when a purchase order is uploaded to SharePoint. TotalAgility supports SharePoint events on-premise as well as online.

In the Integration Server, you can configure the events in the same way as you would do in a TotalAgility on-premise environment.

When the event is raised on the Integration Server, the action is executed on Azure.

TotalAgility provides the following actions for SharePoint events:

SharePoint events

You can configure TotalAgility actions for the following events in SharePoint.

SharePoint Event

Occurs

ItemAdded

When an item is added to the SharePoint repository.

ItemUpdated

When an item is updated in the SharePoint repository.

ItemDeleted

When an item is deleted from the SharePoint repository.

ItemCheckedIn

When an item is checked into the SharePoint repository.

ItemCheckedOut

When an item is checked out of the SharePoint repository.

ItemUnCheckedOut

When an item checkout is undone in the SharePoint repository.

Events like ItemCheckedIn, ItemCheckedOut, and ItemUnCheckedOut help to ensure the integrity of documents by enforcing document checkout before editing, viewing past revisions and restoring to previous versions, and setting document-specific security.

SharePoint items

The following table outlines the SharePoint events that occur for the user-defined (custom) columns in SharePoint.

Actions performed in SharePoint

Triggered SharePoint events

Number of jobs created

Add an item

  • ItemAdded

One job for both adding an item and updating the custom-defined columns.

Upload an item

  • ItemAdded

  • ItemUpdated

Two jobs:
  • For uploading the item

  • For updating the custom-defined columns

Check-in an item

  • ItemCheckedIn

  • ItemUpdated (occurs along with the check-in.)

  • ItemUpdated (occurs while updating the custom-defined column properties.)

Three jobs:
  • Two jobs for checking the item

  • One job for updating the custom-defined columns.

When a document is added to the library, SharePoint does the following:

  • SharePoint adds the document to the library.

  • SharePoint fires the ItemAdded event.

  • Displays the property editing screen where you can edit and save the properties.

  • Fires the ItemUpdated event.

  • Begins the process of automatically checking in the document.

  • Fires the ItemUpdated event.

  • Fires the ItemCheckedIn event.

When the ItemUpdated event is fired the first time, it is in response to the changes in document properties. When it is fired the second time, it is in response to the document being checked in; it appears as though the event is fired twice in this scenario.

SharePoint events online

TotalAgility only supports the ItemAdded, ItemUpdated, and ItemDeleted events for SharePoint online. It does not support the ItemCheckedIn, ItemCheckedOut, and ItemUnCheckedOut events.

Also, SharePoint online events are executed differently than SharePoint on-premise events.

  • When you add an item, only the ItemAdded is fired.

  • When an item is checked in, checked out, or discarded, only one ItemUpdated event is fired.

  • For the ItemDeleted event, the Created By and Server Relative URL field values are not populated

How to: