Altova FlowForce Server 2023 Advanced Edition

Full path: /system/sftp/delete

 

Deletes a file from the SFTP Server. This function returns true if the execution has been successful. Otherwise, the outcome depends on the Abort on error parameter (see 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.

Target file

string

Mandatory parameter. Specifies the name of a file to be deleted.

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.

 

© 2016-2022 Altova GmbH