Check Out File

In this article

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/OutputType of ViewNumber of ViewsExamples of Upstream and Downstream SnapsDescription
Input 

Document

  • Min: 0
  • Max: 1
  • Mapper
  • Copy
  • Upload File
A document containing the details of the file to be checked out.
Output

Document

  • Min: 1
  • Max: 1
  • Mapper
  • Filter
  • Check In File
  • Download File
  • Share Item

A document containing the result of the check out operation.

Snap Settings

Parameter NameData TypeDescriptionDefault ValueExample 
LabelString
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.
Check Out FileCheck Out File
Shared LibraryString/Expression/SuggestionRequired. Select the Shared Library where the file to be checked out exists, from the list of suggestions provided.N/AMy Library
Drive

String/Expression/Suggestion

Required. Select the Drive where the file to be checked out exists, from the list of suggestions provided.N/ADocuments
Source Relative Path/IDString/Expression

Required. Enter the relative path for the file to be checked out, beginning with root:/. Alternatively, pass the item 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.
  • When the driveItem ID passed is invalid (not a 34-character alphanumeric code such as 014ZXBQNNHW2DJ3CDKQZBJHRYWFWVRRQA2), the Snap returns the error - The resource is not found.
root:/

/Pictures/Tour1/Image01.png

Number Of RetriesString/ExpressionSpecify an integer value to set the maximum number of reconnection attempts that the Snap must perform, in case of connection failure or timeout.03
Retry Interval (Seconds)String/ExpressionEnter, in seconds, the duration for which the Snap must wait between two reconnection attempts, until the number of retries is reached.12
Snap ExecutionDrop-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.

Execute onlyValidate & Execute

Troubleshooting

ErrorReasonResolution

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
You did not enter a file name in Source Relative Path/ID field.

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 SnapOutput

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 SnapOutput

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.

Downloads

Important Steps to Successfully Reuse Pipelines

  1. Download and import the Pipeline into SnapLogic.
  2. Configure Snap accounts as applicable.
  3. Provide Pipeline parameters as applicable.

  File Modified

File Example_MS_OneDrive_Check_Out_Check_In.slp

Mar 01, 2022 by Subhajit Sengupta

Snap Pack History

 Click here to expand...

Release

Snap Pack Version 

Date

Type

Updates

4.29main15993 StableUpgraded with the latest SnapLogic Platform release.
4.28main14627 StableUpgraded with the latest SnapLogic Platform release.
4.27main12833 StableUpgraded with the latest SnapLogic Platform release.
4.26main11181 

Stable

Upgraded with the latest SnapLogic Platform release.
4.25 Patch425patches10571
Latest

Updated the error output view of the OneDrive - Upload File Snap from a Binary view to a Document view.

4.25main9554 StableEnhanced the Update Share Permissions Snap with the Share Type and Expires fields that enable you to update the share permissions on your OneDrive items shared using the Invite or Link option. If the Share type is link, you can specify the expiry date and time for the URL that is used to share permissions.
4.24main8556 
StableNo updates made.

4.23

main73

 

Stable

Initial release of the Snap Pack with the following Snaps and Accounts:


See Also