Please enable JavaScript to view this site.

Altova FlowForce Server 2022 Advanced Edition

Full path: /system/sftp/retrieve-wildcard

 

Retrieves from the SFTP server any files that match a wildcard, for example, *.xml.

 

This function returns a list of strings with local file names, if the execution has been successful. Otherwise, the outcome depends on the Abort on error parameter, as further described below.

 

 

Parameters

Name

Type

Description

SFTP Connection

SFTP Connection

A FlowForce object that provides the SFTP connection. To obtain the SFTP connection object, call the /system/sftp/connect function first, in a separate execution step.

 

Mandatory parameter.

Wildcard

string

Mandatory parameter. Specifies a wildcard, for example, *.xml. Any files matching the wildcard will be deleted. See also Wildcards in SFTP functions.

Overwrite target

boolean

Optional parameter. Set this to true if destination files with the same name should 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 execution fails. If this parameter is false, the function will return Boolean false as well. If this parameter is true, the job execution is aborted. The default value is true.

Working directory

string

Specifies the local directory to which files should be retrieved.

 

© 2015-2021 Altova GmbH