Permits read or write or delete of a file including local files, UNC paths. FTP, SFTP anf FTPS.

Revision History

1.0.0.35 - Added support for explicit passive & active FTP, added support for custom timeout, some bug fixes
1.1.0.0 - Added support for SSH Authentication by providing certificate contents, changed property names for consistency.

Properties

Connection

Type: Connection Input
Provides a Connection and optionally a DropPoint to service the request.

Username
Type: String
The username used to authenticate access to the FTP or SFTP server

Password
Type: String
The password used to authenticate access to FTP or SFTP server

PrivateKeyFileContents
Type: Multiline Text Data
The SSH Certificate contents used to authenticate to SFTP or FTPS

CreateTargetDirectory
Type: Boolean
When True , indicates that the target path should be created if it does not already exist.

UsePassiveFTP
Type: Boolean
Some servers are configured to expect the PASV command when a connection is initialized. The Node then sends the PASV command instead of the PORT command when initiating a connection to the Server.

Action

Type: List Input
Read
Write
Delete
Indicates the action to take against the file specified in Path.

Path

Type: String Input
The path to the file. This may be a UNC path, a relative or absolute local path (when executed at a DropPoint) or an FTP file path. For FTP, prefix Path with ftp:// or sftp://.

Type

Type: List Input
Text
Binary
Indicates whether the file should be read or written as text or binary. In Text mode, the file is read or written as a string. In Binary mode, the file is read or written as a byte array.

Content

Type: Multiline Text InputOutput
Provides access to the file stream. For Action Write, set this property to the file content before invoking. For Action Read, this property will be set to the file content during invoke. Content may be of type string or byte array - refer to the Type property for more information.

Video

Remarks

The File Connector allows a single files to be read, written or deleted per invoke. 

The prefix provided as part of Path determines the file type as follows:

  • [Drive]:\ local drive
  • \\ UNC path for network share
  • ftp:// FTP
  • sftp://  SFTP
  • ftps:// FTPS

If you are reading or writing sizeable files over FTP, installing a DropPoint in the same network as the FTP server will significantly improve performance as the data will be compressed in transit to and from the DropPoint.

Authentication

The Username and Password or PrivateKeyFileContents provided in the Connection Property will be used to authorize FTP or SFTP sessions only. If you require specific credentials to gain access to a local file or UNC path, change the Windows Service account used by the DropPoint.

See Also

File Watcher

Did this answer your question?