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 Capabilities

Process Data Support

info

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 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.pdfReport - Copy.pdf
  • Another copy → Report - Copy(2).pdf
  • Another copy → Report - Copy(3).pdf

Wait All Incoming

Execution Control

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

Error Handling Strategy

Defines how the workflow behaves if this activity encounters a runtime error.

Supported strategies include Fault, Continue, Suspend, and Retry.

Learn more → Error Handling


Outputs

File

Returns the metadata of the new file created in the target folder.

The returned file object contains the following properties:

PropertyDescription
ItemIdThe 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.
ContentTypeThe 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

  • The source file and target folder must exist in IB Drive when the activity executes.
  • The original file remains unchanged after the copy operation.
  • Copy File does not overwrite an existing file. If the target folder already contains a file with the same name, IB Drive automatically generates a unique name using the - Copy, - Copy(2), - Copy(3), and subsequent naming pattern.
  • The copied file 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.