In this article
Use this Snap to download files from a OneDrive or Shared Library (document library) location to the system (SLDB or a Snaplex folder).
- 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.
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
|Input/Output||Type of View||Number of Views||Examples of Upstream and Downstream Snaps||Description|
|A document containing the location details of a file to download from a OneDrive or Shared Library (document library) location to the system (SLDB or a Snaplex folder).|
A document containing the result of the download operation (the file name and the path/location from which the file is downloaded.
|Parameter Name||Data Type||Description||Default Value||Example |
Specify a 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.
|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.
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.
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.
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.
|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.
Relative Path and ID
- 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.
|Download File As PDF||Check box|
Select this check box to download the file from the specified location as a PDF file.
Limitations on PDF Downloads
Not all files can be downloaded as PDF. This depends on whether the file supports PDF conversion.
|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||Execute only|
The resource is not found.
An invalid file is passed (not a 34-character alphanumeric code such as 014ZXBQNNHW2DJ3CDKQZBJHRYWFWVRRQA2).
|Ensure that you provide a valid item ID for your file.|
"400 : Bad Request : Invalid request".
|An invalid item ID is passed for your file in the Source Relative Path/ID field.||Ensure that you provide a valid path for the file to be downloaded.|
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.
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.
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.
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 this Pipeline.
Important Steps to Successfully Reuse Pipelines
- Download and import the Pipeline into SnapLogic.
- Configure Snap accounts as applicable.
- Provide Pipeline parameters as applicable.
Snap Pack History