SharePoint Trigger

Description

Triggers task execution when a SharePoint event occurs.

Practical Usage

Frequently used to monitor a SharePoint site or list for a specific action or event to take place (i.e. item added or deleted, workflow started, group deleted, etc.).

NOTE: This condition is only supported on SharePoint 2013 Server with 64 bit AutoMate BPA Server.

Related Topics  

Parameters

General

Property

Type

Description

Site URL

String

The SharePoint site URL in which to monitor.

Scope

Options

The SharePoint range to monitor. The available options are:

  • Web - Refers to the collection of all lists that are contained in the website.
  • List - Refers to a particular list in the website defined by its title.

List title

Text

The title of the list to monitor. This parameter is available only if the Scope parameter is set to List.

Events

(Selecting multiple options will cause this condition to evaluate each selection as an OR statement as opposed to an AND statement. In this case, it will react to the first event that occurs.)

Property

Type

Description

Supported in SharePoint 2007 or higher

Item added

Yes/No

If set to YES, the trigger will fire when an item is added to the site/list.

Item Updated

Yes/No

If set to YES, the trigger will fire when an item in the site/list is updated.

Item Deleted

Yes/No

If set to YES, the trigger will fire when an item is deleted from the site/list.

Item checked in

Yes/No

If set to YES, the trigger will fire when an item in the site/list is checked in. You check in a previously checked out item after making changes.

Item checked out

Yes/No

If set to YES, the trigger will fire when an item in the site/list is checked out. If you check out an item, you will reserve it for your use so that others cannot change it while you are working on it.

Item unchecked out

Yes/No

If set to YES, the trigger will fire when an item in the site/list is unchecked out (also known as discarded checkout). You can uncheck out an item if you want it to go back to the way it was before you checked it out. This will undo all of the changes that you made to the item.

Item file moved

Yes/No

If set to YES, the trigger will fire when a file represented by an item from a document library in the site/list is moved.

Item attachment added

Yes/No

If set to YES, the trigger will fire when an attachment is added to a list item in the specified site/list.

Item attachment deleted

Yes/No

If set to YES, the trigger will fire when an attachment is deleted from a list item in the specified site/list.

Field added

Yes/No

If set to YES, the trigger will fire when a field (column) is added to the site/list.

Field updated

Yes/No

If set to YES, the trigger will fire when a field (column) is updated in the site/list.

Field deleted

Yes/No

If set to YES, the trigger will fire when a field (column) is deleted from the site/list.

Supported in SharePoint 2010 or higher

Workflow started

Yes/No

If set to YES, the trigger will fire when a SharePoint workflow is started.

Workflow postponed

Yes/No

If set to YES, the trigger will fire when a SharePoint workflow is postponed.

Workflow completed

Yes/No

If set to YES, the trigger will fire when a SharePoint workflow is completed.

List added

Yes/No

If set to YES, the trigger will fire when a list is added.

List deleted

Yes/No

If set to YES, the trigger will fire when a list is deleted.

Supported in SharePoint 2013 or higher

Group added

Yes/No

If set to YES, the trigger will fire when a group is added to the site/list.

Group updated

Yes/No

If set to YES, the trigger will fire when a group is updated in the specified site/list.

Group deleted

Yes/No

If set to YES, the trigger will fire when a group is deleted from the specified site/list.

Group user added

Yes/No

If set to YES, the trigger will fire when a user is added to a group in the specified site/list.

Group user deleted

Yes/No

If set to YES, the trigger will fire when a user is deleted from a group in the specified site/list.

Role definition added

Yes/No

If set to YES, the trigger will fire when a role definition (or permission level) is added to an item in the specified site/list. A role definition is a collection of rights bound to a specific item.

Role definition updated

Yes/No

If set to YES, the trigger will fire when a role definition (or permission level) is updated in the specified site/list.

Role definition deleted

Yes/No

If set to YES, the trigger will fire when a role definition (or permission level) is deleted from an item in the specified site/list.

Behavior

Property

Type

Description

Enable trigger

Yes/No

If set to YES (default), specifies that the trigger is enabled. If set to NO, the trigger is disabled.

Trigger on startup if condition is true

Yes/No

If set to YES, the trigger will act on conditions that already exist upon startup. If set to NO (default), existing conditions are ignored. For example, assume the file to monitor already exists in the target folder upon creation or startup of this trigger. Yes, will immediately launch the task, however, NO will not.

Trigger after the condition has been met 'X times

Yes/No

If set to YES, specifies how many times the trigger condition must be met before the task is started.

 

additional notes

AMTrigger

When this trigger is activated, it automatically passes the AMTrigger object to the task. AMTrigger is a standard AutoMate dataset and can be used much like the datasets created by the SQL Query and Email actions. The fields of AMTrigger can be used within a task to determine specific values, such as whether or not the task was started by a trigger, which trigger started the task, when the trigger was activated and other properties. AMTrigger populates a unique set of field–value pairs for each AutoMate trigger. The following table lists the ones specific to this trigger. For more details about a specific AMTrigger field–value pair, click the associated link.

Name

Data Type

Return Value

AMTrigger.Action

Text

Returns the action that was fired off the trigger.

AMTrigger.AfterURL

Text

Returns the AfterURL path. When moving or renaming an item, BeforeURL referes to the original path/filename and AfterURL refers to the new path/filename. For example, if moving /share/reports/log.txt to /share/reports/log_results/log.txt, BeforeURL refers to: /share/reports/log.txt and AfterURL refers to /share/reports/log_results/log.txt.

AMTrigger.BeforeURL

Text

Returns the BeforeURL path. When moving or renaming an item, BeforeURL referes to the original path/filename and AfterURL refers to the new path/filename. For example, if moving /share/reports/log.txt to /share/reports/log_results/log.txt, BeforeURL refers to: /share/reports/log.txt and AfterURL refers to /share/reports/log_results/log.txt.

AMTrigger.FieldName

Text

Returns the field name (column name) of a column in a SharPoint list.

AMTrigger.FieldXML

Text

Returns the XML representation of a list field (column).

AMTrigger.File

Text

Returns the name of the file in a SharPoint list.

AMTrigger.GroupID

Text

Returns the globally unique identifier (GUID) of the group.

AMTrigger.GroupName

Text

Returns the name of the group.

AMTrigger.ItemID

Text

Returns the globally unique identifier (GUID) of the list item. This ID identifies the item as unique from anything else in the system.

AMTrigger.ItemTitle

Text

Returns the title of the list item.

AMTrigger.List

Text

Returns the name of the list.

AMTrigger.RoleDefinitionID

Text

Returns the globally unique identifier (GUID) of the role definition.

AMTrigger.RoleDefinitionName

Text

Returns the name of the role definition.

AMTrigger.RoleDefinitionPermissions

Text

Returns the permissions level of the role definition.

AMTrigger.Site

Text

Returns the SharePoint site.

AMTrigger.WorkflowID

Text

Returns the globally unique identifier (GUID) of the SharePoint workflow.

AMTrigger.WorkflowName

Text

Returns the name of the SharePoint workflow.

AMTrigger.WorkflowInstanceID

Text

Returns the globally unique identifier (GUID) of the current SharePoint workflow instance.

 

NOTE: A full list of AMTrigger objects exclusive to each trigger can be viewed from the Expression Builder by expanding Objects -> Triggers and selecting the desired trigger.