SFTP File Ops Agent Service (com.ibi.agents.XDSFTPFileOpsAgent)

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

Operation *

The command to execute when agent goes active.

File (from) *

The originating file to be operated on. Relative or absolute file paths are supported through an SREG or XPATH expression evaluated using the incoming document.

File (to)

The destination file to be operated on. Wild cards are accepted. Required except for delete and size exist.

File (to) a directory name

File (to) references a directory. If it is unclear whether the path names a directory or a filename, the Service Manager will assume the path names a file.

File (to) Create Directories

Create if the directory doesn't exist. Used only for Copy, Move, Rename, and Append operations.

Remote Size or Permissions

The name of the Special Register designated to hold size (if Operation is size), or the file's octal permissions (if Operation is chmod). This field is required when the Operation is either size or chmod.

Out Document *

The document returned by operation (bad input defaults to result).

Action on Failure *

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

Retry *

If non-zero, will retry the operation n times at one-second intervals.