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 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.
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.
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
File
Returns metadata for the renamed file.
| Property | Description |
|---|---|
| ItemId | 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. |
| ContentType | 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
- The specified file must exist in IB Drive when the activity executes.
- Renaming a file changes its name but does not move it to another folder.
- The new file name must comply with the IB Drive naming rules.
- Include the appropriate file extension in New Name, for example
Invoice.pdf. - File names are case-insensitive within the same folder. For example,
Report.pdfandreport.pdfare treated as the same name. - If another file with the specified name already exists in the same folder, the activity fails with an error.
- The activity does not overwrite or automatically rename an existing file.
- When using By Path, specify the current logical IB Drive path including the existing file name and extension.