In this article

Overview

Use this Snap to create a folder/directory within an existing folder, OneDrive, or Shared Library location.

Prerequisites

Support for Ultra Pipelines

Works in Ultra Pipelines

Limitations

None.

Known Issues

Snap Input and Output

Input/OutputType of ViewNumber of ViewsExamples of Upstream and Downstream SnapsDescription
Input 

Document

  • Min: 0
  • Max: 1
  • Mapper 
  • Copy
  • Get Permissions
A document containing information on the location to create a folder.
Output

Document

  • Min: 1
  • Max: 1
  • Mapper
  • Create Folder
  • Copy Item
  • Share Item

A document containing the result of the Create Folder operation.

Snap Settings

Parameter NameData TypeDescriptionDefault ValueExample 
LabelString
Create FolderNew Folder for Doc files
Drive TypeDrop-down list

Required. Select a drive type from the following list of permitted driveTypes in this drop-down list (to create the folder) and specify the corresponding details needed:

  • OneDrive. To create a folder in a OneDrive location. Requires UserDrive, and Source Relative Path/ID.
  • documentLibrary. To create a folder in a shared library (document library) location. Requires Shared LibraryDrive, and Source Relative Path/ID.
  • DriveTo create a folder in a drive (in user's OneDrive or shared library) using the source Drive ID. Requires Drive (ID) and Source Relative Path/ID.
  • All. To create a folder in a drive from the list of all drives and shared libraries (including SharePoint sites) that you can access. Requires User, Drive, and Source Relative Path/ID.
OneDrivedocumentLibrary
UserString/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 create the folder in 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/ASnap Team:snap@snaplogic.net
Shared LibraryString/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 create the folder in 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/ANewSharedLibrary
DriveString/Expression/Suggestion

Required for all Drive Type options.

Specify the name of the drive to create the folder in. 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 create the folder in, 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/AOneDrive
Source Relative Path/IDString/Expression

Required for all Drive Type options.

Enter the relative path for the driveItem where the folder must be created, beginning with root:/. Alternatively, pass the item 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://Pictures/Tour1/
Folder NameString/ExpressionRequiredEnter the name for the new folder.N/ADoc_Files
Conflict behaviorDrop-down list

Required. Select one of the following options from this drop-down list to define how the Snap must deal with a conflict while creating the folder — a folder with the same name exists in the selected location.

  • replace. To replace the existing folder having the same name with the new folder created.
  • fail. To abort the create folder operation and return an appropriate error.
  • rename. To create the folder with a slightly different name based on OneDrive's conflict management mechanism.
replacerename
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
The resource is not found.


An invalid driveItem ID is passed (not a 34-character alphanumeric code such as 014ZXBQNNHW2DJ3CDKQZBJHRYWFWVRRQA2).

Ensure that you provide a valid item ID for your folder.


"400 : Bad Request : Invalid request".An invalid item ID is passed in the Source Relative Path/ID field.Ensure that you provide a valid path to your folder that will be created in OneDrive.

Examples

Working with Drive Items (Folders and Files) in OneDrive

Example title must be gerunds in title case.

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 SnapOutput

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

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

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

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

Provide links to the endpoint's official documentation, any relevant or related internal documentation, and any other links you have referred to on this page. Care should be taken when referencing external sites/documentation that it is an official site/documentation. Do not refer to forums such as stackoverflow.