In this article

The page's title should always be the Snap's name.  For example, File Reader. 

Overview

Use this Snap to download files from a OneDrive or Shared Library (document library) location to the system (SLDB or a Snaplex folder).

Provide a functional overview of the Snap. Do not mention anything about the Snap's internal technology or techniques. The user should be able to understand what the Snap. Include a screenshot of a well-configured Snap 600px.  

Prerequisites

• A valid application in Azure Portal with appropriate permissions.
• A valid Microsoft OneDrive license.
• Read access on the folder location mentioned in the Source Relative Path/ID.

Support for Ultra Pipelines

Works in Ultra Pipelines.

Limitations

None.

Known Issues

Snaps in the Microsoft OneDrive Snap Pack have an in-built retry mechanism for failing connections and requests; but, a high volume of requests from a client might reach the throttling threshold. In such scenarios, the Microsoft Graph limits further requests from that client for a period of time and returns an HTTP status code 429 (Too many requests), thereby causing the requests to fail. Hence, we recommend you to keep a check on the number of requests emanating from your client instance.

Snap Input and Output

Snap Settings

Parameter Name	Data Type	Description	Default Value	Example
Label	String		Download File	Download File
Drive Type	Drop-down list	Required. Select a drive type from the following list of permitted driveTypes in this drop-down list (to locate the file to download) and specify the corresponding details needed: OneDrive. To download a file from the source OneDrive location. Requires User, Drive, and Source Relative Path/ID. documentLibrary. To download a file from a shared library (document library) location. Requires Shared Library, Drive, and Source Relative Path/ID. Drive. To download a file from a drive (in user's OneDrive or shared library) using the Drive ID. Requires Drive (ID) and Source Relative Path/ID. All. To select a drive from the list of all drives and shared libraries (including SharePoint sites) that you can access, and download a file from that location. Requires User, Drive, and Source Relative Path/ID.	OneDrive	documentLibrary
User	String/Expression/Suggestion	Required for Drive Type options - OneDrive and All. Not needed for Drive and documentLibrary. Select a user from the suggested list of users to download a file from that user's OneDrive location. The list of users displayed varies based on your access to their OneDrive locations. This option is meant for administrator users who are authorized to manage other users' drives, as well.	N/A	Snap Team:snap@snaplogic.net
Shared Library	String/Expression/Suggestion	Required for Drive Type option - documentLibrary. Not needed for OneDrive, Drive, and All. Select a shared library from the suggested list of libraries to download a file from that library location. The list of shared libraries displayed varies based on your access to them. This option is meant for users who have write access on both the source and target shared libraries.	N/A	NewSharedLibrary
Drive	String/Expression/Suggestion	Required for all Drive Type options. Specify the name of the drive to download a file from it. The suggestions for this field are based on the Snap account and the User or Shared Library selected. For the Drive Type Drive, specify/pass the ID of the drive to download a file from it, typically from the upstream Snap. For the drive type All, select a drive from the OneDrive or a Shared Library drive. Specify the Source Relative Path/ID of the driveItem, next.	N/A	OneDrive
Source Relative Path/ID	String/Expression	Required for all Drive Type options. Enter the relative path of the file to download from, beginning with root:/. Alternatively, pass the folder ID or its relative path ID in this field. Any URL in this field that starts with root:/ is treated as relative path. All other entries (without root:/ at the beginning) are treated as driveItem IDs.	root:/	/myprojects/myfile.xlsx
Download File As PDF	Check box	Select this check box to download the file from the specified location as a PDF file.  Not all files can be downloaded as PDF. This depends on whether the file supports PDF conversion.	Not selected	Selected
Number Of Retries	String/Expression	Specify an integer value to set the maximum number of reconnection attempts that the Snap must perform, in case of connection failure or timeout.	0	3
Retry Interval (Seconds)	String/Expression	Enter, in seconds, the duration for which the Snap must wait between two reconnection attempts, until the number of retries is reached.	1	2
Snap Execution	Drop-down list	Select one of the three following modes in which the Snap executes: Validate & Execute. Performs limited execution of the Snap and generates a data preview during Pipeline validation, then performs full execution of the Snap (unlimited records) during Pipeline runtime. Execute only. Performs full execution of the Snap during Pipeline execution without generating preview data. Disabled. Disables the Snap and all Snaps downstream from it.	Validate & Execute	Execute only

Troubleshooting

Examples

Using this Snap Pack with Files

This Pipeline demonstrates how you can use the Snaps in the Microsoft OneDrive Snap Pack to upload, check out, check in and download files in an authorized Share Library location. It assumes that you have configured your Azure application and the Snap accounts already. The Pipeline uses the following parameters. 

First, we upload a file to a Shared Library location using File Reader Snap, locate it and check out for editing. Then we check in the updated file and download it.

File Reader Snap
Output

After reading the file from the location provided, we upload the file into a Shared Library (location for Shared files within OneDrive). We configure the Snap to replace existing file with this file, if their file names are same.

Upload File Snap
Output

Now that the file is available in the shared location, let us check out the file for editing. To check out the file, we need to capture the file name. We use a Mapper Snap to extract the file name from the Upload file output view.

We pass the extracted file name along with its location (in shared library) using an expression in the Source Relative Path/ID field, for checking out the file.

Check Out File Snap	Output

The Check Out File Snap provides the name of the checked out file in the $Item field and the result of the check out operation. We use a Mapper Snap again to retrieve this value in $Item and pass it to the Check In File Snap — to check in the same file after it is updated.

In the Check In File Snap, we provide the file details in the Source Relative Path/ID field and an editing comment in the Check In Comment field. This Snap outputs a similar information - $Item and Result of the check in operation.

Check In File Snap	Output

Now, we directly pass the value in $Item field of the output to a Download File Snap to download the file. The Snap downloads the file and returns the location where the file is downloaded. In addition to this, the Snap also relays the (original) output from the previous Snap (Check In File Snap).

Download File Snap
Output

Download this Pipeline.

Add a download link to the Pipeline in the the "Download" text above. Explain the Pipeline/Snap configuration in detail if a complex enough example has been used. Ensure that the functionality you are trying to illustrate is captured correctly. Include caveats as appropriate. To insert link: Press Ctrl + K --> Files --> Select the SLP file corresponding to the example. 

Downloads

Edit the Excerpt Include macro below to link to the Snap Pack page for this Snap page. Ensure that the heading Snap Pack History is not within the Snap Pack's history Excerpt. 

See Also

• Microsoft OneDrive Snap Pack
• Getting Started with SnapLogic
• Snap Support for Ultra Pipelines
• SnapLogic Product Glossary