Versions Compared

Old Version 16

changes.mady.by.user Siddharth Menon

Saved on

compared with

New Version 23

changes.mady.by.user Leena Gopal

Saved on

Key

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

In this article

Table of Contents
maxLevel2
absoluteUrltrue

Overview

You can use this Snap provides the ability to  to perform a search for the hierarchy of items matching the search query. You can search within a folder hierarchy, a whole drive, or files shared with the current user.Image Removed

...

Snap Type

SharePoint Online - Search Items Snap is a Read-type Snap.

Prerequisites

  • Valid SharePoint

    Valid SharePoint Online tenant and associated site.

  • Valid Azure application with all the required API permissions.

Support for Ultra Pipelines

Works in Ultra Pipelines. Works in Ultra Pipelines

...

To . However, we recommend that you not use this Snap in an Ultra Pipeline. To know the list of Snaps that work in Ultra and the related caveats, see see Snap Support for Ultra Pipelines.

Limitations and Known Issues

None.

Snap

...

Views

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

  • Min: 0

  • Max: 1

  • Mapper

Snap

  • Copy

Snap

  • CSV Parser

  • JSON Parser

An

input document 

input document contains the metadata of the item that can be used in the search item query.


Output

Document

  • Min:

0

  • 1

  • Max: 1

  • Mapper Snap

  • Copy Snap

  • CSV Parser

  • JSON Parser

An output document contains the metadata information of items that match the search query.

Error

Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter when running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab:

  • Stop Pipeline Execution: Stops the current pipeline execution if the Snap encounters an error.

  • Discard Error Data and Continue: Ignores the error, discards that record, and continues with the remaining records.

  • Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

Snap Settings

...

Info

  • Asterisk (*): Indicates a mandatory field.

  • Suggestion icon ((blue star)): Indicates a list that is dynamically populated based on the configuration.

  • Expression icon ((blue star)): Indicates whether the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.

  • Add icon ((blue star)): Indicates that you can add fields in the field set.

  • Remove icon ((blue star)): Indicates that you can remove fields from the field set.

Field Name

Field Type

Description

Label*

Default Value

Example Label

: SharePoint Online - Search Items
Example: SharePoint Online - Search Items

String

Required. The

Specify 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

Pipeline.

NSite

Site*

Default Value: N/A

SharePoint Online - Search Item

Example: MySite

String

Required. The

/Expression

Specify the name of a site

that

which contains the list of document library to be used in the subsequent Snap settings.

N/A

MySite

Custom Site Path

Check-box Insert excerptSharePoint Online - Get ItemSharePoint Online - Get ItemnopaneltrueNot SelectedSelected

Document Library

String

Required. This property enables you to select

Default Value: Deselected

Checkbox

Enable this option if your site URL contains a custom path that deviates from the default site URL. Default site path always has a prefix ‘sites/' before the sitename, a custom site can contain the prefix ‘teams/’ or it can have no prefix.

Document Library*

Default Value: N/A
Example: Shared Documents

String/Expression

Specify the a drive representing the top-level container for a file system, such as OneDrive or SharePoint document libraries. This field

populates

will be populated dynamically from different sites

via

from the suggestion drop-down list. You can either choose a document library from suggestion drop-down list or enter the entity name manually.

Warning

If you enable the Site property as an expression, then the document library is not suggested, resulting in an exception.

NSource item relative path

Source Item Relative Path*

Default Value: N/A

Shared Documents

Example: testFile.pdf

String

Optional. The item resource

/Expression

Specify the item resource path that represents a file, folder, or other item 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.pdfSearch queryStringOptional.

Search Query

Default Value: N/A
Example: pdf

String/Expression

Specify keywords to be searched. It searches the filenames and content of files in SharePoint Online and finds matching documents.

NSelect fields

Select Fields

Default Value: N/A

pdf

Example: id, email, roles

String/Expression

Optional.

Enter the comma-separated

property names

properties to be

returned in the results.N/Aname, idOrderby properties

Optional: Enter these properties to perform the order of the result set. The two types of properties are listed below:

  • Property name
  • Order type

Property name

StringEnter the name of the property to be sorting order.N/AnameOrder typeStringSelect the appropriate sort order to be performed upon the selected items. Available

written to the output view.

Order by Properties

Use this fieldset to Enter the properties and order they want to be displayed when found more one item with one or more similar properties. 

Property name

Default Value: N/A
Example: name

String/Expression

Specify the attribute name of the item/drive/folder to be sorted.

Order type

Default Value: asc
Example: desc

Dropdown list/Expression

Select the appropriate order type to perform the sorting at the server-side. Avaialble options are:

  • asc

  • desc

ascdescTopIntegerOptional. Use this property to set the page size of results.200500Auto paginationCheck boxOptional. To get all items within a single folder item/document directory. If this field is not checked, SharePoint Online will return

Top

Default Value: 200
Example: 100

Integer/Expression

Specify an integer value to define the number of retrieved list items to be displayed per page (pagination).

While providing a value in this field, do not select Auto pagination check box.

Auto pagination

Default Value: Deselected

Checkbox

Select this checkbox to retrieve all items within the selected folder/directory. If not selected (by default), the Snap returns a maximum of 200 records per page

by default

.

If this field is selected, all matching records will be automatically returned.Not selected

While selecting this check box, ensure that the Top field is blank.

Connection details

You can use this fieldset to influence

Use this field set to specify connection properties to the SharePoint Online APIs.

This fieldset comprises the following fields:

 

Connection

timeout
  • Number of retries
  • Retry interval (seconds)

    • Connection timeout

    IntegerRequired. Enables you to set

    Timeout*

    Default Value: 30
    Example: 40

    Integer

    Specify the connection timeout duration in seconds.

    3030

    Number of retries

    IntegerRequired. Enables you to set

    Number of Retries*

    Default Value: 3
    Example: 5

    Integer

    Specify the maximum number of

    re-connections

    reconnections in case of a connection failure or timeout.

    31

    Retry

    interval

    Interval (seconds)*

    Default Value: 10
    Example: 11

    Integer

    Required. Enables you to set

    Snap Execution

    String

    Specify the 

    Specify the time interval in seconds between connection attempts.

    1010

    Snap Execution

    Default Value: Validate & Execute
    Example: Execute only

    Dropdown list

    Specify the required Pipeline execution type:

    • Validate & Execute. Performs limited execution of the Snap (up to 50 records) during Pipeline validation; performs full execution of the Snap

    .

    • (unlimited records) during Pipeline execution.

    • Execute only. Performs full execution of the Snap during Pipeline execution; does not execute the Snap during Pipeline validation.

    • Disabled. Disables the Snap and, by extension, its downstream Snaps.

    Execute only

    Validate & Execute

    Info

    For more information on how to delete an item in the SharePoint Online, refer to the graph API in driveItem-search.

    Troubleshooting

    Error

    Reason

    Resolution

    HTTP Response Code:404

    Entered item not found in the document library.

    Ensure to provide the valid item path to get the metadata.

    Forbidden exception:403

    Either user or app doesn't have sufficient permissions to read the metadata for the document library.

    Ensure to provide the desired permissions both at the user and application level.

    Internal Server Error: 501

    Value for the Property name might have missed.

    Ensure to provide the value for the property name in the

    Orderby properties

    Order by Properties.

    Examples

    Searching for PDF files

    This example demonstrates how to how to search for PDF files in the document library. The example assumes that you have configured & and authorized a valid SharePoint Online Account (see . For more information, refer to SharePoint Online Account).Image Removed

    ...

    The following screenshot displays the settings of the SharePoint 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.Image Removed

    ...

    After successfully validating/executing the above Snap, the results display in the following output preview.Image Removed

    ...

    Download this Pipeline.

    Downloads

    Noteinfo
    title

    Important Steps to Successfully Reuse Pipelines

    1. Download and import the Pipeline into SnapLogic.

    2. Configure Snap accounts as applicable.

    3. Furnish Pipeline parameters as applicable.

    Attachments
    patterns*.slp

    Snap Pack History

    Expand

    Insert excerpt
    SharePoint Online Snap Pack
    SharePoint Online Snap Pack
    nameSharePoint Online SPH
    nopaneltrue

    See Also

    ...

    Related Content

    ...