Altova FlowForce Server 2025 Advanced Edition

Downloads a file from an SFTP server to a local directory.

 

Parameters

Name

Type

Description

SFTP Connection

SFTP Connection

Mandatory parameter. This is a FlowForce object that establishes an SFTP connection. To get the SFTP connection object, call the /system/sftp/connect function first, in a separate execution step.

Source file

string

Mandatory parameter. Specifies the path of a file to be downloaded from the SFTP server.

Target file

string

Mandatory parameter. The name of the downloaded file in a local directory. If you specify a relative path, it will be resolved against the working directory. If you use an absolute path, the path specified in the Working directory parameter will not be used.

Overwrite target

boolean

Optional parameter. Set this parameter to true if you want to overwrite destination files with the same names. The default value is false.

Abort on error

boolean

Optional parameter. This parameter determines the outcome of a job in which an error has occurred. If the Abort on error parameter is true, job execution will be terminated. If the Abort on error parameter is false, FlowForce Server will ignore errors and continue job execution. The default value is true.

Working directory

string

Optional parameter. Specifies the local working directory where the file downloaded from the SFTP server will be stored.

 

© 2018-2024 Altova GmbH