FTP Get Default Directory

FTP Get Default Directory is a synchronous activity that retrieves the name of the current remote directory. The default remote directory is operating system dependent and determined by the remote FTP server. On UNIX systems, the default remote directory is usually the home directory of the user account that is used to establish an FTP connection.

General

The General 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. All the FTP activities that specify the same FTP session (that is, the same host, port, username, and password), can share the FTP session until the connection is closed.

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

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 for the activity.

Output Item Datatype Description
CurrentDirectory string The directory currently set on the remote FTP server.

By default, this directory is set by the FTP server. However, you can use the FTP Quote activity to issue an FTP command to change to another directory.

Fault

The Fault tab lists the following 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 when executing the FTP command.
ConnectionErrorException The connection to the FTP server is timed out before the command execution is complete.