Copyright © Cloud Software Group, Inc. All Rights Reserved

Rename File

Activity

The Rename File activity is used to rename or move files. This activity can also rename directories, but you cannot use this activity to move a directory to a new location.

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.
Overwrite	Yes	Overwrite existing file with the same name, if one exists when renaming or moving. The activity raises an exception if the specified file or directory exists and this field is unchecked.
Create Destination Directory	Yes	Creates all directories in the specified destination path where the file is moved to, if the directories do not already exist. If this field is unchecked and one or more directories in the specified path do not exist, an exception is raised.

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
fromFileName	string	The path and name of the file to rename or move, or the path and name of the directory to rename. The value in this element must be an absolute path.
toFileName	string	The new name and location of the file or directory. Files can be moved to a new location, but directories must remain in the same location. The value in this element must be an absolute path.

Output

The output for the activity is the following.

Output Item	Datatype	Description
fileInfo	complex	Element containing the fileName, location, type, readProtected, writeProtected, and size data.
fullName	string	The name of the file (or directory), including the path information.
fileName	string	The name of the file or directory without the path information.
location	string	The path to the file or directory.
configuredFileName	string	This element is not populated by this activity.
type	string	The file type.
readProtected	boolean	Whether the file (or directory) is read-protected.
writeProtected	boolean	Whether the file (or directory) is write-protected.
size	integer	Size of the file in bytes.
lastModified	string	Time stamp indicating when the file was last modified.

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...
FileNotFoundException	The file does not exist.
IllegalRenameException	The destination file exists and its type is different than the type of the source file.
FileAlreadyExistsException	The file already exists.
FileIOException	An I/O exception occurred when trying to rename the file or directory. This exception is also thrown if an attempt is made to move a directory.

Copyright © Cloud Software Group, Inc. All Rights Reserved