Configuring a FTP Directory Contents Service

Reference:

The FTP Directory Contents service is used to generate an XML document listing the contents of a FTP 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>
</dir>

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.

Output

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 FTP Directory Contents service:

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

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

Reference: FTP Directory Contents Service Parameters

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

Parameter

Description

Configuration parameters for FTP Directory Contents 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 Command

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

Directory

What directory should be listed. This is the name of the directory on the FTP server that is to be listed. If the directory does not exist on the server the agent will return on a failure edge.

Include

What items should be included in the listing. Select from the dropdown list what items that should be included in the listing:

  • File: File entries only.
  • Sub-directory: Directory entries only.
  • All: Both files and directory entries.

Selection 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.

Call EOD

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.

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.