Rename File

The Rename File object renames files on the local file system or on a network location specified using a UNC path.

Note: This object replaces the Rename File Legacy object. For more information, see the Legacy topic.

How it is used

Use the Rename File object to automatically rename files to a standard format according to data center procedures.

Configuration

To configure the Rename File object you need to know the original name of the file that you are renaming and the name that you are changing it to.

Details Tab

 

Folder	Type the path of the folder that contains the files that you want to rename.
Include sub-folders	Select this option to rename any files within the sub-folders of the folder that you specified that match the filenames that you want to print.
Destination	This list displays all the filenames that will be renamed when this object is executed. To add a filename, click Add and specify the old name and new name of the file. You can edit or remove a value by selecting it and clicking Edit or Remove respectively.

Advanced Tab

 

File age	Specify is less than or is more than to rename the files that are older or newer, respectively, than the number of days that you specify.
days	Type the number of days that you will use with the File age measure.
Date of rename	Select this option to set the date of the file at the destination to the date when it was renamed.
Same as original	Select this option to set the date of the file at the destination to the date of the original file.
Destination already exists	Select the action that you want to take if a file with the same name already exists in the folder: • Create a file with a unique name - Select this option to append a value to the filename to create a unique name that does not conflict with an existing name. • Overwrite - Select this option to overwrite the existing file with the file that is being renamed. • Fail - Select this option to cause the Rename File object to fail if the filename already exists.

Available Published Data

 

Name	Description
File path	The path of the file that was renamed.
Include sub-folders	Indicates whether this option was selected or not.
Destination folder	The destination folder of the file that was renamed.
If destination exists	The option that was selected for handling the filename if the file existed in the destination folder.
Modified date option	The option that was selected for assigning a modified date to the file in the destination folder.
File age days	The number of days used in the File age filter.
Destination date	The option that was selected for assigning a destination date to the file in the destination folder.
Total number of files to be renamed	The number of files that were renamed by the operation.
Number of successful file operations	The number of successful operations that occurred.
Number of failed file operations	The number of failed operations that occurred.
Origin folder	The folder where the file originated from.
Name and path of the destination file	The name and path of the destination file.
File name	The filename of the origin file.
Name and path of the file relative to the origin folder	The relative path of the file, relative to the origin folder.
Name and path of the origin file	The name and path of the origin file.
File operation status	The status of the rename operation.
Pattern that matched file	The pattern that the user entered that matched the file or files that were found.
Pattern file renamed to	The pattern that the file or files were renamed to.

Common Published Data