Renames a directory or folder. This action can optionally move the renamed folder to a new location. If the folder specified contains sub-folders and files, they will also be included during runtime. Only user-created folders can be renamed. System or special folders cannot be renamed. Commonly used to rename and/or move a single directory and all of its subdirectories.
Declaration
<AMRENAMEFOLDER FOLDER="text" NEWNAME="text" RESULTDATASET="text" />
Example 1 - Rename Folder action used to move a folder and its files from one directory to the another. The original folder name is specified.
<AMRENAMEFOLDER FOLDER="C:\FolderName" NEWNAME="C:\NewFolderName" RESULTDATASET="FolderRenameDS" />
Example 2 - Rename Folder action used to rename a folder to a new name as well as move it to another location.
<AMRENAMEFOLDER FOLDER="C:\FolderName" NEWNAME="C:\NewFolderName" RESULTDATASET="FolderRenameDS" />
See Also
Join File, Copy File, Delete File, Delete Folder, Create Folder, Touch File, Calculate File Checksum, Concatenate Files, Get File(s) information, About Datasets
|
Property |
Type |
Required |
Default |
Markup |
Description |
|
Original Folder Name |
Text |
Yes |
(Empty) |
a)FOLDER="c:\sourcefolder\" b)FOLDER="c:\sourcefolder\subfolder" |
Specifies the path and folder name of the folder(s) to rename. |
|
New Folder Name |
Text |
Yes |
(Empty) |
a)NEWFOLDER="c:\destfolder\" b)NEWFOLDER="c:\destfolder\subfolder" |
The new destination and/or folder name or the new destination folder and (optionally) 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. |
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
The Error Causes tab allows you to select/omit specific errors that should cause a particular step to fail.
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
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.