IMPORTANT: This documentation has been discontinued. Read the updated FTP documentation on our new documentation portal.
FTP allows the establishment of a connection with a service that supports the FTP (File Transfer Protocol) protocol and the execution of the upload, delete, download, list or move commands.
Take a look at the configuration parameters of the component:
FTP Server Operating System: operational system type the FTP runs.
Account: for the component to make the authentication to an FTP service, it's necessary to use a BASIC-type account.
Host: name of the host or IP address to establish the connection. This parameter supports Double Braces.
Port: number of the port - generally 21 for FTP and 990 for FTPS. This parameter supports Double Braces.
Operation: operation to be executed, which can be uploaded, download, list, delete or move.
File Name: name of the file or complete path (full file path) to the file. This parameter supports Double Braces.
Remote File Name: name of the remote file or related path (eg.: tmp/file.txt) to the remote file. This parameter supports Double Braces.
Remote Directory: mandatory field. Base remote directory, which can be related (eg.: pub/tmp) or absolute (eg.: /root/pub). This parameter supports Double Braces.
Binary File: if "true", the file's transfer will be made in binary mode (TYPE I or Image); if "false", the simple text mode (TYPE A or ASCII) will be used.
Connection Timeout: time for the connection with the server to expire (in milliseconds).
Data Timeout: time for the transfer of each file to expire (in milliseconds).
Fail On Error: if the option is enabled, the execution of the pipeline with error will be interrupted; otherwise, the pipeline execution proceeds, but the result will show a false value for the “success” property.
FTP Security: if the option is activated, the FTP is accessed in secure FTPS mode (FTP-SSL or FTP Secure).
SSL: if the option is activated, the FTP is accessed with the cryptographic SSL protocol (Secure Sockets Layer).
Implicit: if the option is activated, the SSL connection is established through the 990 port even before the login or the file transfer.
Remote Verification: enables or disables the verification in which the remote host (that is part of a data connection) is the same host the control connection is connected to.
Security Protocol: security protocol type to be used - SSL (Secure Sockets Layer) or TLS (Transport Layer Security).
Execution Type Protocol: private, clear, confidential or safe.
Buffer Size: buffer size of the safe data channel.
IMPORTANT: notice that some of the parameters above support Double Braces. To understand how this language works, read our article by clicking here.
Messages flow
Output
When executing an FTP component using the download, upload or move operations, the following JSON structure will be generated:
{
"status": {
"success": true,
"content": [
{
"symbolicLink": false,
"name": "file.pdf",
"type": 0,
"size": 144089,
"directory": false,
"file": true,
"timestamp": 1544726460000,
"unknown": false,
"rawListing": "-rw-rw---- 1 user 10002 144089 Dec 13 16:41 file.pdf",
"link": null,
"hardLinkCount": 1,
"user": "user",
"group": "10002"
}
]
}
}
fileName: name of the local file
remoteFileName: path of the remote file or related path of the remote file
remoteDirectory: path of the base remote directory (related or absolute)
success: "true" if the operation was successful, "false" if otherwise
When executing an FTP component using the list operation, the following JSON structure will be generated:
{
"remoteDirectory": "pub/example",
"success": true,
"content": [
{
"file": "imap-console-client.png"
}
]
}
remoteDirectory: path of the base remote directory (related or absolute)
success: "true" if the operation was successful, "false" if otherwise
content: list of files in the remoteDirectory
file: name of the file
IMPORTANT: the manipulation of files inside a pipeline occurs in a protected way. The files become available in a temporary directory that only the pipeline under execution has access to.
To understand how the messages flow work in the Platform, click here and read our article.