Copy Folder
Description
The Copy Folder activity copies an existing folder and its contents in IB Drive to a specified target folder.
The original folder remains unchanged, and a new copy of the folder is created in the target location.
If a folder with the same name already exists in the target folder, IB Drive automatically generates a unique name for the copied folder without overwriting or merging with the existing folder.
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 copied.
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.
Target Folder
Specifies the IB Drive folder where the copied folder will be created.
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.
If a folder with the same name already exists in the target folder, the existing folder is not overwritten or merged. IB Drive automatically creates the copied folder using a unique name.
For example:
Reports→Reports - Copy- Another copy →
Reports - Copy(2) - Another copy →
Reports - Copy(3)
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 the metadata of the new folder created in the target location.
The returned folder object contains the following properties:
| Property | Description |
|---|---|
| ItemId | The unique identifier (GUID) of the copied folder. |
| Name | The name of the copied folder. If the name already exists in the target folder, this contains the automatically generated unique name. |
| Location | The logical path of the copied folder within IB Drive, for example /Agents/InvoiceProcessing/Archive. |
| ParentId | The unique identifier (GUID) of the parent folder containing the copied 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 copied folder was created in IB Drive. |
| Modified | The UTC date and time when the copied folder was last modified. |
The returned folder metadata can be used by downstream activities to perform additional operations on the copied folder.
Remarks
- The source folder and target folder must exist in IB Drive when the activity executes.
- The source folder, including its files and subfolders, is copied to the target location.
- The original folder and its contents remain unchanged after the copy operation.
- Copy Folder does not overwrite or merge with an existing folder. If the target location already contains a folder with the same name, IB Drive automatically generates a unique name using the
- Copy,- Copy(2),- Copy(3), and subsequent naming pattern. - The copied folder is a separate IB Drive item with its own unique ItemId.
- IB Drive paths represent logical locations within the organization's IB Drive library and do not represent physical file system paths.