retrieve-wildcard
Downloads files from an FTP server to a local directory if the files match a wildcard (e.g., *.xml). If execution is successful, the function returns a list of files (absolute local paths) or an empty list if no match has been found. If execution fails, the outcome depends on the Abort on error parameter (see below).
Parameters
Name | Type | Description |
|---|---|---|
FTP Server | string | Mandatory parameter. Address of a remote FTP server, as a URL or IP address.
|
Port | number | Optional parameter. The port number used to connect to the FTP server. The default value is 21.
|
Directory on host | string | Optional parameter. The name of a directory on the remote FTP server from which you want to download files that match a particular wildcard.
|
Login credentials | credential | Optional parameter. The username and password of the FTP account. For details, see Credentials. Skip this parameter if the FTP server does not require credentials.
|
Use passive mode | boolean | Optional parameter. Use the passive mode if connection problems occur (e.g., if routers or firewalls are set up to prevent active connections). The default value is true.
|
Use SSL/TLS encryption | string | Optional parameter that specifies whether SSL/TLS encryption should be used. The default value is No. To transfer information, FTP uses a command channel and a data channel. If the FTP server supports explicit encryption, you can set this parameter to one of the values below:
•Explicit with encrypted command channel (least secure) •Explicit with encrypted command and data channel •Explicit with encrypted command and data channel and shared TLS session (most secure)
If you set any of the options above, the validation of the server certificate will depend on the value of the Verify server certificate parameter. Implicit encryption is deprecated and not supported in FlowForce.
Also note that existing jobs that used the option Explicit with encrypted command and data channel before 2025 Release 2 will switch automatically to the more secure option Explicit with encrypted command and data channel and shared TLS session instead. If the more secure option does not work for some reason, change the option manually to Explicit with encrypted command and data channel.
|
Verify server certificate | string | Optional parameter. Specifies how FlowForce should verify the FTP server's certificate. The following options are available:
•No verification: Accepts any FTP server certificate. •Verify against system certificate store (default value): On Windows, FlowForce Server uses the certificate store of the user account running the job and the system store to verify the certificate signature. On Linux, FlowForce Server uses the system certificate store, usually located in /usr/lib/ssl/cert.pem and /usr/lib/ssl/certs, or the path to which the SSL_CERT_FILE and SSL_CERT_DIR environment variables point. •Verify against selected server certificate: FlowForce compares the FTP server's certificate with the one specified in the Server Certificate parameter.
This parameter requires a server certificate and a secure connection. If a secure connection cannot be established, the FTP function will fail.
|
Server certificate | certificate | Optional parameter. Specifies the path to a FlowForce certificate. If you select Verify against selected server certificate in the Verify server certificate parameter, the FlowForce certificate will be verified against the FTP server certificate. If you select No verification or Verify against system certificate store in the Verify server certificate parameter, the Server certificate parameter value will be ignored.
|
Wildcard | string | Optional parameter. Specifies a wildcard, for example, *.xml. Any files matching the wildcard will be downloaded from the FTP server to a local directory. See also Wildcards in FTP functions.
If you use a relative path, it will be resolved against the path specified in the Directory on host parameter. If you use an absolute path, the path in Directory on host will be ignored.
|
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.
Note that some files may still be retrieved even if execution fails.
|
Working directory | string | Optional parameter. Specifies the local working directory where the files downloaded from the FTP server will be stored.
|
Account | string | Optional parameter. The FTP account name of the user that has access to the files on the remote server.
|