Versions Compared

Old Version 16

changes.mady.by.user Kalpana Malladi

Saved on

compared with

New Version 17

changes.mady.by.user Amritesh Singh

Saved on

Key

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

In this article

Table of Contents
minLevel1
maxLevel3

Overview

You can use this Snap to retrieve specific metadata information of a specific site and retrieve the sub-sites of the selected site.

...

Snap Type

SharePoint Online - Get Sites is a Read-type Snap that enables you to get the list of sites specific to the logged-in user from the SharePoint Online site. You can also:

  • retrieve specific metadata information of a specific site.

  • retrieve the sub-sites of the selected site. (Optional)

For more information about how to get the metadata of an item in the SharePoint Online, refer to the list-document-library in Graph API documentation.

...

Prerequisites

  • Valid SharePoint Online tenant and associated site.

  • Valid application in Azure portal 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

Field Name

Field Type

Field Dependency

Description

Default Value

Example 

Label*

String

N/A

View Type

View 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

A document containing the metadata information that needs to get the document library metadata.

Output

Document

  • Min: 1

  • Max: 1Mapper Snap

  • Copy Snap CSV Parser

  • JSON Parser

A document containing the metadata of the document library or a complete list of document libraries in the mentioned site.

Error

Snap Settings

Field names marked with an asterisk ( * ) are mandatory.

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 when 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 Dependency

Field Type

Description

Label*

Default Value: SharePoint Online - Get Sites
Example: SharePoint Online - Get Sites

N/A

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.

N

Site

String/Expression/Suggestion

Site*

Default Value: N/A

SharePoint Online - Get Sites

Example: MySite

Enables Enumerate subsites checkbox.

String/Expression

Specify

the

the name of a site

to get the metadata information.

N/A

MySite

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

Enumerate subsites

CheckboxString/Expression

Default Value: Deselected

Enabled when you specify or select a value in the Site field.

Checkbox

Select this checkbox to get a collection of subsites available for a site.

Not selected

 N/A

Search query*

Top

Integer/Expression

Search Query*

Default Value: *
Example: micro*dev AND (performance OR process) NOT sales

Enabled when you select the Enumerate subsites checkbox.

String/Expression

Specify keywords that match with one or more site names, as needed. The Snap searches and returns matching sites.

This field is hidden if you select a specific site to retrieve the metadata information.

*

micro*

dev AND (performance OR process) NOT sales

Top

Default Value: 200
Example: 500

Enabled when you select the Enumerate subsites checkbox.

Integer/Expression

Specify the number of records to be read from the matched search results.

200

500

Auto

paginationCheckbox

Pagination

Default Value: Deselected

N/A

Checkbox

Select this checkbox to retrieve all matching site names as a paginated list.

If you select the Auto Pagination checkbox, the Top field is hidden.

Not selected

 Selected

Connection details

Use this field set to

define

specify connection

parameters

properties to

access

the SharePoint Online

. This field set contains the following fields:

APIs. 

Connection timeout

  • Number of retries

  • Retry interval (seconds)

    • Connection timeout*

    Integer

    *

    Default Value: 30
    Example: 40

    N/A

    Integer

    Specify the connection timeout duration in seconds.

    30

    30

    Number of retries*

    Integer

    Default Value: 0
    Example: 5

    N/A

    Integer

    Specify the maximum number of

    retries

    reconnections in case of a connection failure or timeout.

    1

    3

    Retry interval (seconds)*

    Integer

    Default Value: 1
    Example: 11

    N/A

    Integer

    Specify the time interval in seconds between connection attempts.

    0

    10

    Snap Execution

    Dropdown list

    Default Value: Validate & Execute
    Example: Execute only

    N/A

    Select one of the three modes in which the Snap executes. Available options are

    Dropdown list

    Specify the required Pipeline execution type:

    • Validate & Execute

    : Performs

    • . Performs limited execution of the Snap

    , and generates a data preview

    • (up to 50 records) during Pipeline validation

    . Subsequently,

    • ; performs full execution of the Snap (unlimited records) during Pipeline

    runtime

    • execution.

    • Execute only

    : Performs

    • . Performs full execution of the Snap during Pipeline execution

    without generating preview data

    • ; does not execute the Snap during Pipeline validation.

    • Disabled

    : Disables

    • . Disables the Snap and

    all Snaps that are downstream from it.

    Execute only

    Validate & Execute

    • , by extension, its downstream Snaps.

    Info

    For more information about how to get the metadata of an item in the SharePoint Online, refer to the list-document-library in Graph API documentation.

    Troubleshooting

    Error

    Reason

    Resolution

    Site name {siteName} is not found in the tenant.

    The site name that you have entered is not available in the tenant.

    Click the Suggestion (blue star) icon and select the site or enter a valid site name manually.

    Forbidden exception.

    Either the user or the app does not have sufficient permissions to read the metadata for the document library.

    Ensure that you provide both user-level and app-level permissions required to access the metadata.

    ...

    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, *.zip

    ...