FTP Connector

This adapter supports FTP (File Transfer Protocol), SFTP (SSH File Transfer Protocol) and FTPS (File Transfer Protocol Secure / FTP-SSL) for sending, receiving, deleting, moving a file or folder and for listing folder contents. The adapter supports proxy servers of type HTTP, SOCKS4 und SOCKS5.

This adapter replaces the FTP Transfer as well as the SFTP Communication Adapter.

Properties

Operation

Determines which file transfer operation is performed on the processed files or folders.

Possible values:

Exists: Check whether the files or folders specified in the path parameter exist. Outputs an XML with metadata as a result.
List: List names and metadata of files and folders from the folder specified in the path parameter. The output is an XML with metadata as a result.

The content of the files is not listed.
Send File: Write data from the previous process step to the destination file specified in the path parameter.
Receive File: Read the file specified in the path parameter.
Append File: Append file from the previous process step to the destination file specified in the path parameter.
Move: Move file or folder on FTP(S)/SFTP server from path to targetPath.
Delete File: Delete files specified in the path parameter.
Create Folder: Create folder on FTP(S)/SFTP server specified in the path parameter.
Delete Folder: Delete files specified in the path parameter.

Parameter

`host`	IP address or host name of the FTP(S)/SFTP server Possible values: Any valid string (e.g. `server.tld`)
`port`	Port number of the FTP(S)/SFTP server Possible values: Any positive integer `22`: SFTP default port (default)
`user`	Username for the FTP(S)/SFTP connection
`password`	Password for the FTP(S)/SFTP connection
`path`	Path to a folder or file on the FTP(S)/SFTP server. Possible values: Any string (e.g. `/Folder/Subfolder` oder `/Folder/Subfolder/File.xml` )
`targetPath`	Additional path to a folder or file on the FTP(S)/SFTP server. This parameter is used only in the `Move` operation. Possible values: Any string (e.g. `/Folder/Subfolder` oder `/Folder/Subfolder/File.xml` )
`protocol`	File transfer protocol Possible values: `FTP`: Execute operations via File Transfer Protocol (default) `FTPS`: Execute operations via File Transfer Protocol Secure (default) `SFTP`: Execute operations via SSH File Transfer Protocol (default)
`connectMode`	Connection mode Possible values: `ACTIVE`: Active connection mode `PASSIVE`: Passive connection mode (default)
`nameFilter`	Filters the output of the operation `List` by name Possible values: Any string (e.g. `.xml` ) Placeholder (wildcard) `*`
`addNewLine`	Inserts a new line in the destination file before the file is appended. Can only be used with the `Append File` operation. Possible values: `None`: (default) Does not insert a new line. `Auto`: Inserts a new line if no new line was inserted before. Detects the format of an already inserted new line. `Windows`: Inserts a new line in Windows format. `Unix`: Inserts a new line in Unix format.
`hostValidationEnabled`	Enable host validation to ensure that the requested SFTP server corresponds to the SFTP server that is being connected to. The `hostValidationEnabled` parameter is only relevant for the SFTP protocol. Possible values: `Yes`: Enable host validation (set flag) `No`: Disable host validation (not recommended for production systems) (default)
`hostValidationFile`	Path to the Known Hosts file, which contains a list of confirmed hosts and their associated public keys. Possible values: Any valid path (e.g. `C:\Data\known_hosts)`

Status values

`1`	The operation was executed successfully.
`-1`	The operation failed due to a technical error.