Configuring a FTP Direct Transfer to Disk Service

The FTP Direct Transfer to Disk service is used to read or write files directly from a FTP 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 FTP server. If you select transfer as a value for the Transfer Type parameter, then the file is moved from the FTP server directory specified in the Host Directory parameter, to the Working Directory in iSM.

Reference: FTP Direct Transfer to Disk Service Parameters

The following table lists and describes parameters for the FTP Direct Transfer to Disk service.

Parameter

Description

Configuration parameters for FTP Direct transfer to disk service

Host Name (required)

The DNS name (or IP address) of the FTP server that you want to connect to. Use the host:port format if the standard port is not 21.

Remote Port

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

User Name (required)

A valid user ID for the FTP server.

Password (required)

A valid password for the FTP server.

Account Name

A valid account for the FTP server.

Use Passive

If set to true, a PASV command is used. Otherwise, the PORT command is used. Select one of the following options from the drop-down list:

true. Use PASV.

false. Use Active.

Timeout

The timeout interval (in seconds) for the socket.

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.

Connection Retry

The number of retry attempts that were made after failed connections to the FTP server.

Agent Parameters

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.

Transfer Mode (required)

When files are transferred in ASCII mode, the transferred data is expected to contain only character-formatted text. Binary mode refers to transferring files as a binary stream of data. Where ASCII mode may use special control characters to format data, Binary mode transmits the raw bytes of the file being transferred. In this way, the file is transferred in its exact original form. Select one of the following options from the drop-down list:

ascii. The file is a text-based document.

binary. Data is transferred as is and without textual evaluation.

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 FTP server.

send. Sends the file from iSM to the FTP 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:

true. Deletes the file.

false. Leaves the file as is.

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.

SSL Parameters

Use SSL

If set, the connection is secured through the Secure Sockets Layer (SSL) protocol. Select one of the following options from the drop-down list:

true. Use SSL.

false. Do not use SSL.

Security Protocol

Determines the security protocol to be used. Select one of the following options from the drop-down list:

SSL. Supports some version of SSL.

SSLv2. Supports SSL version 2.

SSLv3. Supports SSL version 3.

TLS. Supports some version of TLS.

TLSv1. Supports TLS version 1.

Secure Data Connection

Use a secure data connection (for example, to transfer data securely). This parameter is used in conjunction with Secure Control Connection. Select one of the following options from the drop-down list:

true. Use SSL with the data connection.

false. Do not use SSL with the data connection.

Use 128-bit Encryption

Enforces the use of 128-bit encryption. Select one of the following options from the drop-down list:

true. Use 128-bit encryption.

false. Do not use 128-bit encryption.

SSL Security (required)

Determines the FTP server connection type. Select one of the following options from the drop-down list:

Unknown. Initially attempts Explicit Security then fails over to Implicit Security. (default).

Explicit. In order to establish the SSL link, Explicit Security requires that the FTP client issue a specific command to the FTP server after establishing a connection. The default FTP server port is used.

Implicit. Implicit security automatically begins with an SSL connection as soon as the FTP client connects to an FTP server. In implicit security, the FTP server defines a specific port for the client (typically 990) to be used for secure connections.

Keystore File or Keystore Security Provider

Keystore file or keystore security provider full path to the keystore file, which provides certificate material to be used for a SSL connection. Specify the name of a keystore security provider, or leave blank to use the configured default keystore security provider.

Keystore Password

The password to access the Keystore file. This value is not required if the keystore file or keystore security provider is the name of a keystore security provider.

Keystore Type

The type of keystore. This value is not required if the keystore file or keystore security provider is the name of a keystore security provider.

Edge	Description
success	Operation completed successfully.
fail_parse	Failed to properly parse the input parameters of the service.
fail_connect	Failed to connect to FTP host for any one of the following reasons: The host name (IP) is invalid. The User ID is invalid. The password of the user is invalid. The connection failed.
fail_operation	Invalid parameters or other error.

Parameter	Description
Configuration parameters for FTP Direct transfer to disk service
Host Name (required)	The DNS name (or IP address) of the FTP server that you want to connect to. Use the host:port format if the standard port is not 21.
Remote Port	The port to connect to on the FTP site. Leave it blank for default port 21.
User Name (required)	A valid user ID for the FTP server.
Password (required)	A valid password for the FTP server.
Account Name	A valid account for the FTP server.
Use Passive	If set to true, a PASV command is used. Otherwise, the PORT command is used. Select one of the following options from the drop-down list: true. Use PASV. false. Use Active.
Timeout	The timeout interval (in seconds) for the socket.
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.
Connection Retry	The number of retry attempts that were made after failed connections to the FTP server.
Agent Parameters
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.
Transfer Mode (required)	When files are transferred in ASCII mode, the transferred data is expected to contain only character-formatted text. Binary mode refers to transferring files as a binary stream of data. Where ASCII mode may use special control characters to format data, Binary mode transmits the raw bytes of the file being transferred. In this way, the file is transferred in its exact original form. Select one of the following options from the drop-down list: ascii. The file is a text-based document. binary. Data is transferred as is and without textual evaluation.
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 FTP server. send. Sends the file from iSM to the FTP 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: true. Deletes the file. false. Leaves the file as is.
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.
SSL Parameters
Use SSL	If set, the connection is secured through the Secure Sockets Layer (SSL) protocol. Select one of the following options from the drop-down list: true. Use SSL. false. Do not use SSL.
Security Protocol	Determines the security protocol to be used. Select one of the following options from the drop-down list: SSL. Supports some version of SSL. SSLv2. Supports SSL version 2. SSLv3. Supports SSL version 3. TLS. Supports some version of TLS. TLSv1. Supports TLS version 1.
Secure Data Connection	Use a secure data connection (for example, to transfer data securely). This parameter is used in conjunction with Secure Control Connection. Select one of the following options from the drop-down list: true. Use SSL with the data connection. false. Do not use SSL with the data connection.
Use 128-bit Encryption	Enforces the use of 128-bit encryption. Select one of the following options from the drop-down list: true. Use 128-bit encryption. false. Do not use 128-bit encryption.
SSL Security (required)	Determines the FTP server connection type. Select one of the following options from the drop-down list: Unknown. Initially attempts Explicit Security then fails over to Implicit Security. (default). Explicit. In order to establish the SSL link, Explicit Security requires that the FTP client issue a specific command to the FTP server after establishing a connection. The default FTP server port is used. Implicit. Implicit security automatically begins with an SSL connection as soon as the FTP client connects to an FTP server. In implicit security, the FTP server defines a specific port for the client (typically 990) to be used for secure connections.
Keystore File or Keystore Security Provider	Keystore file or keystore security provider full path to the keystore file, which provides certificate material to be used for a SSL connection. Specify the name of a keystore security provider, or leave blank to use the configured default keystore security provider.
Keystore Password	The password to access the Keystore file. This value is not required if the keystore file or keystore security provider is the name of a keystore security provider.
Keystore Type	The type of keystore. This value is not required if the keystore file or keystore security provider is the name of a keystore security provider.