Configuring a SFTP Direct Transfer Service

The SFTP Direct File Transfer service is used to read or write files directly from a SFTP server to iWay Service Manager (iSM).

If you select send as a value for the Transfer Type parameter, then the file is moved from the directory specified in the Working Directory parameter to the SFTP server. If you select transfer as a value for the Transfer Type parameter, then the file is moved from the SFTP server directory specified in the Host Directory parameter, to the Working Directory in iSM.

Reference: SFTP Direct Transfer Service Parameters

The following table lists and describes parameters for the SFTP Direct File Transfer service.

Parameter

Description

Configuration parameters for SFTP Direct transfer service

Host Name (required)

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

Remote Port (required)

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

Buffer Size

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 or 65536). iWay recommends leaving the buffer size set to 32768.

SSH Parameters

User Name

A valid user ID for the SFTP server.

Password

A valid password for the SFTP server.

Private Key

Path to the private key file for public key authentication.

Passphrase

Passphrase used to protect the private key.

Provider

Name of the SSH Client Security Provider to use. If no provider name is specified, then enter the user ID and either a password or a private key and passphrase values. Passphrase is required only if the private key file is protected by a passphrase.

Agent Parameters

Use SCP

Use the Secure Copy protocol for file copy. Not all servers support the use of SCP. Select one of the following options from the drop-down list:

true. Use the Secure Copy protocol for file copy.

false. Do not use the Secure Copy protocol for file copy (default).

Name of File (required)

This is the file to be read. A relative or absolute file path is supported explicitly or through a SREG or XPath expression that is evaluated using the incoming document.

Host Directory

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

Working Directory (required)

The path to the iSM working directory.

Transfer Type (required)

The direction of file transfer. Select one of the following options from the drop-down list:

retrieve. Retrieves the file from the SFTP server.

send. Sends the file from iSM to the SFTP server.

Return 'status'

Determines the return document status. Select one of the following options from the drop-down list:

status. Creates a status document for the return.

input. Returns the inbound document as the output

Delete After Read

Determines whether to delete the file after the read. Select one of the following options from the drop-down list:

Keep. Do not delete the file (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, then 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 holding of connections to the server, which in turn can cause subsequent connection failures and resource buildup.

Action on Failure

Determines whether the input document or status document is returned on failure. Select one of the following options from the drop-down list:

status. Creates a status document for the return.

input. Returns the inbound document.

Connection Retry

The number of attempted failed connections to the SFTP server.

Retry Interval

The retry interval (in seconds) for the socket. The xxhxxmxxs format can be used for this value. Specify a value of zero (0) for no retry interval.

Parameter	Description
Configuration parameters for SFTP Direct transfer service
Host Name (required)	The DNS name (or IP address) of the SFTP server that you want to connect to.
Remote Port (required)	The port to connect to on the SFTP site. Leave it blank for default port 21.
Buffer Size	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 or 65536). iWay recommends leaving the buffer size set to 32768.
SSH Parameters
User Name	A valid user ID for the SFTP server.
Password	A valid password for the SFTP server.
Private Key	Path to the private key file for public key authentication.
Passphrase	Passphrase used to protect the private key.
Provider	Name of the SSH Client Security Provider to use. If no provider name is specified, then enter the user ID and either a password or a private key and passphrase values. Passphrase is required only if the private key file is protected by a passphrase.
Agent Parameters
Use SCP	Use the Secure Copy protocol for file copy. Not all servers support the use of SCP. Select one of the following options from the drop-down list: true. Use the Secure Copy protocol for file copy. false. Do not use the Secure Copy protocol for file copy (default).
Name of File (required)	This is the file to be read. A relative or absolute file path is supported explicitly or through a SREG or XPath expression that is evaluated using the incoming document.
Host Directory	An optional directory to be used if the name of the file is not absolute.
Working Directory (required)	The path to the iSM working directory.
Transfer Type (required)	The direction of file transfer. Select one of the following options from the drop-down list: retrieve. Retrieves the file from the SFTP server. send. Sends the file from iSM to the SFTP server.
Return 'status'	Determines the return document status. Select one of the following options from the drop-down list: status. Creates a status document for the return. input. Returns the inbound document as the output
Delete After Read	Determines whether to delete the file after the read. Select one of the following options from the drop-down list: Keep. Do not delete the file (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, then 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 holding of connections to the server, which in turn can cause subsequent connection failures and resource buildup.
Action on Failure	Determines whether the input document or status document is returned on failure. Select one of the following options from the drop-down list: status. Creates a status document for the return. input. Returns the inbound document.
Connection Retry	The number of attempted failed connections to the SFTP server.
Retry Interval	The retry interval (in seconds) for the socket. The xxhxxmxxs format can be used for this value. Specify a value of zero (0) for no retry interval.