SharePoint - List user alert(s)

Declaration

<AMSHAREPOINT ACTIVITY="list_useralerts" SITEURL="text" USER="text" RESULTDATASET="text" />

Related Topics    

Description

Retrieves a list of user alerts and populates a dataset with results.

NOTE: This activity is only supported on SharePoint 2013 Server with the 64 bit version of AutoMate/BPA. Before users and alerting administrators can create, edit, delete, and view data alerts, they must be granted SharePoint permissions.

Practical Usage

Alerts are notifications of changes to content on a site that you receive as email messages or text messages to your mobile phone. This activity allows you to retrieve user alerts as a way to perform an activity on a batch of user alerts.

Parameters

Connection

Property

Type

Required

Default

Markup

Description

Site

Text

Yes

(Empty)

SITE="http://myServer/folder"

The SharePoint site from which to retrieve alerts. A SharePoint site is a collection of pages, site templates, lists, and libraries configured for the purpose of achieving an express goal.

User

Text

Yes

(Empty)

USER="theUser"

The user from which to retrieve the list of alerts. The user can be identified by his/her login name or email address.

Create and populate dataset with SharePoint user alert(s) information

Text

Yes

(Empty)

RESULTDATASET="userAlerts"

The name of the dataset to create and populate with information about the user alerts.

 

Description

Error Causes

On Error

Example

NOTE: The sample AML code below can be copied and pasted directly into the Steps panel of the Task Builder.

Description

List sharepoint user alert(s) for "theUser" and store information in dataset "theUserAlertList".

<AMSHAREPOINT ACTIVITY="list_useralerts" SITEURL="http://myServer/folder" USER="theUser" RESULTDATASET="theUserAlertList" />