SharePoint Trigger
Description
Triggers task execution when a SharePoint event occurs.
Practical usage
Monitors a SharePoint site or list for a specific action or event to take place (for example, item added or deleted, workflow started, group deleted, etc.).
Parameters
General
Property | Type | Description |
---|---|---|
Site URL | String | The SharePoint site URL to monitor. |
Scope | Options | The SharePoint range to monitor. The available
options are:
|
List title | Text | The title of the list to monitor. This parameter is only available 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 |
---|---|---|
Item added | Yes/No | If selected, the trigger will fire when an item is added to the site/list. |
Item updated | Yes/No | If selected, the trigger will fire when an item in the site/list is updated. |
Item deleted | Yes/No | If selected, the trigger will fire when an item is deleted from the site/list. |
Item checked in | Yes/No | If selected, 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 selected, 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 selected, 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 selected, 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 selected, the trigger will fire when an attachment is added to a list item in the specified site/list. |
Item attachment deleted | Yes/No | If selected, the trigger will fire when an attachment is deleted from a list item in the specified site/list. |
List added | Yes/No | If selected, the trigger will fire when a list is added. This option is only available when Scope is set to Web. |
List deleted | Yes/No | If selected, the trigger will fire when a list is deleted. This option is only available when Scope is set to Web. |
Field added | Yes/No | If selected, the trigger will fire when a field (column) is added to the site/list. |
Field updated | Yes/No | If selected, the trigger will fire when a field (column) is updated in the site/list. |
Field deleted | Yes/No | If selected, the trigger will fire when a field (column) is deleted from the site/list. |
Workflow started | Yes/No | If selected, the trigger will fire when a SharePoint workflow is started. |
Workflow postponed | Yes/No | If selected, the trigger will fire when a SharePoint workflow is postponed. |
Workflow completed | Yes/No | If selected, the trigger will fire when a SharePoint workflow is completed. |
Group added | Yes/No | If selected, the trigger will fire when a group is added to the site/list. This option is only available when Scope is set to Web. |
Group updated | Yes/No | If selected, the trigger will fire when a group is updated in the specified site/list. This option is only available when Scope is set to Web. |
Group deleted | Yes/No | If selected, the trigger will fire when a group is deleted from the specified site/list. This option is only available when Scope is set to Web. |
Group user added | Yes/No | If selected, the trigger will fire when a user is added to a group in the specified site/list. This option is only available when Scope is set to Web. |
Group user deleted | Yes/No | If selected, the trigger will fire when a user is deleted from a group in the specified site/list. This option is only available when Scope is set to Web. |
Role definition added | Yes/No | If selected, 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. This option is only available when Scope is set to Web. |
Role definition updated | Yes/No | If selected, the trigger will fire when a role definition (or permission level) is updated in the specified site/list. This option is only available when Scope is set to Web. |
Role definition deleted | Yes/No | If selected, the trigger will fire when a role definition (or permission level) is deleted from an item in the specified site/list. This option is only available when Scope is set to Web. |
Role assignment added | Yes/No | If selected, the trigger will fire when a role assignment is added to the specified site/list. This option is only available when Scope is set to Web. |
Role assignment deleted | Yes/No | If selected, the trigger will fire when a role assignment is deleted from the specified site/list. This option is only available when Scope is set to Web. |
Users
Property | Type | Description |
---|---|---|
Use default agent user | Yes/No | If selected, the trigger will use the specified Default User. |
Use specified user | Yes/No | If selected, uses the user account specified in the Username, Password, and Domain parameters. This
account will always override the Use default agent user option.
This user must have proper rights to the SharePoint server and
database. Enter the user's credentials in the boxes provided:
|
Behavior
Property | Type | Description |
---|---|---|
Enable trigger | Yes/No | If selected (default), specifies that the trigger is enabled. If disabled, the trigger is disabled. |
Trigger on startup if condition is true | Yes/No | If selected, the trigger will act on conditions that already exist upon startup. If disabled (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 <#> times | Yes/No | If selected, 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 Desktop dataset and can be used much like the datasets created by the Database - SQL query activity and Email action. 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 Desktop trigger. The following table lists the ones specific to this trigger. For more details about a specific AMTrigger field–value pair, select the associated link.
To view AMTrigger values exclusive to the SharePoint Trigger, see AMTrigger - SharePoint.