Definition

Specify a label for this task.

Specify the path and file name of a single file to rename.

Specify the name of a variable of type File List which contains the files to rename. For example, ${variableName}

Specify a new name for the file. New Name can only be used if a single file is being renamed.

Specify the action to take when the destination file already exists. The default value is 'rename' which changes the destination file name to a new name so the existing file remains untouched.

Specify a pattern to search and replace in the file name(s). Both regular expressions and wildcard search patterns can be used and can be changed using the Pattern Type attribute.

Specify the type of pattern to use when using search and replace on the file names.

Specify the pattern to replace in the file names. If using regular expressions and groups of the file names were captured, use the syntax $1, $2, etc... to reuse the captured segments. If using wildcard search and replace, use character * and ? to reuse the values the * and ? represented in the search for value.

Specify whether or not to use case sensitive matching when searching and replacing sections of the file names.

Specify the string to prepend to the file names.

Specify the string to append to the end of the file names.

If desired, specify the name of a variable which will contain the number of file names successfully modified by this task. The variable will be created if it does not exist.

If desired, specify the name of a variable which will contain the renamed files. The variable will be of type File List and may be used in subsequent tasks that accept a File List input variable. The variable will be created if it does not exist.

The version of this task.

Specify the level of logging to use while executing this task. Valid options are - silent, normal, verbose and debug.

Specify a condition that must be satisfied before this task can be executed. This task will be skipped if the specified condition is not met.

Whether or not this task is disabled.

Specify the action to take when this task errors out. Valid options are - abort, continue, call:[module] and setVariable:[name]=[value]. For call:[module] replace [module] with the name of the module in the project (e.g. call:ErrorModule). For setVariable:[name]=[value] replace [name] with a variable name and [value] with the variable value (e.g. setVariable:error=true).