Copyright © Cloud Software Group, Inc. All Rights Reserved

FTP Rename File

Activity

The FTP Rename File activity renames the specified file on the remote 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.

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.
OldRemoteDirectory	string	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. This element is optional.
OldRemoteFilename	string	Name of the remote file you want to rename. You can optionally include the complete path of the file to rename.
NewRemoteDirectory	string	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. This element is optional.
NewRemoteFilename	string	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 resource. See FTP Connection for more information.

Output

This activity produces no output.

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