SFTP Direct Transfer Service (com.ibi.agents.XDSFTPDirectFileTransfer)

Host Name *

The DNS name (or IP address) of the SFTP server that you want to connect to.

Remote Port *

The port to connect to on the SFTP site. Leave blank for default port 22.

Buffer Size

The size of the SFTP buffer to be used when sending or retrieving data. The default value of 32768 is used if this field is not set. A larger buffer may improve performance, but setting this field to a value greater than 65536 will default to 65536. The value must be entered as a whole number (for example, 32768, 65536). iWay recommends leaving the buffer size at 32768.

Proxy Settings

Proxy Type

The proxy protocol to use.

Proxy Host Name

The DNS name (or IP address) of the proxy server that you want to connect to.

Proxy Port

The port to connect to on the proxy site.

Proxy User ID

The user ID on the proxy server.

Password

The proxy user's password on the proxy server.

SSH Parameters

User Name

The user ID on the SSH-enabled server.

Password

The user's password on the SSH-enabled server.

Private Key

The path to the private key file for public-key authentication..

Passphrase

The passphrase used to protect the Private Key.

Provider

The name of the SSH Client Security Provider to use. If no Provider name is specified, enter the user name and either a password or a Private Key and passphrase values (Passphrase is required only if the Private Key file is passphrase protected).

Validate Host Keys

If set to true, keys sent from SSH hosts are validated. If valid, the keys are cached by this server. If false, any host key will be accepted by this server.

Host Key Repository

The path to the Known Host Keys repository on this server.

Agent Parameters

Use SCP

Use Secure Copy protocol for file copy. Not all servers support the use of SCP.

Name of File *

The file to be read or written. Relative or absolute file paths are supported explicitly or through an SREG or XPATH expression evaluated using the incoming document.

Host Directory

An optional directory to be used if Name of File is not absolute.

Working Directory *

The path to the iSM working directory.

Transfer Type *

The direction of transfer. Select retrieve to retrieve the file from the server. Select send to send the file to the server.

Return

• status - a status document will be the out document.
• input - the in document will become the out document.

File Protect

Emit a temporary name, and then rename it to the desired name.

Delete After Read

This parameter configures the action to be taken after the read. The options are:

• Keep - Do not delete the file (this is the default).
• Delete - delete the file immediately after the read.
• Delete on Success - This is a transactional delete if the listener supports transactions. Otherwise the file is deleted immediately after the file is read. If the listener supports transactions, the file is not deleted unless the flow ends in success. Note: The connection to the SFTP server is maintained until that time. Users are strongly cautioned that use of this option within an iteration can result in a holding of connections to the server, which in turn can cause subsequent connection failures and resource buildup.

Action on Failure

Determines whether an input document or status document is returned on failure.

Connection Retry

Determines the attempted failed connects to the SFTP server.

Retry Interval

Retry interval in seconds (allows for xxhxxmxxs format). Omit or use 0 for no retry.