delete-wildcard
Deletes files matching a wildcard (e.g., *.xml) from an FTP server. If execution is successful, the function returns a list of deleted files 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 delete files that match a specific 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. The default value is No. To transfer information, FTP uses a command channel and a data channel. If you would like to transfer FTP data without encryption, leave the default value. Otherwise, set this value to one of the following:
•Explicit with encrypted command channel •Explicit with encrypted command and data channel
If you set any of the two 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. |
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 deleted from the FTP server. 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 the 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 this parameter is false, the function will return the list of directory names that have been deleted successfully and omit those file names that cannot be deleted for some reason. If this parameter is true, the job execution will be aborted in the first file that cannot be deleted. The default value is true. |
Account | string | Optional parameter. The FTP account name of the user that has access to the files on the remote server. |