Versions Compared

Old Version 6

changes.mady.by.user Kalpana Malladi

Saved on

compared with

New Version Current

changes.mady.by.user Kalpana Malladi

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In this article

...

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
  • Get Share Permissions
  • Move Item
A document containing the location and keywords to perform the search operation.
Output

Document

  • Min: 1
  • Max: 1
  • Mapper
  • Sort
  • Unique
  • Get Children
  • Share Item

A document containing the search results (with selected fields data) matching the keywords provided.

...

Parameter NameData TypeDescriptionDefault ValueExample 
LabelString
Insert excerpt
File Writer
File Writer
nopaneltrue
SearchDocFiles_Search
Drive TypeDrop-down list

Required. Select a drive type from the following list of permitted drive types in this drop-down list (to search for driveItems) and specify the corresponding details needed:

  • OneDrive. To search in a OneDrive location. Requires User, Drive, and Source Relative Path/ID.
  • documentLibrary. To search in a shared library (document library) location. Requires Shared Library, Drive, and Source Relative Path/ID.
  • Drive. To search in a drive (in user's OneDrive or shared library) using the Drive ID. Requires Drive (ID) and Source Relative Path/ID.
  • All. To search 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 search within that user's OneDrive location.

Info

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 search within that library location.

Info

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 search 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 search 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.

Specify the relative path for the driveItem, beginning with root:/, to perform the search. Alternatively, pass the item ID in this field.

Info
titleRelative 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/
SearchString/Expression

Required. Enter the keywords to use in the search operation.

Note

This

snap does not return private files in its search results, when an Application account is used for all Drive Types, because private files are not associated with Application accounts

 Snap does not search in private drive items (of individual users) when you use an Application account. To view private drive items from different users' drives in the search results, use a User account instead.


N/ADoc_Files
Include Shared ItemsCheck box

Select this check box to include all items shared with you, into the scope of the search operation. If not selected, the scope of the search is limited to the items you have in your OneDrive.

Not selectedSelected
Select FieldsString/Expression

Specify the field names that you want to retrieve in each search result for this search operation.

Info

The Snap returns all the available information on each search result, if this field is left blank.


N/Aid, roles
Snap ExecutionDrop-down list

Select one of the three modes in which the Snap executes:

  • Validate & Execute. Performs limited execution of the Snap, generates, and then performs 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 the Snaps that are downstream from it.

Validate & ExecuteExecute only

...

Using Search Snap to find driveItems in OneDrive

This example Pipeline demonstrates how you can upload a file into OneDrive and then find files with similar name based on keywords using the Search Snap. 
Prerequisites: Configure your Azure application and the Snap accounts. 

The Pipeline uses the following parameters. 

Image Modified

We begin with reading a file using the File Reader Snap and uploading it to a particular location in your OneDrive account. Then, we capture the name of the uploaded file using a Mapper Snap and feed it into the Search Snap as the search query/keyword. The Search Snap finds for the keyword in the OneDrive/Shared Library location provided and retrieves item names that contain the search keyword.

File Reader Snap
Image Modified
Output
Image Modified

We upload the document in File Reader Snap output to a OneDrive folder using the Upload File Snap.

...