Output SFTP/FTPS

The Output SFTP/FTPS task sends job files to other computers using a secured FTP protocol. It is similar to the Send to Folder output task but sends to an FTP connection instead of a local drive.

This plugin uses the OLE Automation API of the WinSCP project. The WinSCP API 5.21 is installed with Workflow as of version 2022.2. The latest version of the API can also be installed manually and registered for use as described on WinSCP's website: https://winscp.net/eng/docs/library_install#registering.

Input

Any data file.

Processing

The file is sent to the secure FTP Server and location defined in the task's properties. If the folder in which the file should be placed doesn't exist, it will be created if the user's permissions allow for this.

The plugin opens and closes a connection to the server for every file to upload.

Note that if the plugin is not set to automatically accept the certificate returned by the FTP server, it only uploads files to the server if the server's RSA fingerprint defined in the task's properties corresponds to the server's certificate.

How to get the server's fingerprint

To get the server's fingerprint, run the plugin once in debug mode with an empty fingerprint value. The server's fingerprint will be written to the message log, from which you can copy it to the plugin's field.

Task properties

General Tab

• Server settings
  • Url: Enter the url of the FTP server to poll.
  • Username: Enter the name of a user account on the server.
  • Password: If the above account is password protected, enter the password here.
  • Protocol
    • SFTP: Select if the FTP server uses SFTP (SSH).
    • FTPS: Select if the FTP server uses FTPS (SSL/TSL).
    • FTPS connection mode: These settings are only relevant for the FTPS protocol.
      • Active or Passive: Select to prompt the plugin to use the active or passive mode. This depends on the FTP server. For more information, see https://winscp.net/eng/docs/ftp_modes.
      • FTP secure: Select the Implicit or Explicit method to invoke security, depending on the FTP server. For more information, see https://winscp.net/eng/docs/ftps.
    • Port number: Set to use a specific port number. Note: There is no validation to ensure the port is available. It is the user's responsibility to ensure the selected port is available and not being monitored by another application or another OL Connect Workflow task.
  • Accept all certificates: Check this option to automatically accept the certificates returned by the FTP server. Otherwise, in order for a connection to work, the server's fingerprint is needed.
  • Fingerprint: The RSA fingerprint of the server. The current job file is only uploaded to the remote server if the fingerprint corresponds to the server's certificate. See How to get the server's fingerprint.
• Remote file options
  • Directory (optional): Enter the directory to which the job files are to be uploaded. If you leave this box empty, the job files are sent to the root directory of the FTP server.
  • Filename: Enter the name under which the output job file will be saved. Consider using a dynamic name, since if you use a static name every new file will overwrite the previous one.