Skip to main content

FetchSharepointFile

Description

Fetches the contents of a file from a Sharepoint Drive, optionally downloading a PDF or HTML version of the file when applicable. Any FlowFile that represents a Sharepoint folder will be routed to success without fetching contents.

Tags

cdc, document, experimental, graph, microsoft, sharepoint, unstructured

Properties

In the list below required Properties are shown with an asterisk (*). Other properties are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
Authentication Service *Authentication ServiceController Service:
MicrosoftGraphAuthenticationService

Implementations:
MicrosoftGraphAuthenticationProvider
The service that provides authentication for the SharePoint API
Drive ID *Drive ID${sharepoint.drive.id}The ID of the drive that contains the file to fetch

Supports Expression Language, using FlowFile attributes and Environment variables.
Item ID *Item ID${sharepoint.item.id}The ID of the item to fetch

Supports Expression Language, using FlowFile attributes and Environment variables.
Download PDF/HTML Version *Download PDF/HTML Versiontrue
  • true
  • false
  • Use 'auto.convert' attribute
Sharepoint supports automatically converting certain file formats to PDF or HTML. If this property is set to true,
the Processor will inspect the FlowFile's filename extension to determine if the file can be
converted to PDF or HTML. If the file can be converted, the Processor will download the converted version. If the file
cannot be converted, the Processor will download the original file. If this property is set to false, the Processor will
always download the original file.
Update Extension *Update Extensiontrue
  • true
  • false
If true, the Processor will update the filename extension to match the format of the downloaded file

This property is only considered if:
  • the property Download PDF/HTML Version has a value of true or Use 'auto.convert' attribute

Dynamic Properties

This component does not support dynamic properties.

Relationships

NameDescription
failureAn incoming FlowFile is routed to this relationship if the contents of the item could not be fetched
successAn incoming FlowFile is routed to this relationship after the contents of the item have been fetched and written to the FlowFile

Reads Attributes

This processor does not read attributes.

Writes Attributes

This processor does not write attributes.

State Management

This component does not store state.

Restricted

This component is not restricted.

Input Requirement

This component requires an incoming relationship.

System Resource Considerations

This component does not specify system resource considerations.

See Also

CaptureSharepointChanges