Rename Folder
Description
The Rename Folder activity changes the name of an existing folder in IB Drive.
The folder remains in its current location, and its files and subfolders remain unchanged after the rename operation.
Common Capabilities
Process Data Support
This activity supports dynamic configuration using variables from the Process Data drawer.
You can bind values from Model Data, Form Data, System Data, Enterprise Variables, and Activity Outputs.
Learn more → Using Process Data
Design-Time Configuration
Display Text
Specifies a user-defined name for the activity.
The display text appears on the workflow canvas and can be used to identify the purpose of the activity.
Folder
Specifies the IB Drive folder to be renamed.
The folder can be specified using one of the following methods:
| Method | Description |
|---|---|
| Select Directory | Select the folder by browsing IB Drive using the folder picker. |
| By Id | Specify the unique IB Drive item ID of the folder. This is the default method. |
| By Path | Specify the logical path of the folder within IB Drive, for example /Agents/InvoiceProcessing/Input. |
The value can also be provided dynamically using workflow data.
This property is required.
New Name
Specifies the new name for the folder.
The value can also be provided dynamically using workflow data.
This property is required.
IB Drive folder names:
- Can contain up to 255 characters.
- Cannot contain
\ / : * ? " < > |. - Cannot start or end with a space or period.
- Are case-insensitive within the same parent folder.
If another folder with the specified name already exists in the same parent folder, the activity fails with an error.
The activity does not merge with or overwrite the existing folder, nor does it automatically generate a different name.
Wait All Incoming
Controls how this activity behaves when multiple incoming execution paths converge.
Determines whether the activity executes when:
- any incoming path completes, or
- all relevant incoming paths complete before execution
Learn more → Execution Control
On Error
Defines how the workflow behaves if this activity encounters a runtime error.
Supported strategies include Fault, Continue, Suspend, and Retry.
Outputs
Folder
Returns metadata for the renamed folder.
| Property | Description |
|---|---|
| ItemId | The unique identifier (GUID) of the renamed folder. |
| Name | The new name of the folder. |
| Location | The logical path of the renamed folder within IB Drive. |
| ParentId | The unique identifier (GUID) of the parent folder containing the renamed folder. |
| Size | The size associated with the folder. For folders, this is typically 0. |
| ContentType | The content type associated with the folder, if applicable. |
| Created | The UTC date and time when the folder was originally created in IB Drive. |
| Modified | The UTC date and time when the folder was last modified. |
The returned folder metadata can be used by downstream activities to perform additional operations on the renamed folder.
Remarks
- The specified folder must exist in IB Drive when the activity executes.
- Renaming a folder changes its name but does not move it to another location.
- The files and subfolders contained within the folder remain unchanged.
- The new folder name must comply with the IB Drive naming rules.
- Folder names are case-insensitive within the same parent folder. For example,
Reportsandreportsare treated as the same name. - If another folder with the specified name already exists in the same parent folder, the activity fails with an error.
- The activity does not merge with, overwrite, or automatically rename an existing folder.
- When using By Path, specify the current logical IB Drive path of the folder.