FME Transformers: 2024.2

Categories
Integrations

Integrations

Web

Web

Workflows

Workflows

Related Transformers
GoogleDriveConnector
OneDriveConnector
S3Connector
Categories
Integrations

Integrations

Web

Web

Workflows

Workflows

Related Transformers
GoogleDriveConnector
OneDriveConnector
S3Connector

SharePointOnlineConnector

Accesses SharePoint Online to upload, download, or delete files and folders or list file/folder information.

Jump to Configuration

Typical Uses

  • Manage files on SharePoint Online by uploading, downloading, and deleting files and folders.
  • Transfer a file's contents (such as XML or raster) into or out of an attribute in FME.
  • Retrieve file and folder names, paths, links and other information from SharePoint Online to use elsewhere in a workspace.

How does it work?

The SharePointOnlineConnector uses your SharePoint Online account credentials (either via a previously defined FME web connection, or by setting up a new FME web connection right from the transformer) to access the file storage service.

Depending on your choice of actions, it will upload or download files, folders, and attributes; list information from the service; or delete items from the service. On Upload and List actions, links and file/folder information are added to the output features as attributes.

Authentication

The SharePointOnlineConnector uses an oauth web service defined FME web connection. It is recommended to create a new web connection using the Microsoft SharePoint Online (safe.microsoft-sharepoint) web service. It is also recommended to replace the included FME app client with your own defined oauth application by updating the client id and secret in SharePoint Online (safe.microsoft-sharepoint).

SharePoint supports only work or school Microsoft accounts.

Usage Notes

  • This transformer cannot be used to directly move or copy files between different SharePoint Online locations. However, multiple SharePointOnlineConnectors can be used to accomplish this, by downloading files/folders and re-uploading them to a new location.
  • The FeatureReader can access SharePoint Online directly, without using the SharePointOnlineConnector. In this case, a permanent local copy of the data will not be created.

Configuration

Input Ports

This transformer accepts any feature.

Output Ports

The output of this transformer will vary depending on the action performed.

  • A Delete action will output the incoming feature.
  • A Download action will output the incoming feature and can save to either a file, folder or attribute.
  • A List action will output a new feature for each file/folder found in the path specified. Each of these new features will have attributes listing various pieces of information about the object.
  • After an Uploadaction, selected information about the file will be available as attributes.

The incoming feature is output through this port.

Features that cause the operation to fail are output through this port. An fme_rejection_code attribute describing the category of the error will be added, along with a more descriptive fme_rejection_message attribute which contains more specific details as to the reason for the failure.

Note  If a feature comes in to the SharePointOnlineConnector already having a value for fme_rejection_code, this value will be removed.

Rejected Feature Handling: can be set to either terminate the translation or continue running when it encounters a rejected feature. This setting is available both as a default FME option and as a workspace parameter.

Parameters

Account

To create a SharePoint Online connection, click the 'Account' drop-down box and select 'Add Web Connection...'. It is recommended to use the SharePoint Online Web Service. The connection can then be managed via Tools -> FME Options... -> Web Connections.

Action

The type of operation to perform. Choices include:

  • Delete
  • Download
  • List
  • Upload

The remaining parameters available depend on the value of the Request > Action parameter. Parameters for each Action are detailed below.

Delete Options

Site

The id of the sharepoint site. You may browse for a site.

Document Library

Also known as a drive on a site. A site can have multiple document libraries, which can be browsed.

Path

The full path of a file or folder on SharePoint Online to delete. A drive item id is also accepted. SharePoint prohibits deleting the root of a document library.

Download Options

Site

The id of the sharepoint site. You may browse for a site.

Document Library

Also known as a drive on a site. A site can have multiple document libraries, which can be browsed.

Path

The full path of a file or folder on SharePoint Online to download. A drive item id is also accepted.

Destination

Download as

Select whether to store the downloaded data in a File, Folder or Attribute.

  • File: The downloaded object will be stored in the specified folder.
  • Folder: The downloaded folder object will be stored in the specified folder.
  • Attribute: The downloaded object will be stored in the specified attribute.

Download to Attribute

Specify the attribute that will store the contents of the downloaded file. Valid for Download as Attribute only.

Response Body Encoding

For Download as Attribute, you can specify a character set encoding to ensure the output is in a human-readable form.

If Auto Detect from HTTP Header is specified but there is no encoding in the Content-Type metadata associated with the data, the output will be returned as raw bytes.

Download to Folder

Specify the path to the folder that will store the downloaded file. Valid for Download as File or Folder.

If File Exists

Specify what to do if the file already exists locally. Valid for Download as File or Folder.

  • Reject: If downloading a file, the input feature will be rejected. If downloading a folder, a rejected feature will be output for each rejected file.
  • Overwrite: Any existing local files or folders will be overwritten with the remote copy.

Include Subfolders

Choose whether to download subfolders of the SharePoint Online source or not. Valid for Download as Folder only.

Output Attributes

The selected attributes will be added to the output feature.

_download_path

Path of the downloaded object on the local file system. This attribute will not be added for Download as Attribute.

List Options

Site

The id of the sharepoint site. You may browse for a site.

Document Library

Also known as a drive on a site. A site can have multiple document libraries, which can be browsed.

Path

The full path to the folder on SharePoint Online to list. A drive item id is also accepted.

Include Subfolders

If set to Yes, then subfolders are recursively traversed, and their contents are included in the result.

Output Attributes

_name

Name of the file or folder.

_id

Drive item id of the file or folder.

_full_path

Full path of the file or folder relative to the document library, prefixed with ‘/’.

_document_library

The document library of the file or folder.

_extension

The extension of the file.

_list_id

Id of the SharePoint List.

_list_item_id

Numeric id of the item in the SharePoint List.

_url

URL to the file or folder.

_file_or_folder

Whether the item is a file or a folder.

_file_size

File size (not present for folders).

_created

Date and time when the file was created.

_created_by

Name of user who created the file or folder.

_last_modified

Date and time when the file was last modified.

_last_modified_by

Name of user who last modified the file or folder.

Data Source

Upload

The type of data to be uploaded.

  • File: The specified file will be uploaded.
  • Folder: The specified folder and its contents will be uploaded.
  • Attribute: The contents of the specified attribute will be uploaded.

When working with large objects, File is a better choice than Attribute as the data will be streamed directly from disk and not require that the object be stored entirely in memory on a feature.

When wanting to upload content from a folder, it is better to upload as a folder instead of setting a fixed path and sending multiple features into the connector to upload as a file.

File to Upload

The file to be uploaded to SharePoint Online if Upload is set to File.

Folder to Upload

The folder to be uploaded to SharePoint Online if Upload is set to Folder.

Include Subfolders

Choose whether to upload subfolders of the Folder to Upload or not.

Contents Only

  • Yes: Upload only the contents of the folder to the remote destination.
  • No: Upload the folder to the remote destination.

Attribute to Upload as File

The data to be uploaded, supplied from an attribute if Upload is set to Attribute.

Upload Options

Site

The id of the SharePoint site. You may browse for a site.

Document Library

Also known as a drive on a site. A site can have multiple document libraries, which can be browsed.

Upload with File Name

The name of the file created from the data supplied in Attribute to Upload as File. The name must include a filename extension (for example, .txt, .jpg, .doc).

If File Exists

Specify what to do if the file already exists on SharePoint Online.

  • Reject: If uploading a file, the input feature will be rejected. If uploading a folder, rejected files will be listed in the Rejected Files attribute.
  • Overwrite: Any existing files or folders on SharePoint Online will be overwritten with the local copy.

Create Sharing Link

If checked, a sharing link will be generated for the uploaded file. The attribute _sharing_link will be added to the output feature.

Permissions

  • Can edit: Permission to edit or view the file/folder
  • Can view: Permission to only view the file/folder

Scope

  • Anonymous: Anyone with the link can access. This may include people outside your organization.
  • Organization: Anyone signed into your organization can use the link to get access.

Expiration Date

Optional. The expiration time of the permission. Not available when scope is organization.

Output Attributes

_name

Name of the file or folder.

_id

Drive item id of the file or folder.

_full_path

Full path of the file or folder relative to the document library, prefixed with ‘/’.

_document_library

The document library of the file or folder.

_extension

The extension of the file.

_list_id

Id of the SharePoint List.

_list_item_id

Numeric id of the item in the SharePoint List.

_url

URL to the file or folder.

_file_or_folder

Whether the item is a file or a folder.

_file_size

File size (not present for folders).

_created

Date and time when the file was created.

_created_by

Name of user who created the file or folder.

_last_modified

Date and time when the file was last modified.

_last_modified_by

Name of user who last modified the file or folder.

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.

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.

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.

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

 

Feature-Based

Feature Holding

No
Dependencies SharePoint Online Account
Aliases  
History Released FME 2019.0

FME Community

The FME Community has a wealth of FME knowledge with over 20,000 active members worldwide. Get help with FME, share knowledge, and connect with users globally.

Search for all results about the SharePointOnlineConnector 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.