Skip to main content
Version: Current

Copy File

Description​

The Copy File activity copies an existing file in IB Drive to a specified target folder.

The original file remains unchanged, and a new copy of the file is created in the target 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.


File​

Specifies the IB Drive file to be copied.

The file can be specified using one of the following methods:

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


Target Folder​

Specifies the IB Drive folder where the copied file will be created.

Select the target folder from IB Drive or provide a folder reference dynamically using workflow data.

This property is required.

note

If a file with the same name already exists in the target folder, the existing file is not overwritten. IB Drive automatically creates the copy using a unique name.

For example:

  • Report.pdf → Report - Copy.pdf
  • Another copy → Report - Copy(2).pdf
  • Another copy → Report - Copy(3).pdf

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

The returned file object contains the following properties:

PropertyDescription
IdThe unique identifier (GUID) of the copied file.
NameThe name of the copied file, including its file extension.
LocationThe logical path of the copied file within IB Drive, for example /Agents/InvoiceProcessing/Input.
ParentIdThe unique identifier (GUID) of the folder containing the copied file.
SizeThe size of the copied file in bytes.
MimeTypeThe MIME type of the copied file, for example application/pdf or text/plain.
CreatedThe UTC date and time when the copied file was created in IB Drive.
ModifiedThe UTC date and time when the copied file was last modified.

The returned file metadata can be used by downstream activities to perform additional operations on the copied 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.