SharePoint Online - Upload File

In this article

Overview

You can use this Snap to upload a new file or update the content of an existing file in the SharePoint Online site.

Snap Type

SharePoint Online - Upload File is a Write-type Snap.

Prerequisites

  • Valid SharePoint Online tenant and associated site.

  • Valid Azure application with all the required API permissions.

Support for Ultra Pipelines

Works in Ultra PipelinesTo 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 Views

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

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

  • JSON Parser

A document containing the metadata of the uploaded file.

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 when 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

  • Asterisk (*): Indicates a mandatory field.

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

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

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

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

Field Name

Field Type

Description

Field Name

Field Type

Description

Label*

 

Default ValueSharePoint Online - Upload File
ExampleSharePoint Online - Upload File

String

Specify a unique 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.

Site*

 

Default Value: N/A
ExampleMySite

String/Expression

Specify the name of a site which contains the list of document library to be used in the subsequent Snap settings.

Custom Site Path

 

Default ValueDeselected

Checkbox

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

Document Library*

 

Default Value: N/A
ExampleShared Documents

String/Expression

Specify the drive representing the top-level container for a file system, such as OneDrive or SharePoint document libraries. This field will be populated dynamically from different sites from the suggestion dropdown list. You can either choose a document library from suggestion drop-down list or enter the entity name manually.

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

Target path*

 

Default Value: N/A
Exampletest.file.pdf

String/Expression

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

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

Conflict Behavior

 

Default Valuereplace
Examplefail

String/Expression

Select the appropriate action to be taken in case the specified name already exists. Available options are:

  • replace

  • rename

  • fail

Connection details

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

Connection timeout*

 

Default Value30
Example40

Integer

Specify the connection timeout duration in seconds.

Number of retries*

 

Default Value3
Example5

Integer

Specify the maximum number of reconnections in case of a connection failure or timeout.

Retry interval (seconds)*

 

Default Value10
Example11

Integer

Specify the time interval in seconds between connection attempts.

Snap Execution

 

Default ValueValidate & Execute
ExampleExecute 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.

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

Troubleshooting

Error

Reason

Resolution

Error

Reason

Resolution

The specified listName/itemID was not found

Entered listname/itemID might not be available in the site

Click the suggestion dropdown button and select the listName or enter the existing list name manually or verify the itemID is entered existence.

Forbidden exception

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.

Examples

Uploading a File

This example demonstrates how to upload binary data to the specified item path in the SharePoint Online site. The example assumes that you have configured and authorized a valid SharePoint Online Account. For more information, refer to SharePoint Online Account.

The following screenshot displays the settings of the Share Point Online - Upload File Snap. The Snap specifies uploading the item to the site.

After successfully validating/executing the above Snap, the following results displays in the output preview.

Download this Pipeline.

Downloads

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.

  File Modified

File Example_Sharepoint_Upload_Basic.slp

Mar 11, 2022 by Subhajit Sengupta

Snap Pack History