In this article
| Table of Contents | ||||
|---|---|---|---|---|
|
...
Works in Ultra Pipelines. However, we recommend that you not use this Snap in an Ultra Pipeline. To know the list of Snaps that work in Ultra and the related caveats, refer to Snap Support for Ultra Pipelines.
Limitations and Known Issues
None.
Snap Views
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
|---|---|---|---|---|
Input | Document |
|
| An input document contains the metadata of the permission to perform update. |
Output | Document |
|
| An output document contains the updated permissions of an item. |
Error | Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter when running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab:
Learn more about Error handling in Pipelines. | |||
...
Field Name | Field Type | Description | |
|---|---|---|---|
Label* Default Value: SharePoint Online - Update Item Permission | String | Specify a unique name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your Pipeline. | |
Site* Default Value: N/A | String/Expression | Specify the name of a site which contains the list of document library to be used in the subsequent Snap settings. | |
Custom Site Path Default Value: Deselected | Checkbox | Enable this option if your site URL contains a custom path the deviates from the default site URL. Default site path always has a prefix ‘sites/' before the sitename, a custom site can contain the prefix ‘teams/’ or it can have no prefix. | |
Document Library* Default Value: N/A | String/Expression | Specify the a drive representing the top-level container for a file system, such as OneDrive or SharePoint document libraries. This field will be populated dynamically from different sites from the suggestion drop-down list. You can either choose a document library from suggestion drop-down list or enter the entity name manually. If you enable the Site property as an expression, then the document library is not suggested, resulting in an exception. | |
Source Item Relative Path* Default Value: N/A | String/Expression | Specify the item resource path that represents a file, folder, or other item stored in a document library. | |
Permission ID* Default Value: N/A | String/Expression | Select or enter the permission ID to update in the SharePoint Online library. | |
Roles* Default Value: read | Dropdown list | Select the role that are to be granted to the recipients of the invitation. Available options are:
| |
Connection details | Use this field set to specify connection properties to the SharePoint Online APIs. | ||
Connection Timeout* Default Value: 30 | Integer | Specify the connection timeout duration in seconds. | |
Number of Retries* Default Value: 0 | Integer | Specify the maximum number of reconnections in case of a connection failure or timeout. | |
Retry Interval (seconds)* Default Value: 1 | Integer | Specify the time interval in seconds between connection attempts. | |
Snap Execution Default Value: Execute only | Dropdown list | Specify the required Pipeline execution type:
| |
...
This example demonstrates how to take the document library from the Mapper Snap and update the role/permission of the selected item to Read-Only. The example assumes that you have configured and authorized a valid SharePoint Online Account. For more information, refer to SharePoint Online Account.
...
The following screenshot displays the settings of the SharePoint Online Update Item Permission Snap.
...