SFTP Read Agent Service (com.ibi.agents.XDSFTPReadAgent)

Syntax:

com.ibi.agents.XDSFTPReadAgent

iIT Service Object:

format: SFTP Read Agent

Description: Reads a file via SFTP and returns the read result.

Parameters:

Parameter

Description

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

File Name *

The name of the file or XML tag from the input document in which to find the file name.

File Name not a Document Tag *

The File Name is not a tag. False if the File Name is a document tag. Otherwise True if the File Name evaluates to a valid file name.

Base Path

An optional directory to be used if the incoming name is not absolute.

Enclose Tag

The name of the tag in which to enclose the data read. If omitted, there is no entagging. If used, the output is XML.

Input Data Format

The format of the input data. The default is flat.

Encoding

The character set encoding to be performed on the input.

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.

Special Register Namespace *

The prefix to give to any Special Register that is generated by the agent (for example, ftp.read, sftp.read, etc.). Do not terminate the Namespace with a dot (.). That will be be done automatically by the Service Manager. If not specified, the default value of sftp will be used.

Edges:

The following table lists the available Line Edges for the SFTP Read Agent Service (com.ibi.agents.XDSFTPReadAgent).

Line Edge

Description

OnError

An exception occurred during execution.

OnSuccess

The operation was successful.

OnFailure

A fail condition occurred during execution.

OnParseError

Could not parse a document.

OnFailedConnection

Could not connect to the external system.

OnFailedOperation

Could not perform the operation requested .

OnFailSecurity

Could not operate dues to a security violation..

OnNotFound

The resource was not found and this is considered an error.

fail_delete

Cannot delete the file.