Skip to content

Rename#

Screenshot showing a user interface for renaming a file or folder.

When activated, the rename task will rename a given file or directory (source) to a different location (destination). The source and destination, can be provided either by the input port or in the task settings.

Screenshot showing a rename operation in progress.

Inputs#

Name Description
source String Source file/directory
destination String Destination file/directory
attempts Integer Number of attempts to perform this operation. Default is 1 attempt
sleepBetweenAttempts Integer Interval of time between the attempts. Default is 1000ms
Activate any Activate the task

Outputs#

Name Data Type Description
Success Boolean Triggered when the task is executed with success
Error Error Triggered when the task failed for some reason

Settings#

On the General tab, you have the usual settings and the following settings:

Name Data Type Values Default Description
Source String Source file/directory
Destination String Destination file/directory
Number of attempts Integer 1 Number of attempts to perform this operation.
Sleep Between Attempts Integer 1000 Interval of time between the attempts.

For the Source and Destination settings you can use tokens as represented below:

Available tokens:
  ${path} - Watched path
  ${archive} - Archive path
  ${temp} - Temporary directory of the user
  ${id} - DriverId ("\" chars replaced with "_")

Examples:
  ${path}\subdir\file.txt
  ${temp}\files\${id}\file.txt
  c:\destination\file.txt
  c:\source\file.txt

Screenshot showing settings options.

Behavior#

In this task you choose a driver when dropping it into the workflow (if you have more than one driver associated with the controller).

Upon activation, will send a Rename command to the driver where it will try to rename the source location (file or directory) into the destination location. If it fails, will retry attemptstimes, waiting sleepBetweenAttempts milliseconds each time.

If the operation is executed with success, a value true is emitted on the Success output. In case of the task , for some reason, is not able perform the copy operation, an Error is emitted.

Remarks#

There is no particular remark to be made.