In this article

The page's title should always be the Snap's name.  For example, File Reader. 

Overview

Use this Snap to search for driveItems by keywords. You can specify the information (fields) you want to view for the search results. You can perform the search operation within your OneDrive as well as your Shared Libraries (document libraries).

Provide a functional overview of the Snap. Do not mention anything about the Snap's internal technology or techniques. The user should be able to understand what the Snap. Include a screenshot of a well-configured Snap 600px.  

Prerequisites

• A valid application in Azure Portal with appropriate permissions.
• A valid Microsoft OneDrive license.
• Read access to the folder/file mentioned in the Source Relative Path/ID.

List all prerequisites for using the Snap as a bullet list. Use direct sentences. For example, in case of a Write-type Snap a prerequisite would be that the user must have write access. Include links to external official documentation, if required. Use "None." if there no prerequisites. 

Support for Ultra Pipelines

Works in Ultra Pipelines.

Limitations

None.

List all Snap-specific limitations as a bullet list. Limitations can be imposed by the Snap's development environment and also by the endpoint's API. List both. Use direct sentences. Include links to external official documentation, if required. Use "None.: if there are no limitations.  

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

Type of view: Document/Binary/Both. Get number of views from the Views tab in the Snap. List at least three compatible Snaps in each category. Provide a brief of the input/output required. If the input/output is optional then preface the description with "Optional." For example, "Transaction data complying with the Orderful schema as a JSON document."

Snap Settings

Parameter Name	Data Type	Description	Default Value	Example
Label	String		Search	DocFiles_Search
Drive Type	Drop-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.	OneDrive	documentLibrary
User	String/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. 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/A	Snap Team:snap@snaplogic.net
Shared Library	String/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. 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/A	NewSharedLibrary
Drive	String/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/A	OneDrive
Source Relative Path/ID	String/Expression	Required for all Drive Type options. Enter the relative path for the driveItem, beginning with root:/, to perform the search. 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. 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/
Search	String/Expression	Required. Enter the keywords to use in the search operation.	N/A	Doc_Files
Include Shared Items	Check 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 selected	Selected
Select Fields	String/Expression	Enter the field names that you want to retrieve in each search result for this search operation. The Snap returns all the available information on each search result, if this field is left blank.	N/A	id, roles
Snap Execution	Drop-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.	Validate & Execute	Execute only

Examples

Using Search Snap to find driveItems in OneDrive

Example title must be gerunds in title case.

This Pipeline demonstrates how you can upload a file into OneDrive and then using the Search Snap to find files with similar name based on keywords. It assumes that you have configured your Azure application and the Snap accounts already. The Pipeline uses the following parameters. 

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
Output

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

Upload File Snap
Output

Upon successful upload, the Snap displays the file's name in the output. We now connect a Mapper Snap to pass the value in this name field to the Search Snap.

In the Search Snap, you can choose to include/exclude items that contain share permissions using the Include Shared Items check box. You can also select the fields to include in the output for each item retrieved in the search results. 

Search Snap
Output

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

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.

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