Full path: /system/sftp/retrieve-wildcard
Retrieves from the SFTP server any files that match a wildcard (e.g., *.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 (see details below).
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. |
Wildcard |
string |
Mandatory parameter. Specifies a wildcard, for example, *.xml. Any files matching the wildcard will be retrieved. See also Wildcards in SFTP functions. |
Target directory |
string |
This is an optional parameter that controls where retrieved files will be stored. Another way to specify the location of retrieved files is to set the Working directory parameter. Both parameters can also be used simultaneously: You can use the Working directory parameter to specify the parent folder and the Target directory to specify the relative path to a subfolder. |
Overwrite target |
boolean |
Optional parameter. Set this parameter to true if destination files with the same names should be overwritten. The default value is false. |
Abort on error |
boolean |
Optional parameter. If job execution fails and the Abort on error parameter is set to true, the job execution will be aborted. The default value is true. |
Working directory |
string |
Specifies the working directory against which all local relative paths will be resolved. |
