FME Flow: 2024.1

SFTP Directory

The SFTP Directory external action receives messages and uploads files over a Secure Shell (SSH) connection to specified SSH File Transfer Protocol (SFTP) hosts.

The SFTP Directory external action has two output ports. The success port (✔) can send a message if the upload is successful. The failure port (x) can send a message if the upload fails.

Note  When Retry settings are configured, the failure port renders with a Retry Configured (⟳) icon.

Parameters

Note  See also Working with Parameters in Automations Workflows.
Tip  To test that your parameters work as expected, click Validate.
  • Host: The SFTP host name.
  • Port: The SFTP port number. The default is 22.
  • Username: The SFTP user name for authentication.
  • Password: The SFTP user password for authentication.
  • Verify Host Keys: Whether or not to verify the host key for the server connection.
  • Path to Known Hosts File: If Verify Host Keys is Yes, the path to the known_hosts file that contains the public keys for any servers you wish to connect to. If the known_hosts file is saved to a Resources directory, click the ellipsis (...) and select the file. Otherwise, enter the file path directly. File paths must use forward slashes (/) or escaped backslashes (\\).
    • Note  A known_hosts file contains public keys for computers you connect to via SSH. To obtain a public key and insert it into the known_hosts file, run the following command in OpenSSH: ssh-keyscan -t rsa <hostname> > <path_to_known_hosts_file>. Alternatively, contact your system administrator.

    For more information about OpenSSH, and to install, see https://www.openssh.com/.

  • Destination Path: The destination path to upload the file.
  • Source Path: The source file to upload. If the source file is saved to a Resources directory, click the ellipsis (...) and select the file. Otherwise, enter the file path directly. File paths must use forward slashes (/) or escaped backslashes (\\).

Example

Mouse-over to view:

Output Attributes

See Also

Tip  To view the output attributes from upstream components, click Show Upstream Attributes.
Attribute Description
time Event time
source Event type
file.path (Success port only) File path
error.type

(Failure port only) Error type:

  • InvalidMessage: An error occurred while configuring this component, such as missing or malformed values.
  • DeadLetter: An error occured while connecting to an external resource. Examples may include connection issues, invalid credentials, or generic external resource exceptions.
error.message (Failure port only) Error message

Retry

  • Retry on failure: If checked, the automation attempts to run the action again if the initial attempt results in a failure to connect to the specified external resource for message delivery. The manner in which these retries are conducted is based on the remaining settings.
  • Use custom retry settings: If checked, the remaining retry settings are configurable. If not checked, they are set to the FME Flow default values.
  • Number of attempts: Maximum number of retries, if the action continues to fail.
  • Wait between attempts: Time to wait between retries. In conjunction with Backoff multiplier (below), the specified value is the wait time for the first retry.
  • Backoff multiplier: Factor by which to increase Wait between attempts on successive retries. For example, a value of 2.0 doubles the wait time for the next retry.
  • Randomization factor: Percentage by which to introduce randomness to Wait between attempts. For example, if Wait between attempts is 100 Seconds, and Randomization factor is 25, the wait time for each retry is randomly selected between 75 and 125 seconds.
  • Maximum wait between attempts: Maximum wait time between retries. In conjunction with Backoff multiplier, the specified value is the upper limit for wait time.