Configuring a FTP Listener



To configure a FTP listener:

  1. Perform the steps as described in Configuring Listeners.
  2. Ensure that you select FTP[S] Client as the listener type to configure.

    For a complete description of the configuration parameters that are available for the FTP listener, see FTP Listener Configuration Parameters.

    For a complete description of the FTP listener Special Registers (SREGs), see FTP Listener Special Registers.

Reference: FTP Listener Configuration Parameters

The following table lists and describes parameters for the FTP listener.

Note: Parameters that are common to FTP listeners are described in Listener Configuration Parameters.



Host Name (required)

The FTP host to be accessed to search for the document.

User Name (required)

The user ID on the FTP host.

Password (required)

The user password on the FTP host.

Account Name

The name of the account on the FTP server. This is optional, depending on the FTP server.

Input Path

The directory on the FTP host from which to retrieve files. Specify the file name or use a DOS-style pattern. Do not use suffix in.

Destination Directory

The directory on FTP host to return response to.


If the destination file exists, then append on PUT.

Pending Directory

The local directory where pending requests are held.

Suffix In

Limits input files to those with the same extension, for example, xml. Do not insert a period (.) before the suffix. A dash (-) indicates no extension, that is, the field is not used.


The maximum time that a document can remain in the retry pending queue.


The interval between retrying pending requests.

Quote Command

The entered command is sent as typed, BEFORE any data transfer begins. Following login to the FTP server, a command is sent to the server, if it is configured. This is often used to accomplish a secondary login.


In ASCII mode, conversions are done (EBCDIC to ASCII and vice versa). In BINARY mode, the data remains unchanged.

Payload Type (required)

Determines what form of payload should be processed. Select one of the following options from the drop-down list:

  • Data. The file contents are passed. This is the default.
  • Signal. A signal document containing the file name is passed. The file contents are not read into memory.

    Note: If Signal is set, then a value for the Local Store Directory parameter must be provided.

Local Store Directory

The directory on the iWay server where files are saved. You must specify a directory path only if the Payload Type parameter is set to Signal.

Remove locally stored files

If set to true, the FTP listener deletes the file stored locally after it is processed. This parameter requires a directory path to be specified for the Local Store Directory parameter.

Do not unzip ZIP files

Pass ZIP files as a single file for processing (requires ACCEPT FLAT turned on).

The default is to unzip ZIP files and process the contents of the ZIP files individually.

Socket Timeout

The value in seconds before the socket connection times out. With this option set to a non-zero timeout, a read() call on the Socket will block for only this amount of time. If the timeout expires, a is raised.

Use Passive Command

If set to true, then use the PASV command. If set to false, them use the PORT command.

Bad File List

If set to true, then maintain a list of files with errors, preventing them from being re-accessed. If set to false, files will not be retried.

Delete After Read

Some FTP servers, such as VANs, automatically delete the file after read. In this case set this to false. If the file is not deleted, it will be reread at each FTP cycle.

File Protect

Emits a temporary name and then renames it to the desired name.


Secure Control Connection

If set to true, then the user ID and password are transferred in a secure manner. If client authentication is required, you may be required to configure the keystore under the HTTPS section of the system properties.

Note: If the keystore is configured in the system properties, ensure it has the CA certificate or the client certificate of the server to which you are connecting.

If the keystore is not configured in the system properties, the default truststores under /lib/security/cacerts is used.

SSL Security

Select one of the following FTP server connection types from the drop-down list:

  • unknown. Defaults to explicit security then fails over to implicit security.
  • 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 a FTP server. In implicit security, the FTP server defines a specific port for the client (typically 990) to be used for secure connections.

Keystore Security Provider

Enter the iWay Keystore Security Provider name. If the component is secure and Keystore Security Provider is left blank, the default Keystore Security Provider is used.

Secure Data Connection

If set to true, transfers data in a secure manner. Used in conjunction with Secure Control Connection.

Use 128-bit Encryption

If set to true, enforces use of 128-bit encryption.

Security Protocol

The protocol to enable security. Security protocol values include:

  • SSL. Supports some version of SSL. May support other versions.
  • SSLv2. Supports SSL version 2 or higher.
  • SSLv3. Supports SSL version 3. May support other versions.
  • TLS. Supports some version of TLS. May support other versions.
  • TLSv1. Supports TLS version 1. May support other versions.


Starting SITE command

The SITE command to issue before the transfer of data.

Successful SITE command

The SITE command to issue after the successful transfer of data.

Error SITE command

The SITE command to issue if the transfer of data fails.

Note: The FTP listener supports streaming. Streaming is used for large documents or for documents where the application needs to split the input into sections under the same transaction. For more information on streaming and configuring streaming preparsers, see the iWay Service Manager Component and Functional Language Reference Guide.

Reference: FTP Listener Special Registers

The following table lists and describes the Special Registers (SREGs) available on the FTP listener.








The current active configuration name.




The base at which the server is loaded.




The path to base of the current configuration.




The physical length of the message payload.




The assigned name of the master (listener).




The protocol on which the message was received.




The full name of the input file.




The file name without an extension.




The extension to the file name (mime type).




The file name using the basename.extension format.




The path to the file name.




Unique transaction ID.

Troubleshooting the FTP Listener

The following table describes an error that you may encounter when using the FTP listener.




Unable to successfully 
log in to FTP: [line 

System path was unable to log on to the FTP host with the supplied host, user ID, and password combination.

Verify that the host, user ID, and password combination is correct.