Skip to main content
Version: Current

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 settings​

Use Process Data to bind supported inputs to workflow values or upstream outputs. See Common Activity Features for shared execution, error-handling, and output-persistence settings. Availability depends on the activity.

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:

MethodDescription
Select DirectorySelect the folder by browsing IB Drive using the folder picker.
By IdSpecify the unique IB Drive item ID of the folder. This is the default method.
By PathSpecify 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.

note

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.
warning

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.


Execution settings​

Configure Wait All Incoming when execution paths converge, and On Error for failure handling. Select Inherit where available to use the workflow-level error policy.

Outputs​

Folder​

Returns an IB-X Folder Reference for the renamed folder. Bind the whole output to a compatible reference input, or use Id with an IB Drive By Id selector.

PropertyDescription
IdThe unique identifier (GUID) of the renamed folder.
NameThe new name of the folder.
LocationThe logical path of the renamed folder within IB Drive.
ParentIdThe unique identifier (GUID) of the parent folder containing the renamed folder.
SizeThe size associated with the folder. For folders, this is typically 0.
MimeTypeThe content type associated with the folder, if applicable.
CreatedThe UTC date and time when the folder was originally created in IB Drive.
ModifiedThe 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​

Use the returned reference for subsequent operations on the resulting item. IB Drive paths are logical library paths, not physical paths on the workflow host. The conflict and naming rules above apply when the activity executes.