In this article
| Table of Contents | ||||
|---|---|---|---|---|
|
Overview
Use this Snap to check out an file/document in the shared library for editing. Ensure that you use the same account to check in (commit changes to) this file/document after editing it.
Prerequisites
- A valid application in Azure Portal with appropriate permissions.
- A valid Microsoft OneDrive license.
- Write access on the file to be updated (folder/file location mentioned in the Source Relative Path/ID).
- The file to be checked out is in a Shared Library (accessible to multiple users)
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
| Input/Output | Type of View | Number of Views | Examples of Upstream and Downstream Snaps | Description |
|---|---|---|---|---|
| Input | Document |
|
| A document containing the details of the file to be checked out. |
| Output | Document |
|
| A document containing the result of the check out operation. |
Snap Settings
| Parameter Name | Data Type | Description | Default Value | Example | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Label | String |
| Check Out File | Check Out File | ||||||||
| Shared Library | String/Expression/Suggestion | Required. Select the Shared Library where the file to be checked out exists, from the list of suggestions provided. | N/A | My Library | ||||||||
| Drive | String/Expression/Suggestion | Required. Select the Drive where the file to be checked out exists, from the list of suggestions provided. | N/A | Documents | ||||||||
| Source Relative Path/ID | String/Expression | Required. Enter the relative path for the file to be checked out, beginning with root:/. Alternatively, pass the item ID in this field.
| root:/ | /Pictures/Tour1/Image01.png | ||||||||
| 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:
| Execute only | Validate & Execute |
Troubleshooting
| Error | Reason | Resolution |
|---|---|---|
Error while Check out a file with relativePath : root:/, Reason: 500 : Internal Server Error : An unspecified error has occurred. | The file specified in the Source Relative Path/ID field is not found. OR | Verify and ensure that you have provided a valid file name in the Source Relative Path/ID field. |
Examples
Checking out and checking in 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 |
 |
Downloads
| Note | ||
|---|---|---|
| ||
|
| Attachments | ||
|---|---|---|
|
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
...