SFTP OUT CLIENT

Edit online

As SFTP is an SSH-based protocol, TLS v1.3 is not supported for SFTP outbound communication.

Note: You cannot send a cXML document type through the SFTP-out channel in webMethods B2B .

An SFTP OUT Client channel details.
Field Description
Connection
Hostname Host name or IP address of the partner's SFTP server. For example, trader.com.
Port An active port on the partner's SFTP server. For example, 3456. Default is 22.If the port to which the connection is being established is either invalid or not open, it results in a bad gateway error.
Host public key option Public key used to establish a secure connection with the partner's SFTP server. Select from the following options:
  • Auto retrieve. webMethods B2B automatically retrieves the public key file.
    Note: Ensure that the hostname and port are active and accessible.
  • Upload. You can upload the public key file.
Note: Manually refresh (to pull the latest host public key from the SFTP server) the SFTP channels, if the Host public key option for the SFTP server changes after you configure the SFTP channels to avoid transactions from failing during runtime.
Username Username used to connect to the partner's SFTP server.
Authentication type Type of authentication required to connect to partner's SFTP server. Select from the following types of authentications:
  • Password
  • Public key
webMethods B2B supports only OpenSSH format to generate the public and private key pair. webMethods B2B do not support SSH2 format for both public and private key pairs. If you select Password as the authentication type, provide the password to connect to the partner's SFTP server in the Password field. If you select Public key as the authentication type, upload the private key file that is required to connect to the partner's SFTP server in the Private key field. Also provide the passphrase that is used to protect the private key in Passphrase field.
SFTP Client Version The internal SFTP client version to use to connect to the SFTP server. Specify the values for each client version.
  • SFTP V1. No additional configuration information is required.
  • SFTP V2. SFTP V2 is the default internal SFTP client. Other configuration properties such as Key Exchange Algorithms, Machine Access Code (MAC) algorithms, and ciphers that are not available in the Version 1 client. Specify the values for more configurations:
    • Min Diffie-Hellman key size. The minimum Diffie-Hellman key size to use. The default minimum key size is 1024 bits.
    • Max Diffie-Hellman key size. The maximum Diffie-Hellman key size to use. The default maximum key size is 8192 bits.
The Preferred MAC Algorithms list excludes hmac-sha256, hmac-sha256@ssh.com, hmac-sha512, hmac-sha512@ssh.com, hmac-ripemd160, hmac-ripemd160@openssh.com, hmac-ripemd160-etm@openssh.com. The latest Version 2 SFTP clients do not support these algorithms.
Note: You cannot change the SFTP client version after you create the channel. If your existing workflows fail because of the SFTP version mismatch, you must create a new channel with the right SFTP version.
Destination details
Folder path The path of the folder into which webMethods B2B places the files.
Allow folder creation If the folder specified in the folder path does not exist, enable this option to allow webMethods B2B to create a new folder with the same folder name. webMethods B2B does not support the creation of nested folders in the SFTP server. For example, if docs/por is the existing folder path, then docs/por/processed is supported, whereas docs/por/processed/partners is not supported.
File name prefix Prefix to add to the file name. The default value is wmiob2b and it is optional to append the timestamp to the file name. When you enable Append timestamp to the file name, webMethods B2B constructs the file name by combining the prefix and timestamp. Therefore, the file name format is prefix\_<current\_timestamp in YYYYMMDDhhmmssSSS format\>. For example, wmiob2b_20200623062905325.
Retain original file name Enable this property to retain the original file name when you upload the document to the SFTP server.
Append timestamp to the file name Enable this property to append a timestamp to the file name when you upload the document to the SFTP server. The format of the timestamp is YYYYMMDDhhmmssSSS. It is enabled by default.
Important: When Append timestamp to the file name is disabled, then you must ensure to avoid creating files with duplicate names. A few cloud platforms permit overwriting the previously saved file with the new file. In such a scenario, you might inadvertently replace the existing files with the new files, resulting in the loss of data in the old file.
File extension Upload the file to the SFTP server with a preferred file extension.
Note: Convert the file to the configured file extension before you save it to avoid document corruption issues. For example, when you specify the extension as ".pdf" for a ".png" file, convert the PNG format to pdf format before you save it to the SFTP server.
Document delivery rate
Enable Limit the rate at which the documents must be delivered to the endpoint. Persist the document in the database, so this option can be used to deliver the documents in a regulated manner.
Maximum number of requests per minute Specify the maximum number of business documents that can be delivered to the outbound channel endpoint. You can tune this rate based on the performance of the partner systems that receive the business documents on this endpoint. The default value is 1 (minimum). The maximum value is 1000.

Mapping the SFTP-OUT Channel with a Partner

To associate a partner with an outbound channel, see Associating an Outbound Channel with a Partner.