Versions Compared

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 to provide the contents of upload a new file or update the content of an existing file in a document librarythe SharePoint Online site.

Prerequisites

  • Valid SharePoint Online tenant and associated site.
  • Valid Azure application with all the required API permissions.

...

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/OutputType of ViewNumber of ViewsExamples of Upstream and Downstream SnapsDescription
Input 

Binary

  • Min:1
  • Max:1
  • JSON Formatter
  • File Reader
  • Document to Binary

A Binary stream snap containing the data that need to be uploaded to SharePoint Online site.


Output

Document

  • Min:1
  • Max:1
  • Mapper Snap
  • Copy Snap
  • CSV Parser
  • JSON Parser

A document containing the metadata of the uploaded file.

...

Parameter NameData TypeDescriptionDefault ValueExample 

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

N/A

SharePoint Online - Upload File

Site

String

Required. The name of a site that contains the list of document library to be used in the subsequent settings.

N/A

MySite

Custom Site PathCheck-box

Insert excerpt
SharePoint Online - Get Item
SharePoint Online - Get Item
nopaneltrue

Not SelectedSelected

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. You can choose a document library from the 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.


N/A

Shared Documents

Target path

String

Required. Enter the absolute path of the directory where the file needs to be created.

Note
titleNote

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


N/A

testFile.pdf
Conflict behaviorStringRequired. Select the appropriate action to be taken in case the specified name already exists. Possible values are: replace, rename, and fail.replacerename

Connection details

You can use this fieldset to influence 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 the connection timeout duration in seconds.3030

Number of retries

IntegerRequired. Enables you to set the maximum number of re-connections in case of connection failure or timeout.03

Retry interval (seconds)

IntegerRequired. Enables you to set the time interval in seconds between connection attempts.110

Snap Execution

String

Specifies the 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

...

This example demonstrates how to upload a binary data to the specified item path in the SharePoint Online site. 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 Share Point Online - Upload File Snap. The Snap specifies to uploads the item into the site.

...