Rename Folder Action

Declaration

<AMRENAMEFOLDER FOLDER="text" NEWNAME="text" RESULTDATASET="text" />

See Also

Rename Folder Action-Setting Properties, Copy File, Rename File, Delete File, Delete Folder, Create Folder

Description

Renames a folder. If the new folder name specified contains sub-folders then they will also be created.

Practical Usage

See description.

Parameters

General Tab

Original Folder Name

Text, Required
MARKUP:
a) FOLDER="c:\sourcefoldername\"
b) FOLDER="c:\sourcefoldername\subfoldername"

Specifies the folder or folders to rename.

New Folder Name

Text, Required
MARKUP:
a) NEWFOLDER="c:\newsourcefoldername\"
b) NEWFOLDER="c:\newsourcefoldername\subfoldername"

Specifies the new name for the folder or folders.

Create and Populate Dataset with Result Information

Text, Optional
MARKUP: RESULTDATASET="DatasetName"

Specifies the name of a dataset to be created and populated with the result. In addition to the standard dataset fields, the dataset will contain the following:

Notes

Custom Description

This action includes the Description tab for entering a custom step description.

More on setting custom step description

Standard Error Handling Options

This action also includes the standard Error Causes and On Error failure handling options/tabs.

More on Error Handling Options

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.

<AMRENAMEFOLDER FOLDER="c:\folder1\" NEWNAME="c:\newfoldername\">

<AMRENAMEFOLDER FOLDER="C:\FolderName" NEWNAME="C:\NewFolderName" RESULTDATASET="FolderRenameDS" />