Versions Compared

Old Version 13

changes.mady.by.user Siddharth Menon

Saved on

compared with

New Version 20

changes.mady.by.user Leena Gopal

Saved on

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 download the content of the primary stream (file) of a an item. The Snap writes the binary stream to the output view.Note:

Info

Only driveItems with the file property can be downloaded. If the item to be downloaded is of type folder, the Snap will fail with an exception message “You cannot get content for a folder“.

...

...

Snap Type

SharePoint Online - Download File 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

...

Pipeline. 

...

To know the list of Snaps that work in Ultra and the related caveats, see refer to Snap Support for Ultra Pipelines.

Limitations and Known Issues

None.

Snap

...

Views

JSON

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

  • Min: 0

  • Max: 1

  • Mapper Snap
  • Copy Snap
  • CSV Parser

    • Filer Writer

    • CSV Parser

    An input document contains the metadata of the item to be downloaded.


    Output

    Document

    • Min: 1

    • Max: 1

    • Mapper

    SnapCopy Snap

  • CSV Parser

    • JSON

    Parser

    • Formatter

    An output binary document contains the downloaded 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:

    • 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

    String

    Required. The

    : SharePoint Online - Download File
    Example: SharePoint Online - Download File

    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

    Required. The

    Site*

    Default Value: N/A

    SharePoint Online - Download File

    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

    Custom Site Path

    Check-box

    Multiexcerpt include macro
    nameME_Custom Site Path
    pageSharePoint Online - Get Item

    Not SelectedSelected

    Document Library

    String

    Required. This property enables you to select

    Default Value: Deselected

    Checkbox

    Enable this option if your site URL contains a custom path that deviates from the default site URL. Default site path always has the prefix ‘site/’ before the sitename, a custom site can contain the prefix ‘team/’ 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

    populates

    will be populated dynamically from different sites

    via

    from the suggestion drop-down list. You can either choose a document library from suggestion drop-down list or enter the entity name manually.

    warning

    If you enable the

     

    Site

     

    property as an expression, then the document library

     

    is

    not

    not suggested,

     

    resulting

     

    in an exception

    error

    .

    N

    Source item relative path

    String

    Required. The driveItem resource

    Source item Relative Path*

    Default Value: N/A

    Shared Documents

    Example: testFile.pdf

    String/Expression

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

    /folder

    N/A

    testFile

    .

    pdf

    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. Enables you to set Required. 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 reconnections in case of a connection failure or timeout.

    35

    Retry

    interval

    Interval (seconds)*

    Default Value: 10
    Example: 11

    Integer

    Required. Enables you to set

    Snap Execution

    String

    Specify the 

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

    Validate & Execute

    Validate & Execute

    Info

    For more information on how to download an item in the SharePoint Online, refer to the graph API in driveItem-get-content.

    Troubleshooting

    Error

    Reason

    Resolution

    HTTP Response Code:404

    Entered item not found in the document library

    Please ensure

    Ensure to provide the valid item path to get the metadata.

    Forbidden exception:403

    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.

    HTTP Response Code:404

    You cannot get content for a folder

    Ensure the file path have been provided in the source file path

    Examples

    Downloading a File

    This example demonstrates how to how to download a file and store it in the SnapLogic data basedatabase. The example assumes that you have configured & authorized a valid SharePoint Online Account (see . For more information, refer to SharePoint Online Account).Image Removed

    ...

    The following screenshot displays the settings of the SharePoint SharePoint Online - Download File. The Snap specifies on how to download the content of the item of type file.Image Removed

    ...

    After successfully validating/executing the above Snap, the results display displays 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

    ...

    ...