Rename File
Description
The Rename File activity changes the name of an existing file in IB Drive.
The file remains in its current folder and retains its contents 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.
File
Specifies the IB Drive file to be renamed.
The file can be specified using one of the following methods:
| Method | Description |
|---|---|
| Select File | Select the file by browsing IB Drive using the file picker. |
| By Id | Specify the unique IB Drive item ID of the file. This is the default method. |
| By Path | Specify the logical path of the file within IB Drive, for example /Agents/InvoiceProcessing/Input/Invoice.pdf. |
The value can also be provided dynamically using workflow data.
This property is required.
New Name
Specifies the new name for the file.
Include the file extension when specifying the new name, for example ProcessedInvoice.pdf.
The value can also be provided dynamically using workflow data.
This property is required.
IB Drive file names:
- Can contain up to 255 characters.
- Cannot contain
\ / : * ? " < > |. - Cannot start or end with a space or period.
- Are case-insensitive within the same folder.
If another file with the specified name already exists in the same folder, the activity fails with an error.
The activity does not overwrite the existing file or 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
File
Returns an IB-X File Reference for the renamed file. Bind the whole output to a compatible reference input, or use Id with an IB Drive By Id selector.
| Property | Description |
|---|---|
| Id | The unique identifier (GUID) of the renamed file. |
| Name | The new name of the file, including its file extension. |
| Location | The logical path of the renamed file within IB Drive. |
| ParentId | The unique identifier (GUID) of the parent folder containing the file. |
| Size | The size of the file in bytes. |
| MimeType | The MIME type of the file, for example application/pdf or text/plain. |
| Created | The UTC date and time when the file was originally created in IB Drive. |
| Modified | The UTC date and time when the file was last modified. |
The returned file metadata can be used by downstream activities to perform additional operations on the renamed file.
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.