Skip to end of banner
Go to start of banner

SharePoint Online - Download File

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 19 Next »

In this article

Overview

You can use this Snap to download the content of the primary stream (file) of a item. The Snap writes the binary stream to the output view.

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

  • Filer Writer

  • CSV Parser

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


Output

Document

  • Min: 1

  • Max: 1

  • Mapper

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

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

Site*

Default Value: N/A
ExampleMySite

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 ValueDeselected

Checkbox

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

String/Expression

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

Connection details

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

Connection Timeout*

Default Value30
Example40

Integer

Specify the connection timeout duration in seconds.

Number of Retries*

Default Value3
Example5

Integer

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

Retry Interval (seconds)*

Default Value10
Example11

Integer

Specify the time interval in seconds between connection attempts.

Snap Execution

Default ValueValidate & Execute
ExampleExecute 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.

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 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 download a file and store it in the SnapLogic database. The example assumes that you have configured & authorized a valid SharePoint Online Account (see SharePoint Online Account).

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

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

Download this Pipeline.

Downloads

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.

  File Modified
You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account.
No files shared here yet.
  • Drag and drop to upload or browse for files
  • Snap Pack History

     Click here to expand...

    Release

    Snap Pack Version 

    Date

    Type

    Updates

    May 2024

    main172

    Stable

    Updated and certified against the current SnapLogic Platform release.

    February 2024

    main168

    Stable

    Updated and certified against the current SnapLogic Platform release.

    November 2023

    main155

    Stable

    Updated and certified against the current SnapLogic Platform release.

    August 2023

    main150

    Latest

    Added pagination in the List Read Items Snap. Also added suggestions for the List name field.

    August 2023

    main144

    Latest

    The Upload File Snap now supports files larger than 2 GB.

    August 2023

    main138

    Stable

    Updated and certified against the current SnapLogic Platform release.

    May 2023

    main130

    Stable

    Upgraded with the latest SnapLogic Platform release.

    February 2023

    main114

    09 Feb 2023 

    Stable

    Upgraded with the latest SnapLogic Platform release.

    November 2022

    main113

    10 Nov 2022 

    Stable

    Upgraded with the latest SnapLogic Platform release.

    August 2022

    main111

    11 Aug 2022 

    Stable

    Added the SharePoint Online Application Account type that supports Client Credentials flow.

    4.29

    main108

    14 May 2022 

    Stable

    Upgraded with the latest SnapLogic Platform release.

    4.28 Patches

    main101

    06 Apr 2022 

    Latest

    Fixed the Auto Refresh Token issue in the SharePoint Online Account.

    4.28

    main100

    12 Feb 2022 

    Stable

    Added the SharePoint Online - Get Sites Snap that enables you to get the list of sites specific to the logged-in user from the SharePoint Online site.

    4.27

    main93

    13 Nov 2021 

    Stable

    Upgraded with the latest SnapLogic Platform release.

    4.26

    main89

    30 Aug 2021 

    Latest

    Enhanced all Snaps in the SharePoint Online Snap Pack to support dynamic site and document library values using input document variables.

    4.26

    main88

    14 Aug 2021 

    Stable

    Upgraded with the latest SnapLogic Platform release.

    4.25

    main75

    08 May 2021 

    Stable

    No updates made.

    4.24

    main75

    13 Feb 2021 

    Stable

    No updates made.

    4.23

    main74

    02 Dec 2020 

    Latest

    Fixes the error view issue in SharePoint Online - Upload File Snap by dragging a new instance of SharePoint Online - Upload File Snap to the canvas as the existing Snap that was used with a version that contained the bug will continue to fail.

    4.23

    main74

    16 Nov 2020 

    Latest

    Fixes the socket timeout issue in the Snap Pack by making the following changes:

    • Modifies the code to return the ProxyHttpClient instead of the basic HTTP client and handle the custom siteName.

    • Fixes the broken JUnit and code for pagination in the SharePoint Online - List Read Items Snap.

    4.23

    main73

    15 Nov 2020 

    Latest

    Introduces a new Snap, SharePoint Online - List Read Items Snap, that enables you to read, sort, and filter list items from your SharePoint Online libraries/collections.

    4.22 Patches

    main39

    23 Oct 2020 

    Stable

    Fixes the Snap document link for SharePoint Online - List Read Items.

    4.22-Patches

    422patches6694

    14 Sep 2020 

    Latest

    • Fixes the List Read Snap NPE(null pointer exception) failure, when the List Name field is empty.

    • Fixes the Search Items Snap issue by providing the same result set when more than one document is passed.

    4.22

    main6403

    08 Aug 2020 

    Stable

    No updates made.

    4.21-Patches

    421patches6011

    23 Jun 2020 

    • Latest

    • Stable

    Introduces the productized version of SharePoint Online Snap Pack, which enables organizations to share and manage content and collaborate across an organization

    4.21

    snapsmrc535

    10 May 2020 

    Latest

    Beta release of the SharePoint Online Snap Pack

    Related Content



    • No labels