SharePointListAttachmentConnector

Connects to a SharePoint list item to manage attachments.

Typical Uses

Attaching files to SharePoint list items
Updating or deleting existing attachments
Listing attachment metadata for validation or logging
Downloading attachments for local storage or further processing

How does it work?

The SharePointListAttachmentConnector connects to a SharePoint list item to perform various tasks:

Action	Task
Add	Upload a new attachment.
Delete	Delete a list item’s attachments.
Download	Download an attachment.
List	List attachment details.
Update	Replace an attachment.

Once valid account credentials have been provided, you may browse to available content for the selected Action.

Usage Notes

SharePoint list item attachments have a maximum size of 250 MB.
The format attributes from the Microsoft SharePoint Online List reader (such as sharepointlist_site_url, sharepointlist_list_id, sharepointlist_item_id) may be useful for setting parameters in the SharePointListAttachmentConnector.
The following characters are not allowed in SharePoint file names: " * : < > ? / \ |
Depending on user settings, % and # may not be allowed in SharePoint file names. See New support for # and % in SharePoint Online and OneDrive for Business.

Configuration

Input Ports

Output Ports

Output

Features with added attributes, as specified in parameters and according to Action:

Action	Output - Input-Driven	Output - Run Once
Add	Input feature with details about the new item.	New feature with details about the new item.
Delete	Input feature with details about deleted attachments.	New feature with details about deleted attachments.
Download	Input feature with details about the downloaded attachment.	New feature with details about the downloaded attachment.
List	Multiple features, one for each attachment on the specified list item, with details about the attachments.	Multiple new features, one for each item in the specified location, with details about the items.
Update	Input feature with details about the updated attachment.	New feature with details about the updated attachment.

Parameters

List Item

Identifier	Select a type of SharePoint item identification: ID URL
Site	When Identifier is ID, provided the SharePoint site URL, typically in this form: https://myorganization.sharepoint.com/sites/MySite https://myorganization.sharepoint.com/sites/MySite/MySubSite Site URLs can be obtained using the format attribute sharepointlist_site_url from the Microsoft SharePoint Online List reader.
List	When Identifier is ID, specify the SharePoint List that the item belongs to. List IDs can be obtained using the format attribute sharepointlist_list_id from the Microsoft SharePoint Online List reader.
ID	When Identifier is ID, specify the Item ID. Item IDs can be obtained using the format attribute sharepointlist_item_id from the Microsoft SharePoint Online List reader.
URL	When Identifier is URL, provide the URL of the SharePoint item, typically in this form: https://myorganization.sharepoint.com/sites/MySite/Lists/MyList/DispForm.aspx?ID=1

Action > Add

Data Source

Upload

Select the source type:

Attribute: Upload the contents of an attribute.
File: Upload a file.

Note that when working with large objects, File is generally the better choice as the data will be read from disk and not need to be held in memory.

File to Add

When Upload is File, specify the file to be uploaded.

Attribute to Add as File

When Upload is Attribute, specify the attribute containing the content for upload.

Add Options

Add with Filename

When Upload is Attribute, specify the filename, including extension, to contain the uploaded content.

If Attachment Exists

Attachment filenames must be unique. Select a method of handling filenames that already exist:

Reject: Leave the existing attachment intact and output the feature via the <Rejected> port.
Overwrite: Delete attachment with existing filename and upload new attachment.

Added Attributes

Output features will receive these attributes:

_attachment_server_relative_url	The URL of the newly added attachment.
_attachment_filename	The filename of the newly added attachment.

Action > Delete

Request

Delete All

Select an option for attachment deletion:

Yes: Delete all existing attachments.
No: Delete a specific attachment.

List Item

Attachment Filename

When Delete All is No, specify the filename of the attachment to delete.

Added Attributes

Output features will receive these attributes:

_attachment_filename	Name of attachment deleted, when Delete All is No.
_total_attachments	Total number of attachments on the list item, when Delete All is Yes.
_attachments_deleted	Total number of attachments deleted, when Delete All is Yes.
_deletion_errors	List of attachments that were not deleted successfully with their respective errors, when Delete All is Yes.

Action > Download

List Item

Attachment Filename

Specify the filename of the attachment to download.

Destination

Download as	Select a destination type for downloaded items: Attribute: The downloaded object will be stored in the specified attribute. File: The downloaded file will be stored in the specified folder.
Download to Folder	When Download as is File, specify the path to the folder that will store the downloaded attachment.
If File Exists	When Download as is File, select a method for handling existing files: Reject: Leave the existing file intact and output the feature via the <Rejected> port. Overwrite: Overwrite the existing file.
Download to Attribute	When Download as is Attribute, specify the attribute to contain the contents of the downloaded attachment.

Added Attributes

Output features will receive these attributes:

_downloaded_path	The local path where the downloaded attachment is saved, when Download as is File .
_filename	The filename of the downloaded file.
_file_size	The size of the downloaded file in bytes.
_content_type	The MIME type of the downloaded file.

Action > List

Output Attributes

Attributes to Add

Select any available attributes to be included on the output features:

_attachment_filename	The original filename of the attachment.
_attachment_size	The size of the attachment in bytes.
_attachment_server_relative_url	The Server Relative URL of the attachment. This is the relative URL of the attachment file based on the URL for the server. See File.ServerRelativeUrl property .
_attachment_created	The datetime when the attachment was created, in ISO format.
_attachment_author	The author of the attachment.
_attachment_last_modified	The datetime when the attachment was last modified, in ISO format.
_attachment_modified_by	The user who last modified the attachment.
_content_type	The MIME type of the attachment (e.g., image/png).

Action > Update

List Item

Attachment Filename

Specify the filename of the attachment to update.

Data Source

Upload

Select the source type:

File: The specified file will be uploaded as the new content.
Attribute: The contents of the specified attribute will be uploaded as the new content.

Note that when working with large objects, File is generally the better choice as the data will be read from disk and not need to be held in memory.

File to Add

When Upload is File, specify the file to be uploaded.

Attribute to Add as File

When Upload is Attribute, specify the attribute containing the content for upload.

Update Options

Add with Filename

When Upload is Attribute, specify the filename, including extension, to contain the updated content.

Added Attributes

Output features will receive these attributes:

_attachment_server_relative_url

The Server Relative URL of the attachment. This is the relative URL of the attachment file based on the URL for the server.

See File.ServerRelativeUrl property .

_attachment_filename

The filename of the updated attachment.

Editing Transformer Parameters

Transformer parameters can be set by directly entering values, using expressions, or referencing other elements in the workspace such as attribute values or user parameters. Various editors and context menus are available to assist. To see what is available, click beside the applicable parameter.

How to Set Parameter Values

Defining Values

There are several ways to define a value for use in a Transformer. The simplest is to simply type in a value or string, which can include functions of various types such as attribute references, math and string functions, and workspace parameters.

Using the Text Editor

The Text Editor provides a convenient way to construct text strings (including regular expressions) from various data sources, such as attributes, parameters, and constants, where the result is used directly inside a parameter.

Text Editor

Using the Arithmetic Editor

The Arithmetic Editor provides a convenient way to construct math expressions from various data sources, such as attributes, parameters, and feature functions, where the result is used directly inside a parameter.

Arithmetic Editor

Conditional Values

Set values depending on one or more test conditions that either pass or fail.

Parameter Condition Definition Dialog

Content

Expressions and strings can include a number of functions, characters, parameters, and more.

When setting values - whether entered directly in a parameter or constructed using one of the editors - strings and expressions containing String, Math, Date/Time or FME Feature Functions will have those functions evaluated. Therefore, the names of these functions (in the form @<function_name>) should not be used as literal string values.

Content Types

String Functions	These functions manipulate and format strings.
Special Characters	A set of control characters is available in the Text Editor.
Math Functions	Math functions are available in both editors.
Date/Time Functions	Date and time functions are available in the Text Editor.
Math Operators	These operators are available in the Arithmetic Editor.
FME Feature Functions	These return primarily feature-specific values.
FME Parameters	FME and workspace-specific parameters may be used.
Creating and Modifying User Parameters	Create your own editable parameters.

Dialog Options - Tables

Table Tools

Transformers with table-style parameters have additional tools for populating and manipulating values.

Row Reordering

Enabled once you have clicked on a row item. Choices include:

Add a row
Remove a row
Move current row up one
Move current row down one
Move current row to top
Move current row to bottom

Cut, Copy, and Paste

Enabled once you have clicked on a row item. Choices include:

Cut a row - delete and copy to clipboard
Copy a row to the clipboard
Paste a row from the clipboard

Cut, copy, and paste may be used within a transformer, or between transformers.

Filter

Start typing a string, and the matrix will only display rows matching those characters. Searches all columns. This only affects the display of attributes within the transformer - it does not alter which attributes are output.

Import

Import populates the table with a set of new attributes read from a dataset. Specific application varies between transformers.

Reset/Refresh

Generally resets the table to its initial state, and may provide additional options to remove invalid entries. Behavior varies between transformers.

Note: Not all tools are available in all transformers.

For more information, see Transformer Parameter Menu Options.

Reference

Processing Behavior	Feature-Based
Feature Holding	No
Dependencies	SharePoint Online Account
Aliases
History

FME Online Resources

The FME Community and Support Center Knowledge Base have a wealth of information, including active forums with 35,000+ members and thousands of articles.

Search for all results about the SharePointListAttachmentConnector on the FME Community.

Examples may contain information licensed under the Open Government Licence – Vancouver, Open Government Licence - British Columbia, and/or Open Government Licence – Canada.