FTP Rename File

FTP Rename File is a synchronous activity that renames the specified file on the remote FTP server.

General

The General tab has the following fields.

Field Literal Value/Module Property/Process Property Description
Name None The name to be displayed as label of 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 you do not select this check box. 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 this 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.

OldRemoteDirectory string An optional element. The path to the remote file you want to rename.

This element is concatenated with the OldRemoteFileName element to provide the complete path to the file to rename.

OldRemoteFileName string The name of the remote file you want to rename.

You can optionally include the complete path of the file to rename.

NewRemoteDirectory string An optional element. The new path for the file to rename.

This element is concatenated with the NewRemoteFileName element to provide the complete path to the file to rename.

NewRemoteFileName string The new name for the remote file.

You can optionally include the complete path of the file.

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

This activity produces no output.

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 when executing the FTP command.
ConnectionErrorException An error occurred when connecting to the FTP server.