Configuring a SFTP Directory Contents Service


The SFTP Directory Contents service is used to generate an XML document listing the contents of a SFTP directory specified by the user in the Directory parameter. The XML document that is generated has the following pattern:

<dir base="Directory" count="number">
   <item type="Item Type">Name</item>

The content of the document differs based on the Include parameter configured by the user. If the user selects Files, then the item element will contain only file names from the directory. If the user selects Subdirectories, then only the subdirectory names contained in the Directory are included. If the user selects All, then file and subdirectory names are included.


The XML document generated by the service contains only two elements (dir and item).

The element dir is the root element and contains two attributes (name and count). The name attribute contains the Directory entry that was configured by the user. The count attribute contains the number of item elements to follow.

The item element is the only child of the dir element, but can have multiple item siblings. The item element has only one attribute (type). The type attribute identifies the type of name that this item element contains. If the type attribute is set to file, then this item element contains a name of a file. If the type attribute is set to directory, then this item element contains a name of a subdirectory.

To configure a SFTP Directory Contents service:

  1. Perform the steps as described in Configuring Services.
  2. Ensure that you select SFTP Directory Contents {com.ibi.agents.XDSFTPDirListAgent} as the service type you are configuring.

    For a complete description of the configuration parameters that are available for the SFTP Directory Contents service, see SFTP Directory Contents Service Parameters.

Reference: SFTP Directory Contents Service Parameters

The following table lists and describes parameters for the SFTP Directory Contents service.

Property Name

Property Description

Host Parameters

Host Name (required)

DNS name (or IP address) of the SFTP server to which you want to connect. Use host:port format if the standard port is not 22.

Remote Port (required)

Port to connect to on the SFTP site. Leave blank for default port 22.

Buffer Size

Size of the SFTP buffer to be used when sending or retrieving data. The default value of 32768 is used if this parameter value is not specified. 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.

SSH Parameters

User Name

Is the valid user ID on the SFTP server.


Is the valid password for the SFTP server (optional and not used if Private Key is configured).

Private Key

Path to the private key file for public-key authentication.


Passphrase used to protect the Private Key (optional and required only if Private Key is passphrase protected).


Name of the SSH Client Security Provider to use. If no Provider name is specified, then 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.

AGENT Parameters

Directory (required)

Determines what directory should be listed. The directory must exist.


Determines what items should be included in the listing. Select one of the following options from the drop-down list:

  • Files. Include only file names.
  • Subdirectories. Include only subdirectory names.
  • All. Include files and subdirectories.

Select Expression

Regular expression (or filter) used to select files and directories.

Pattern Type

If a value for the Selection Expression parameter is supplied, then this parameter indicates whether it should be interpreted as a regular expression or a DOS style wildcard. Select one of the following options from the drop-down list:

  • Regular Expression. Java-based Regular Expression syntax.
  • DOS-style Wildcard. DOS style wild card syntax. A question mark (?) indicates any single number or character. An asterisk (*) indicates any combination of numbers and characters.

Retry (required)

Retries the operation at the specified number of times (in seconds).

Call at EOS

When using a streaming preparser in a channel, a last call is made after the last document. Determines whether this service exit should be called. Select one of the following options from the drop-down list:

  • true. Calls the service exit.
  • false. Does not call the service exit.