retrieve

www.altova.com Print this Topic Previous Page Up One Level Next page

Home >  Built-in Functions > /system/ftp >

retrieve

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.

 

Parameters

Name

Type

Description

FTP Server

string

Address of the remote FTP server, either as a URL or IP address.

 

Mandatory parameter.

Port

number

The port number used to connect to the FTP server. The default value is 21.

Directory on host

string

The name of the directory, on the host, from where you want to retrieve the file.

 

Optional parameter.

Login credentials

credential

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

boolean

Use passive mode if connection problems occur (for example, if routers or firewalls are set up to prevent active connections).

Source file

string

The name of the file that you want to retrieve.

 

Mandatory parameter.

Target file

string

The name the file should have once it is retrieved.

 

Mandatory parameter.

Overwrite target

boolean

When true, causes the destination file to be overwritten. The default value is false .

Abort on error

boolean

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.

Working directory

string

Specifies the working directory of the job (for example, c:\somedirectory). If relative paths are used, they will be resolved against the working directory.

Account

string

The FTP account name of the user allowed access to the files on the remote server.

 

Optional parameter.


© 2019 Altova GmbH