In this article
| Table of Contents | ||||
|---|---|---|---|---|
|
...
- Works in Ultra Pipelines.
To know the list of Snaps that work in Ultra and the related caveats, see Snap Support for Ultra Pipelines.
Limitations and Known Issues
None.
Snap Input and Output
| Input/Output | Type of View | Number of Views | Examples of Upstream and Downstream Snaps | Description |
|---|---|---|---|---|
| Input | Document |
|
| An input document contains the metadata of the item that can be used in the search item query. |
| Output | Document |
|
| An output document contains the metadata information of items that match the search query. |
...
| Parameter Name | Data Type | Description | Default Value | Example | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Label | String | Required. The 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 ipeline. | N/A | SharePoint Online - Search Item | |||||||||||||
Site | String | Required. The name of a site that contains the list of document library to be used in the subsequent Snap settings. | N/A | MySite | |||||||||||||
| Custom Site Path | Check-box |
| Not Selected | Selected | |||||||||||||
Document Library | String | Required. This property enables you to select a drive representing the top-level container for a file system, such as OneDrive or SharePoint document libraries. This field populates dynamically from different sites via the suggestion drop-down list. You can either choose a document library from suggestion drop-down or enter the entity name manually.
| N/A | Shared Documents | |||||||||||||
Source item relative path | String | Optional. The item resource path that represents a folder stored in a document library. If this property is left empty then the search will be performed at the document library level. | N/A | testFile.pdf | |||||||||||||
| Search query | String | Optional. Specify keywords to be searched. It searches the filenames and content of files in SharePoint Online and finds matching documents. | N/A | ||||||||||||||
Select fields | String | Optional. Enter the comma-separated property names to be returned in the results. | N/A | name, id | |||||||||||||
| Orderby properties | Optional: Enter these properties to perform the order of the result set. The two types of properties are listed below:
| ||||||||||||||||
Property name | String | Enter the name of the property to be sorting order. | N/A | name | |||||||||||||
| Order type | String | Select the appropriate sort order to be performed upon the selected items. Available options are:
| asc | desc | |||||||||||||
| Top | Integer | Optional. Use this property to set the page size of results. | 200 | 500 | |||||||||||||
| Auto pagination | Check box | Optional. To get all items within a single folder item/document directory. If this field is not checked, SharePoint Online will return a maximum of 200 records per page by default. If this field is selected, all matching records will be automatically returned. | Not selected | ||||||||||||||
Connection details | You can use this fieldset to influence connection properties to the SharePoint Online APIs. This fieldset comprises the following fields:
| ||||||||||||||||
Connection timeout | Integer | Required. Enables you to set the connection timeout duration in seconds. | 30 | 30 | |||||||||||||
Number of retries | Integer | Required. Enables you to set the maximum number of re-connections in case of connection failure or timeout. | 3 | 1 | |||||||||||||
Retry interval (seconds) | Integer | Required. Enables you to set the time interval in seconds between connection attempts. | 10 | 10 | |||||||||||||
Snap Execution | String | Specify the required Pipeline execution type:
| Execute only | Validate & Execute | |||||||||||||
...
This example demonstrates how to search for PDF files in the document library. The example assumes that you have configured & authorized a valid SharePoint Online Account (see SharePoint Online Account).
The following screenshot displays the settings of the SharePoint Online - Search Items. This Snap searches all PDFs available in the selected document library and order the output documents based on the item name.
...