FTP Dir

FTP Dir is a synchronous activity that provides a sequential list of files in the specified directory of the FTP server.

General

The Genaral tab has the following fields.

Field Literal Value/Module Property/Process Property Description
Name None The name to be displayed as the label for the activity in the process.
FTP Connection Yes The path to the shared configuration resource containing the user information such as host name, username, and password.
Quit (post-command) None Select this check box to specify that the FTP connection should be closed after completing this command.

The FTP connection remains open, if this check box in not selected. As a result, all FTP activities that specify the same FTP session (that is, the same host, port, username, and password), share the FTP session until the connection is closed.

NLST None Selecting this check box specifies to use the NLST command instead of the DIR command.

The DIR command produces verbose output including the file size, modification time, and permissions.

NLST produces only a list of file names.

Description

Provide a short description of the activity.

Input

The following is the input for the activity.

Input Item Datatype Description
Host string The name of the FTP server.

This overrides the value specified in the FTP Connection property.

Port integer The port number for the incoming FTP requests on the FTP server.

This overrides the value specified in the FTP Connection property.

UserName string The username for logging into the FTP server.

This overrides the value specified in the FTP Connection property.

Password string The password for logging into the FTP server.

This overrides the value specified in the FTP Connection property.

DirParameters string The command parameters to pass to the DIR or NLST command.
Directory string An optional parameter. The path to the directory in which you want to list the files.

If null, the current remote directory is listed.

Timeout integer The amount of time to wait for the FTP server to respond. This timeout is used, when the FTP server places the FTP connection used by this activity into a waiting state.

This overrides the value specified in the FTP Connection property.

Output

The following is the output of the activity.

Output Item Datatype Description
ItemCount integer The number of entries returned from the remote directory listing.
DirectoryItems string A repeating element containing the list of items returned.

Fault

The Fault tab lists the possible exceptions generated by this activity. For more information about error codes and the corrective actions to take, see the TIBCO ActiveMatrix BusinessWorks™ Error Codes guide.

Fault Generated When..
CommandExecutionException An error occurred while executing the FTP command.
ConnectionErrorException An error occured while connecting to the FTP server.