Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In this article

Table of Contents
maxLevel2
absoluteUrltrue

Overview

You can use this Snap to create Snap to create and share invitations for an item to the configured set of recipients. The invitation provides permissions to the recipients and also contains a sharing link.Image Removed

...

Snap Type

SharePoint Online - Create Item Permission Snap is a Write-type Snap.

Prerequisites

  • Valid SharePoint

    Valid SharePoint Online tenant and associated site.

  • Valid Azure application with all the required API permissions.

Support for Ultra Pipelines

Works in Ultra Pipelines. However, we recommend that you not use this Snap in an Ultra

...

Pipeline.

Limitations and Known Issues

None.

Snap

...

Views

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

  • Min: 0

  • Max: 1

  • Mapper Snap

  • Copy Snap

  • CSV Parser

  • JSON Parser

An input document contains the metadata of the permission to be created.


Output

Document

  • Min: 1

  • Max: 1

  • Mapper Snap

  • Copy Snap

  • CSV Parser

  • JSON Parser

An output document contains the created (or shared) permissions on the item with the recipients.

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:

  • Stop Pipeline Execution: Stops the current pipeline execution if the Snap encounters an error.

  • Discard Error Data and Continue: Ignores the error, discards that record, and continues with the remaining records.

  • Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

Snap Settings

...

Label

...

String

...

Info
  • Asterisk (*): Indicates a mandatory field.

  • Suggestion icon ((blue star)): Indicates a list that is dynamically populated based on the configuration.

  • Expression icon ((blue star)): Indicates whether the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.

  • Add icon ((blue star)): Indicates that you can add fields in the field set.

  • Remove icon ((blue star)): Indicates that you can remove fields from the field set.

Field Name

Field Type

Description

Label*

Default Value: SharePoint Online - Create Item Permission
Example: SharePoint Online - Create Item Permission

String

Specify the 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.

NSite

Site*

Default Value: N/A

SharePoint Online - Create Permission

ExampleMySite

String

Required. The

/Expression

Specify the name of a site

that

which contains the list of document library to be used in the subsequent Snap settings.

N/A

MySite

Custom Site Path

Check-box

Default ValueDeselected

Checkbox

Excerpt
-includeSharePoint Online - Get ItemSharePoint Online - Get ItemnopaneltrueNot SelectedSelected

Document Library

String

Required. This property enables you to select

Enable this option if your site URL contains a custom path that 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
ExampleShared Documents

String/Expression

Specify the a drive representing the top-level container for a file system, such as OneDrive or SharePoint document libraries. This field

populates

will be populated dynamically from different sites

via

from the suggestion drop-down list. You can

select

either choose a document library from

the

suggestion drop-down list or

manually type an entity. Warning
titleNote

enter the entity name manually.

If you enable the

 

Site

 

property as an expression, then the document library

 

is

not

not suggested, resulting in an exception.

NSource item relative path

Source item Relative Path*

Default Value: N/A

Shared Documents

ExampletestFile.pdf

String

Required. The item resource

/Expression

Specify the item resource path that represents a file, folder, or other item stored in a document library

on which we want to create the permission

Roles

StringRequired.Specify the roles

.

N/A

testFile.pdf

Roles*

Default Valueread
Examplewrite

Dropdown list

Select the role that are to be granted to the recipients of the invitation. Available options are:

Read
  • read

Write
  • write

Recipients*

Default Value: N/A
Example

String

Required. Comma

/Expression

Specify the comma-separated recipients who will receive access and the sharing invitation to the selected item. 

NMessage

Message

Default Value: N/A

user@company.com

ExampleRead permissions

String

Optional. A Require signinCheck boxOptional.

/Expression

Specify the plain text formatted message that is included in the sharing invitation. Maximum length of 2000 characters.

N/A

Require sign-in

Default ValueDeselected

Checkbox

Enable this property to send the invitation to sign-in to view the shared item with the recipients.

Not selectedOptional.

Send invitation

Check box

Default ValueDeselected

Checkbox

Enable to send a sharing link to the recipient. Otherwise, a permission is granted directly without sending a notification.

Not selected

Connection details

Settings to influence

Use this field set to specify connection properties to the SharePoint Online APIs.

This fieldset comprises the following fields:

 

Connection

timeout
  • Number of retries
  • Retry interval (seconds)
  • Connection timeout

    IntegerRequired. Set

    Timeout*

    Default Value30
    Example40

    Integer

    Specify the connection timeout duration in seconds.

    3030Number of retries. Set

    Number of Retries*

    Default Value0
    Example5

    Integer

    Required

    Specify the maximum number of reconnections in case of a connection failure or timeout.

    00

    Retry

    interval

    Interval (seconds)*

    Default Value1
    Example11

    Integer

    Required. Set

    Snap Execution

    String

    Specify the required Pipeline 

    Specify the time interval in seconds between connection attempts.

    11

    Snap Execution

    Default ValueExecute only
    ExampleValidate & Execute

    Dropdown list

    Specify the required Pipeline execution type:

    • Validate & Execute. Performs limited execution of the Snap (up to 50 records) during Pipeline validation; performs full execution of the Snap (unlimited records) during Pipeline execution.

    • Execute only. Performs full execution of the Snap during Pipeline execution; does not execute the Snap during Pipeline validation.

    • Disabled. Disables the Snap and, by extension, its downstream Snaps.

    Execute only

    Validate & Execute

    Info

    For more information on how to update an item permissions in the SharePoint Online, refer to the graph API, see Change Sharing-Permissions.

    Troubleshooting

    Error

    Reason

    Resolution

    HTTP Response Code:404

    Entered item not found in the document library

    Please ensure to provide the valid item path to get the metadata.

    Forbidden exception:403

    Either user or app don't have sufficient permissions to read the metadata for the document library.

    Ensure to provide the desired permissions both at the user and application level.

    Examples

    Creating Permission for an Item

    This example demonstrates how you can create a permission on a specified item. This example assumes that you have configured and authorized a valid SharePoint Online Account (see SharePoint Online Account).Image Removed

    ...

    The following screenshot displays the settings of the SharePoint Online Create Item Permission Snap.Image Removed

    ...

    After successfully validating/executing the above above Snap, the results display in the following the following output preview.Image Removed

    ...

    Download this Pipeline.

    Downloads

    title
    Note
    Info

    Important Steps to Successfully Reuse Pipelines

    1. Download and import the Pipeline into SnapLogic.

    2. Configure Snap accounts as applicable.

    3. Furnish Pipeline parameters as applicable.

    Attachments
    patterns*.slp

    Insert excerpt
    SharePoint Online Snap Pack
    SharePoint Online Snap Pack
    nopaneltrue

    ...

    See Also

    Child pages (Children Display)
    pageSharePoint Online Snap Pack
    sorttitle