Rename Action Icon

Rename File

Declaration

<AMFILERENAME SOURCE="text" DEST="text" SUBFOLDERS="yes/no" KEEPFOLDERSTRUCT="yes/no" OVERWRITE="yes/no" ISNEWER="yes/no"  OVERWRITEREADONLY="yes/no" OVERWRITEHIDDEN="yes/no" ONLYIFEXIST="yes/no" ISNEWERTHAN="date" ISOLDERTHAN="date" ARCHIVETURNOFF="yes/no" EXCLUDE="text" ATTRFILTER="text" RESULTDATASET="Text" />

See Also

Split File | Move File | Create Folder | Delete File | Delete Folder | Rename Folder | Remove Folder | Touch File | Set Attributes | Read from File | Write to File | Synchronize Folders | Concatenate Files

File System - Rename

Declaration

<AMFILERENAME SOURCE="text" DEST="text" SUBFOLDERS="yes/no" KEEPFOLDERSTRUCT="yes/no" OVERWRITE="yes/no" ISNEWER="yes/no"  OVERWRITEREADONLY="yes/no" OVERWRITEHIDDEN="yes/no" ONLYIFEXIST="yes/no" ISNEWERTHAN="date" ISOLDERTHAN="date" ARCHIVETURNOFF="yes/no" EXCLUDE="text" ATTRFILTER="text" RESULTDATASET="Text" />

See Also

Change Folder | Concatenate Files | Copy | Create Folder | Delete | Get Checksum | Join Files | Move | Read From File | Rename | Split File | Synchronize Folders | Touch | Write To File

Description

Renames one or more folders or files from a source path to a destination path. This activity supports multiple folder/file renaming, such as for the purpose of adding a date or changing the extension on a group of files. To specify more than one folder/file, use wildcard characters (* or ?). To specify multiple folder/file names or wildcard masks, separate them with a pipe symbol (Example: c:\*.txt|c:\*.bak). Files can also be renamed to a new location.

Practical Usage

Commonly used as an organization tool to automate the renaming of multiple folders or files. For instance, files can be renamed to include the current date/time, the parent folder name, department name, etc.

Parameters

General Properties

Property

Type

Required

Default

Markup

Description

File/Folder

Text (Options)

Yes

File

MODE="folder"

Indicates what this activity should be performed on. The available options are:

  • File (default) -  This activity should be performed on file(s). A file is the common storage unit in a computer. All programs and data are contained in a file, and the computer reads and writes files.

  • Folder - This activity should be performed on folder(s). A folder holds one or more files, although a folder can also be empty. Folders provide a method for organizing files similar to a manila file folder containing paper documents in a file cabinet.

Different parameters may become available depending on which option is selected.

Original File Name

Text

Yes

(Empty)

  1. SOURCE="c:\sourcefolder\file.txt"

  2. SOURCE="c:\sourcefolder\*.txt"

  3. SOURCE="c:\folder\*.txt|c:\folder\*.bak"

  4. SOURCE="c:\foldername\subfoldername

Specifies the folder(s) or file(s) to rename. This can be a fully qualified path and folder/file name (preferred) or a file name only (requires use of the Change Folder action). Wildcard characters (* or ?) may be used to rename folders/files matching a certain mask. Multiple files and file masks may be specified by separating the entries with a pipe symbol (Example: c:\*.txt|c:\*.bak).

New Name

Text

Yes

(Empty)

  1. DEST="c:\destfolder\file.txt"

  2. DEST="c:\destfolder\*.txt

  3. DEST="c:\destfolder\*.*"

  4. DEST="c:\destfolder\

Indicates the destination folder and (optionally) the filename for the files being renamed. This can be a fully qualified path or a filename. Folders specified that do not exist will be automatically created at runtime. Wildcard characters (* or ?) may be used.

Create and Populate Dataset with Result Information

Text

No

(Empty)

RESULTDATASET="DatasetName"

The name of a dataset to be created and populated with status regarding this operation. More information about the fields that this dataset creates are entered below under Notes.

File Options Properties

Property

Type

Required

Default

Markup

Description

Include Subfolders

Yes/No

No

No

SUBFOLDERS="YES"

If set to YES, denotes that, if present, subfolders should be searched for files matching the mask specified in the Source parameter. If set to NO (default value), subfolders are altogether ignored.

Preserve Folder Structure

Yes/No

No

Yes

KEEPFOLDERSTRUCT="NO"

If set to YES (default value), subfolders found in the source folder will be created in the destination folder and source files will be moved into their respective folders rather than directly into the root of the target folder specified in the Destination parameter. If set to NO, source files will be moved into the root of the target folder instead. This parameter is active only if the Include Subfolder parameter is set to YES.

Include Empty Subfolders

Yes/No

No

No

EMPTYFOLDERS="YES"

If set to YES, subfolders found in the source folder will be created in the destination folder even if they do not contain any files. If set to NO (default value), empty subfolders are ignored. This parameter is active only if the Include Subfolder parameter is set to YES.

Only Folder Structure

Yes/No

No

No

ONLYFOLDERSTRUCT="YES"

If set to YES, subfolders found in the source folder will be created in the destination folder but no files will be moved. Enabling this option causes all other file-specific parameters to be ignored. This parameter is set to NO by default and active only if the Include Subfolder parameter is set to YES.

Overwrite if Exist

Yes/No

No

No

OVERWRITE="YES"

If set to YES, matching destination files will be overwritten. This parameter is set to NO by default.

Only if Newer

Yes/No

No

No

ISNEWER="YES"

If set to YES, only source files that are newer than those that match in the destination folder will overwrite existing files. Set to NO by default. This parameter is active only if the Overwrite if Exist parameter is set to YES.

Only if Exist in Destination

Yes/No

No

No

ONLYIFEXIST="YES"

If set to YES, only files that already exist in the destination will be moved from the source. All other files, regardless of whether they match the mask or other parameter settings will be bypassed. This parameter is set to NO by default and is active only if the Overwrite if Exist parameter is set to YES.

Overwrite Read-Only Files

Yes/No

No

No

OVERWRITEREADONLY="YES"

If set to YES, already existing files should be overwritten even if the file in the destination is marked with the read-only attribute. By default, read-only files are not overwritten. This parameter is active only if the Overwrite if Exist parameter is set to YES.

Overwrite Hidden Files

Yes/No

No

No

OVERWRITEHIDDEN="YES"

If set to YES, specifies that already existing files should be overwritten even if the file in the destination is marked with the hidden attribute. By default, hidden files are not overwritten. This parameter is active only if the Overwrite if Exist parameter is set to YES.

Turn Archive Attribute Off

Yes/No

No

No

ARCHIVETURNOFF="YES"

If set to YES, specifies that the archive attribute of the source files should be switched OFF. The Windows archive attribute is generally used to track whether a file has been backed-up. Turning the source file's archive attribute off indicates to many backup programs that the file has already been backed-up. This parameter is set to NO by default.

Exclude Mask

Text

No

(Empty)

EXCLUDE="*.txt"

Causes this action to omit files matching the mask(s) specified. File names or wildcard masks may be used. Multiple entries may be specified by separating them with a pipe symbol (|), for example: *.txt|*.bak

Only if Newer Than

Date

No

(Empty)

ISNEWERTHAN=

"%DateSerial(2001,10,12) + TimeSerial(00,00,00)%"

If enabled, causes this action to only act on files that are newer than the date/time specified. If this parameter is left blank or disabled (default), file dates are ignored.

Click the Custom button to select from a list of pre-defined date parameters. Enable the Expression option to allow entry of a date/time expression.

Only if Older Than

Date

No

(Empty)

ISOLDERTHAN=

"%DateSerial(2001,10,12) + TimeSerial(00,00,00)%"

If enabled, causes this action to only act on files that are older than the date/time specified. If this parameter is left blank or disabled (default), file dates are ignored.

Click the Custom button to select from a list of pre-defined date parameters. Enable the Expression option to allow entry of a date/time expression.

File Filters Properties

Attributes Properties

Property

Type

Required

Default

Markup

Description

Attributes

Text (Options)

No

(Empty)

 

 

a)ATTRFILTER="+R+A-H"

b)ATTRFILTER="-S"

 

This group of settings causes the action to filter which files are moved based on the attribute settings of the source file(s). In visual mode, a group of controls are provided to assist in the selection of this parameter. In markup mode, a single text item must be specified that contains the attributes of the files you wish to move.

Available Options:

  • R—Read-only: Specifying "+R" causes files with this attribute turned on to be included, "-R" causes files with this attribute turned off to be included, not specifying the letter (default) causes this attribute to be ignored.

  • A—Archive: Specifying "+A" causes files with this attribute turned on to be included, "-A" causes files with this attribute turned off to be included, not specifying the letter (default) causes this attribute to be ignored.

  • S—System: Specifying "+S" causes files with this attribute turned on to be included, "-S" causes files with this attribute turned off to be included, not specifying the letter (default) causes this attribute to be ignored.

  • H—Hidden: Specifying "+R" causes files with this attribute turned on to be included, "-H" causes files with this attribute turned off to be included, not specifying the letter (default) causes this attribute to be ignored.

  • C—Compression: Specifying "+C" causes files with this attribute turned on to be included, "-C" causes files with this attribute turned off to be included, not specifying the letter (default) causes this attribute to be ignored.

 

Attributes Tab

Description Properties

The Description tab allows you to customize the text description of any step as it appears in the Task Builder's Steps Pane.

More on setting custom step description

Error Causes Properties

The Error Causes tab allows you to select/omit specific errors that should cause a particular step to fail.

More on Error Causes properties

On Error Properties

The On Error tab allows you to determine what the task should do if a particular step encounters an error.

More about On Error properties

Notes

Datasets

A dataset is a multiple column, multiple row container object. This activity creates and populates a dataset containing a specific set of fields. The table below describes these fields (assuming the dataset name assigned was theDataset).

Name

Type

Return Value

theDataset.Source

Text

The path and file name of the source folder/ file.

theDataset.Size

Number

The size of the folder/file (in kb).

theDataset.Destination

Text

The path and file name of the destination file.

theDataset.Result

True/False

Returns TRUE if result of activity is a success, otherwise, returns a FALSE.

theDataset.Message

Text

The textual information associated to the result.

Variables and Expressions

All text fields allow the use of expressions, which can be entered by surrounding the expression in percentage signs (example: %MYVARIABLE%, %Left('Text',2)%). To help construct these expressions, you can open Expression Builder from these fields by pressing F2.

More on variables
More on expressions

More on the expression builder

Example

 

NOTE: The code below can be copied and pasted directly into the Steps pane of the Task Builder.

 

Sample 1 - Move File action used to rename an entire directory (including all sub-directories) to another location.

 

<AMFILERENAME SOURCE="c:\sourcefolder\*.*" DEST="c:\destfolder\*.*" SUBFOLDERS="YES" OVERWRITE="YES" ISNEWERTHAN="%DateAdd( &quot;d&quot;, 30, CStr( Now() )%" />

 

 

Sample 2 - Move File action used to rename only files that are newer than 30 days excluding text files and overwrite existing files. The action will also create and populate a dataset with details of the files being moved.

 

<AMFILEMOVE SOURCE="c:\folder1\*.*" DEST="c:\folder2\" OVERWRITE="YES" ISNEWERTHAN="%DateAdd( &quot;h&quot;, -24, CStr( Now() ))%" EXCLUDE="*.txt" RESULTDATASET="MoveFileDataset" />

 

 

Sample 3 - Move File action used to rename the file being moved.

 

<AMFILEMOVE SOURCE="c:\folder1\originalfilename.txt" DEST="c:\folder2\newfilename.txt" OVERWRITE="YES" />

 

↑ Top of Page