FetchSmb

FetchSmb 2.0.0

Bundle: org.apache.nifi | nifi-smb-nar
Description: Fetches files from a SMB Share. Designed to be used in tandem with ListSmb.
Tags: cifs, fetch, files, samba, smb
Input Requirement: REQUIRED
Supports Sensitive Dynamic Properties: false

Properties

Completion Strategy
Specifies what to do with the original file on the server once it has been processed. If the Completion Strategy fails, a warning will be logged but the data will still be transferred.
Display Name

Completion Strategy

Description

Specifies what to do with the original file on the server once it has been processed. If the Completion Strategy fails, a warning will be logged but the data will still be transferred.

API Name

Completion Strategy

Default Value

NONE

Allowable Values
- None
- Move File
- Delete File
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Create Destination Directory
Specifies whether or not the remote directory should be created if it does not exist.
Display Name

Create Destination Directory

Description

Specifies whether or not the remote directory should be created if it does not exist.

API Name

Create Destination Directory

Default Value

false

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true

Dependencies
- Completion Strategy is set to any of [MOVE]
Destination Directory
The directory on the remote server to move the original file to once it has been processed.
Display Name

Destination Directory

Description

The directory on the remote server to move the original file to once it has been processed.

API Name

Destination Directory

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true

Dependencies
- Completion Strategy is set to any of [MOVE]
Remote File
The full path of the file to be retrieved from the remote server. Expression language is supported.

Display Name

Remote File

Description

The full path of the file to be retrieved from the remote server. Expression language is supported.

API Name

remote-file

Default Value

${path}/${filename}

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true
SMB Client Provider Service
Specifies the SMB client provider to use for creating SMB connections.

Display Name

SMB Client Provider Service

Description

Specifies the SMB client provider to use for creating SMB connections.

API Name

smb-client-provider-service

Service Interface

org.apache.nifi.services.smb.SmbClientProviderService

Service Implementations

org.apache.nifi.services.smb.SmbjClientProviderService

Expression Language Scope

Not Supported

Sensitive

false

Required

true

Relationships

Name	Description
success	A FlowFile will be routed here for each successfully fetched file.
failure	A FlowFile will be routed here when failed to fetch its content.

Writes Attributes

Name	Description
error.code	The error code returned by SMB when the fetch of a file fails.
error.message	The error message returned by SMB when the fetch of a file fails.