SharePoint - Update user alert

Declaration

<AMSHAREPOINT ACTIVITY="update_useralert" SITEURL="text" USER="text" ID="text" TITLE="text" EVENT="text (options)" FREQUENCY="text (options)" />

Related Topics    

Description

Updates the settings and content of an existing user alert.

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 update a user alert for yourself or for other people if you are a site administrator.

Parameters

Connection

Property

Type

Required

Default

Markup

Description

Site

Text

Yes

(Empty)

SITE="http:/yServer/h/mi"

The SharePoint site from which to modify 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 modify a user alert. The user can be identified by his/her login name or email address.

User alert ID

Text

Yes

(Empty)

ID="D1F15740-4A56-4681-8C12-1DFBF346323B"

The unique identifier of the alert to modify.

Title

Text

No

(Empty)

TITLE="theAlert"

The name of the alert in which to modify.

Type

Text (options)

No

Doesn't matter

  1. TYPE="email"

  2. TYPE="SMS"

The type of alert to send. The available options are:

  • Doesn't matter - The alert type is irrelevant.

  • Email - The alert to send will be an email alert.

  • SMS - The alert to send will be an SMS alert.

Event

Text (options)

No

Doesn't matter

  1. EVENT="All"

  2. EVENT="Add"

  3. EVENT="Modify"

  4. EVENT="Delete"

  5. EVENT="Discussion"

The type of  event to which the alert applies. The available options are:

  • Doesn't matter - The event type is irrelevant.

  • All - The alert applies to all events pertaining to the list or list item.

  • Add - The alert applies additions to the list or list item.

  • Modify - The alert applies to all changes made in a list or list item.  

  • Delete - The alert applies to deletion of a list or list item.

  • Discussion - The alert applies to changes in Web discussions.

Frequency

Text (options)

No

Doesn't matter

  1. FREQUENCY="immediate"

  2. FREQUENCY="Daily"

  3. FREQUENCY="Weekly"

The frequency in which the alert should be sent. The available options are:

  • Doesn't matter - The alert frequency is irrelevant.

  • Immediate - The alert is immediate. Immediate alerts are not actually immediate; they are sent after a delay that is determined by the timer interval.  

  • Daily - The alert is sent on a daily basis.

  • Weekly - The alert is sent on a weekly basis.

 

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

Update SharePoint user alert for "me@myDaomain.com. Alert ID is "D1F15740-4A56-4681-8C12-1DFBF346323B"".

<AMSHAREPOINT ACTIVITY="update_useralert" SITEURL="http://myServer/myFolder" USER="me@myDaomain.com" USERFILTER="email" ID="D1F15740-4A56-4681-8C12-1DFBF346323B&quot;" TITLE="myAlert" TYPE="email" EVENT="delete" FREQUENCY="daily" />