Full path: /system/ftp/retrieve
Retrieves a file from the FTP Server.
This function returns Boolean TRUE if execution was successful. If the job execution fails, the outcome depends on the value of the Abort on error parameter, as follows:
•If the Abort on error parameter is TRUE (default value), the job execution is aborted. In this case, you can still handle errors by means of protected blocks (see Handling Step Errors).
•If the Abort on error parameter is FALSE, the function returns FALSE.
If you intend to use the triggerfile parameter in any FTP function, remember that its path is absolute. For an example, see the FTP store function.
Address of the remote FTP server, either as a URL or IP address.
The port number used to connect to the FTP server. The default value is 21.
Directory on host
The name of the directory, on the host, from where you want to retrieve the file.
The username and password of the FTP account, as a FlowForce credential record, see Credentials.
Skip this parameter if the FTP server does not require credentials.
Use passive mode
Use passive mode if connection problems occur (for example, if routers or firewalls are set up to prevent active connections).
Use SSL/TLS encryption
(Optional parameter, the default value is No.) To transfer information, FTP uses a command channel and a data channel. If you would like to transfer FTP data without encryption, set this value to No. Otherwise, set this value to one of the following:
•Explicit with encrypted command channel
•Explicit with encrypted command and data channel
If you set any of the two options above, the server certificate will be validated according to the Verify server certificate parameter described below.
Verify server certificate
(Optional parameter.) Specifies how FlowForce should verify the FTP server's certificate. Valid values:
•No verification - Accept any certificate.
•Verify against system certificate store (default value) - On Windows, use the certificate store of the user account running the job and the system store to verify the certificate signature. On Linux, use the system certificate store, usually located in /usr/lib/ssl/cert.pem and /usr/lib/ssl/certs, or the path where the SSL_CERT_FILE and SSL_CERT_DIR environment variables point to.
•Verify against selected server certificate - FlowForce will compare the FTP server's certificate with the one specified in the Server Certificate parameter.
Using this parameter requires the presence of a server certificate and a secure connection. If a secure connection cannot be established, the FTP function will fail.
(Optional parameter.) Specifies the path to a certificate object in FlowForce. The specified FlowForce certificate will be verified against the FTP server certificate if you also set the previous parameter to Verify against selected server certificate. Otherwise, this parameter value will be ignored.
The name of the file that you want to retrieve.
The name the file should have once it is retrieved.
When true, causes the destination file to be overwritten. The default value is false .
Abort on error
This Boolean parameter determines what should be the return value of the function if the job fails. If Abort on error is FALSE, the function will return Boolean FALSE as well. If Abort on error is TRUE, the job execution is aborted. The default value is TRUE.
Specifies the working directory of the job (for example, c:\somedirectory). If relative paths are used, they will be resolved against the working directory.
The FTP account name of the user allowed access to the files on the remote server.