Versions Compared

Old Version 6

changes.mady.by.user Joseph Daniel

Saved on

compared with

New Version Current

changes.mady.by.user Gouri Bhagchandani

Saved on

Key

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

In this article

Table of Contents
maxLevel2
absoluteUrltrue

Overview

This Snap provides the ability to You can use this Snap to get the metadata of an item from the SharePoint Online document library. Also, you can retrieve specific fields in the metadata of a document library by submitting the comma-separated field names in the select property.Image Removed

...

Snap Type

SharePoint Online - Get Document Library Snap is a Read-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

...

See Pipeline. To know the list of Snaps that work in Ultra and the related caveats, see 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

  • Min: 0

  • Max: 1

  • Mapper

SnapA document containing

  • Copy Snap
  • CSV Parser
  • JSON Parser

    • File Writer

    An input document contains the metadata information that needs to get the document library metadata.


    Output

    Document

    • Min: 1

    • Max: 1

  • Mapper Snap

    • Copy

    Snap

  • CSV Parser

    • JSON Parser

    A

    An output document

    containing

    contains the metadata of the document library or complete list of document libraries in the mentioned site.

    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

    ...

    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

    Example Label

    : SharePoint Online - Get Document Library
    Example: SharePoint Online - Get Document Library

    String

    Required. The

    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

    Pipeline.

    N

    Site

    String

    Required. The

    Site*

    Default Value: N/A

    SharePoint Online - Get Document Library

    Example: MySite

    String/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

    Document Library

    String

    Optional. This property enables you to select Drive

    Custom Site Path

    Default Value: Deselected

    Checkbox

    Excerpt

    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
    Example: Shared 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 will be populated dynamically from different sites from the suggestion drop-down list.

    Users are allowed

    You can either

    to

    choose a document library from suggestion drop-down list or

    type an

    enter the entity name manually.

    If

    this property doesn’t have a value then by default the snap will get the metadata of all document libraries within the site. WarningIf user enables the Site property as

    you enable the Site property as an expression, then the document library

     

    is

    not suggested. Such a configuration results 

    not suggested, resulting in an exception.

    NSelect fields

    Select fields

    Default Value: N/A

    Shared Documents

    Example: id, name

    String/Expression

    Optional. Enter

    Specify the comma-separated list of properties to be returned to the output view.

    N/Aid, nameOrderby propertiesOptional. Enter

    Order by Properties

    Use this fieldset to Enter the properties and order they want to be displayed when found more one item with one or more similar properties.

     This fieldset comprises the following fields:

     

    Property name

  • Order type
    • Property

    Default Value: N/A
    Example: name

    String

    Enter

    Order type

    String

    Specify the attribute name of the item/drive/folder to be sorted.

    N/Aname

    Order type

    Default Value: asc
    Example: desc

    Dropdown list/Expression

    Select the appropriate order type to perform the sorting at the server-side. Avaialble options are:

    • asc

    • desc

    Top

    Default Value: N/A
    Example: 50

    Integer/Expression

    Sets

    Specify the page size of results.

    N/A50Optional. Enable

    Auto pagination

    Check box

    Default Value: Deselected

    Checkbox

    Select to get the complete result set of the items.

    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. This property enables you to set Required. This property enables you to set

     

    Connection Timeout*

    Default Value: 30
    Example: 40

    Integer

    Specify the connection timeout duration in seconds.

    3030

    Number of retries

    Integer

    Number of Retries*

    Default Value: 3
    Example: 5

    Integer

    Specify the maximum number of

    retries

    reconnections in case of a connection failure or timeout.

    33

    Retry

    interval Required. This property enables you to set

    Interval (seconds)*

    Integer

    Snap Execution

    String

    Specifies the

    Default Value: 10
    Example: 11

    Integer

    Specify the time interval in seconds between connection attempts.

    1010

    Snap Execution

    Default Value: Validate & Execute
    Example: Execute only

    Dropdown list

    Specify the required Pipeline execution type:

    • Validate & Execute

    : Performs

    • . 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

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

    • Disabled

    : Disables

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

    Execute only

    Validate & Execute
    Info

    For more information on how to get the metadata of an item in the SharePoint Online

    ...

    , refer to the graph API

    ...

    in list-document-library.

    Troubleshooting

    Error

    Reason

    Resolution

    Either source/target drive (WrongDriveName) is not found in the tenant

    Entered document library might not be available in the tenant

    Click the suggestion drop-down button and select the entity or enter the existing one manually.

    Forbidden exception

    Either user or app doesn'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

    Retrieving Document Library

    This example demonstrates to you on how to retrieve the document library metadata of a site. The 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 - Get Document Library Snap to get document library metadata is shown as below.Image Removed

    ...

    After successful validation or execution of the successfully validating/executing the above Snap,  the the results display in the following output preview.Image Removed

    ...

    Download this Pipeline. 

    Downloads

    Noteinfo
    title

    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

    Snap Pack History

    Expand

    Insert excerpt
    SharePoint Online Snap Pack
    SharePoint Online Snap Pack
    nameSharePoint Online SPH
    nopaneltrue

    See Also

    ...

    Related Content

    ...

    ...