In this article

Overview

Use this Snap to copy items from a OneDrive or Shared Library (document library) location to another location in OneDrive or Shared Library.

Prerequisites

• A valid application in Azure Portal with appropriate permissions.
• A valid Microsoft OneDrive license.
• Write access to both source and target locations (folders).

Support for Ultra Pipelines

Works in Ultra Pipelines. 

Limitations

Copying files larger than 10 MB using this Snap fails when you specify a new name for saving the file. This is an issue that Microsoft has acknowledged. The work around is to:

• Copy your large files using the Copy Item Snap to a temporary location in your OneDrive, with the same name.
• Rename and move it to your target location using the Move Item Snap.
• When copying large folders/files (10,000 or more) in OneDrive, if there is an unexpected asynchronous call return from the API, the Snap doesn’t fail instead displays a warning message in the output: An invalid status was retrieved from the asynchronous call: 'null'. Learn more: https://learn.microsoft.com/en-us/onedrive/developer/rest-api/resources/asyncjobstatus?view=odsp-graph-online.

  This results in the specific folder or file associated with the error not being copied, and the Snap continues to copy the remaining records. Therefore, we recommend you to verify the copied documents and check the warning message where you can view the uncopied items, if any. Learn more on how to do so using the following example pipelines:

  • Copy 10,000 documents using Copy Item Snap

  • Check warning messages encountered while copying

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.
• The Snap copies the item to the root folder when you provide invalid Target Relative Path/ID (without root:/). However, the Snap works as expected (throws an exception) when you provide an invalid Target Relative Path/ID that begins with root:/. We recommend that you ensure that the Target Relative Path/ID always resolves to a valid folder.

Snap Input and Output

Snap Settings

Examples

Working with Drive Items (Folders and Files) in OneDrive

Microsoft's OneDrive and SharePoint dialects treat files and folders as drive items for all the similar operations (CRUD) they allow. Microsoft OneDrive Snap Pack provides multiple Snaps to perform these operations. This Pipeline demonstrates some of these operations - Creating folders, copying items, moving items, and deleting items. It assumes that you have configured your Azure application and the Snap accounts already. The Pipeline uses the following parameters. 

We use the Create Folder Snap to create a new folder in the OneDrive (or Shared Library) location. Next, we use a Copy Item Snap to create a copy of an existing item in another folder/shared location. The Delete Item Snap removes an item from the source location. The Move Item Snap moves the copied item back to its source location. We also use a Mapper Snap to feed required information to the Move Item Snap.

Create Folder Snap
Output

Now, we copy the newly created folder (mentioned in Source Relative Path/ID field) to another target location (Target Relative Path/ID) using the Copy Item Snap.

Copy Item Snap
Output

Let us delete the original folder from the first source location using the Delete Item Snap. Notice the value/expression used in Source Relative Path/ID field in this Snap.

Delete Item Snap	Output

The output for the Delete Item Snap displays the summary of the delete operation. We use a Mapper Snap to return the name of the item and pass it to the Move Item Snap.

As the last step, let us connect a Move Item Snap to move the copied item (in the old target location) back to its original location (target location for the Move Item Snap). To do so, we capture this name of the item and pass it to the Move Item Snap as the source item detail.

Move Item Snap	Output

Upon completion of the task of moving items, the Snap provides the details of the driveItem that was moved to its original location.

Download this Pipeline. 

Copy 10,000 documents using Copy Item Snap

The following example pipeline demonstrates how to copy a large number of folders/files (10,000 in this example). This example assumes you have configured the necessary accounts and prerequisites in SnapLogic.

Download this pipeline.

1. Configure the Sequence Snap with 10,000 documents to generate a sequence of numbers from 1 to 10,000 to create unique folder names.
2. Configure the Create Folder Snap to create a new folder for each sequence number in the OneDrive location. On validation, the Snap displays the paths of the newly created folders with additional details.

2. Configure the JSON Parser Snap to parse the binary data read by the File Reader Snap. On validation, the Snap displays the contents of the parsed JSON data as a document downstream for further use in the pipeline.

3. Configure the Filter Snap with the filter expression $warningMessage != null to filter out the JSON data to show only those that contain warning messages. This allows you to focus on issues encountered during the copying process. On validation, the Snap displays the filtered warning messages, detailing any issues encountered so you can take further action to troubleshoot.

Downloads

Snap Pack History

See Also

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