In this article
Table of Contents | ||||
---|---|---|---|---|
|
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.
...
- 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 | Binary |
|
| A Binary stream snap containing the data that need to be uploaded to SharePoint Online site. |
Output | Document |
|
| A document containing the metadata of the uploaded file. |
...
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 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 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. You can choose a document library from the suggestion drop-down list or enter the entity name manually.
| N/A | Shared Documents | ||||||||
Target path | String | Required. Enter the absolute path of the directory where the file needs to be created.
| N/A | testFile.pdf | ||||||||
Conflict behavior | String | Required. Select the appropriate action to be taken in case the specified name already exists. Possible values are: replace, rename, and fail. | replace | rename | ||||||||
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. | 0 | 3 | ||||||||
Retry interval (seconds) | Integer | Required. Enables you to set the time interval in seconds between connection attempts. | 1 | 10 | ||||||||
Snap Execution | String | Specifies the execution type:
| 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.
...