Skip to main content
Version: Current

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

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.


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:

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.

note

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)

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 new folder created in the target location. Bind the whole output to a compatible reference input, or use Id with an IB Drive By Id selector.

The returned folder object contains the following properties:

PropertyDescription
IdThe unique identifier (GUID) of the copied folder.
NameThe name of the copied folder. If the name already exists in the target folder, this contains the automatically generated unique name.
LocationThe logical path of the copied folder within IB Drive, for example /Agents/InvoiceProcessing/Archive.
ParentIdThe unique identifier (GUID) of the parent folder containing the copied 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 copied folder was created in IB Drive.
ModifiedThe 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​

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.