File

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

This Node has been replaced by File Read, File Write, File Delete, FTP Read, FTP Write, FTP Delete, SFTP Read, SFTP Write, SFTP Delete and should not be used for new Workflows. These Nodes are only available in the 2023 Refresh.

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.
1.1.0.2 - Updated the SFTP library which contains bug fixes.
1.1.0.6 - Provide a meaningful error when properties are missing
1.2.0.8 - Upgraded Libraries, Improved SFTP, FTP&FTPS Support, QoL fixes.
1.2.0.9 - Fix to correctly surface inner exception in FTP Error cases. Added override for FTP encryption mode in connection properties.

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

ClientPrivateKeyFileContents
Type: Multiline Text Data
The SSH Certificate contents used to authenticate to SFTP.

TrustedServerCertificateThumbprint
Type: String
The SHA-1 Fingerprint of the certificate of the FTPS server to connect to. Submitted as numbers and all uppercase letters, no colons. Note that leaving this field empty will trust any certificate presented by the server.

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
Indicates the action to take against the file specified in Path.

Read
Write
Delete

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
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.

Text
Binary

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.

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.

As of Version 1.2.0.8, the File Node is no longer executable in Run From Cloud configuration and should instead be run from a DropPoint. Should the from cloud configuration be required, this can be arranged by submitting a support ticket.

Authentication

The Username and PasswordorClientPrivateKeyFileContents provided in the ConnectionProperty 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.

Troubleshooting

FTPS Error when interacting with FileZilla Server - File download failed. Last message from FTP: [150]. This error is often caused by an underlying issue with FTP with TLS navigation on the FileZilla server. The server logs of a failed request will most likely include 450 TLS session of data connection has not resumed or the session does not match the control connectionat the time of the failed request. This can be rectified by adjusting the settings of the FileZilla server, unchecking Require TLS session resumption:

See Also

File Enumerator
File Watcher
FileManage
Flat File