SharePoint - Create User Alert
Declaration
<AMSHAREPOINT ACTIVITY="create_useralert" SITEURL="text" USER="text" USERFILTER="text (options)" LIST="text" ITEMID="text" TITLE="text" TYPE="text (options)" EVENT="text (options)" FREQUENCY="text (options)" />
Description: Creates a user alert which is used to notify a user of changes to SharePoint content.
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 create a user alert for yourself or for other people if you are a site administrator.
Connection Parameters
Property |
Type |
Required |
Default |
Markup |
Description |
---|---|---|---|---|---|
Site |
Text |
Yes |
(Empty) |
SITE="http:/yServer/h/mi" |
The SharePoint site from which to create a user alert. 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 create a user alert. The user can be identified by his/her login name or email address. |
Title |
Text |
No |
(Empty) |
TITLE="theAlert" |
The name of the alert to create. |
Type |
Text (options) |
No |
Doesn't matter |
|
The type of alert to create. The available options are:
|
List title |
Text |
Yes |
(Empty) |
LIST="theList" |
The name of the list in which an alert will be created. Click the folder icon to open the SharePoint Browser which enables easy navigation to the desired list. |
Item ID |
Text |
Yes |
(Empty) |
ID="D1F15740-4A56-4681-8C12-1DFBF346323B |
The unique identifier of the list item in which an alert will be created. |
Event |
Text (options) |
No |
Doesn't matter |
|
The type of eventto which the alertapplies. The available options are:
|
Frequency |
Text (options) |
No |
Doesn't matter |
|
The frequency in which the alert should be sent. The available options are:
|
Example
The sample AML code below can be copied and pasted directly into the Steps panel of the Task Builder.
Description: Create SharePoint user alert for "me@myDaomain.com. Alert title is "myAlert".
<AMSHAREPOINT ACTIVITY="create_useralert" SITEURL="http://myServer/myFolder" USER="me@myDaomain.com" USERFILTER="email" LIST="theList" ITEMID="D1F15740-4A56-4681-8C12-1DFBF346323B" TITLE="myAlert" EVENT="delete" FREQUENCY="daily" />