Skip to main content

S-FTP Out

Current configuration of the S-FTP Out task in the Workflow Designer

The “S-FTP Out” task allows you to securely upload one or more files to a remote server using the SFTP (Secure File Transfer Protocol) protocol. It is an essential component for automating the transfer of data, reports, or any other file generated by the Workflow to external systems.

Configuration​

The task configuration is divided into two main sections: authentication for the connection and details of the file to be transferred. The task configuration fields can be set manually or via workflow parameters and variables.

Authentication​

Defines the method by which the Workflow will authenticate with the SFTP server.

  • Authentication Method: You can choose between:
  • Password: Authentication will occur using the password associated with the user.
  • SSH Keys: Authentication will occur using an SSH key pair (public/private). This is the most secure and recommended method for automations.
  • Host: The IP address or DNS name of the SFTP server to connect to.
  • Port: The communication port for the SFTP connection. The default value is 22.
  • User: The username for the connection.

Upload Parameters​

Specifies which file to transfer and where to place it on the remote server.

  • File to Transfer: The full path of the local file (on the system where the Workflow runs) that must be uploaded.
  • Remote Path: The path of the directory on the SFTP server where the file will be uploaded.

Output Parameters​

After attempting the upload operation, the task exposes the following output parameters, which are fundamental for verifying the outcome of the transfer.

  • result: Contains a text message describing the result of the operation.
  • Success example: "Transfer completed successfully"
  • Failure example: "Authentication error with user [UserName] and password" or "Error transferring file [FileName]"
  • resultJson: Represents the result of the task execution in JSON format, including general information, configurations, and execution details.
  • ftpOutFile: Returns the name of the file as it was transferred to the remote server.
  • ftpOutPath: Returns the path of the remote directory where the file was uploaded.