Copyright © Cloud Software Group, Inc. All Rights Reserved

FTP DIR

Activity

The FTP DIR activity provides a listing of files in the specified directory of the FTP server.

Configuration

The Configuration tab has the following fields.

Field	Global Var?	Description
Name	No	The name to appear as the label for the activity in the process definition.
Description	No	Short description of the activity.
FTP Connection	No	Path to the shared configuration resource containing the user information such as host name, user name, and password. See FTP Connection for more information.
Quit (post-command)	No	When checked, this field specifies that the FTP connection should be closed after completing this command. If this field is not checked, the FTP connection remains open so that 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	Yes	Specifies to use the NLST command instead of the DIR command. The DIR command produces verbose output including file size, modification time, and permissions. NLST produces only a list of filenames.

Input

See TIBCO ActiveMatrix BusinessWorks Process Design for more information about mapping and transforming input data.

The input for the activity is the following.

Input Item	Datatype	Description
Host	string	The name of the FTP server. This overrides the value specified in the FTP Connection resource.
Port	integer	Port number for incoming FTP requests on the FTP server. This overrides the value specified in the FTP Connection resource.
UserName	string	Username for logging into the FTP server. This overrides the value specified in the FTP Connection resource.
Password	string	Password for logging into the FTP server. This overrides the value specified in the FTP Connection resource.
DirParameters	string	Command parameters to pass to the DIR or NLST command.
Directory	string	Path to the directory for which you want to list the files. This parameter is optional, and 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 resource. See FTP Connection for more information.

Output

The output for the activity is the following.

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.

Error Output

The Error Output tab lists the possible exceptions that can be thrown by this activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information about error codes and corrective action to take.

Exception	Thrown When...
ConnectionErrorException	An error occurred when connecting to the FTP server.
CommandExecutionException	An error occurred when executing the FTP command.

Copyright © Cloud Software Group, Inc. All Rights Reserved