SharePoint - List User Alerts
Declaration
<AMSHAREPOINT ACTIVITY="list_useralerts" SITEURL="text" USER="text" RESULTDATASET="text" />
Description: Retrieves a list of user alerts and populates a dataset with results.
This activity is only supported on SharePoint 2013 Server. Before users and 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.
Connection Parameters
|
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. |
Example
The sample AML code below can be copied and pasted directly into the Steps panel of the Task Builder.
Description: List SharePoint user alerts for "theUser" and store information in dataset "theUserAlertList".
<AMSHAREPOINT ACTIVITY="list_useralerts" SITEURL="http://myServer/folder" USER="theUser" RESULTDATASET="theUserAlertList" />