Skip to main content

Copy File

UiPath.Box.Activities.File.CopyFile

The Copy File activity uses the Box Copy file API to copy a specified file (File Id) into a specified folder (Parent Folder Id) under the existing or new file name (File Name).

After copying the file, the activity outputs a BoxFile object (BoxFile) that includes the properties of the copied file, including the BoxFile.Id that you can use to identify the file in subsequent activities (e.g., Move File, Lock File, etc.).

How it works​

The following steps and message sequence diagram is an example of how the activity works from design time (i.e., the activity dependencies and input/output properties) to run time.

  1. Complete the Setup steps.
  2. Add the Box Scope activity to your project.
  3. Add an activity or run an external process that outputs a File.Id value (e.g., Upload File, Search for Content, etc.).
  4. Add the Copy File activity inside the Box Scope activity.
  5. Enter values for the Input properties.
  6. Create and enter a BoxFile variable for the Output property.

    • Your input property values are sent in the Copy File API operation request.

    • The operation returns the BoxFile value to your output property variable.

      docs image

Properties​

Common​

  • ContinueOnError - Specifies if you want the activity to continue running when an error is thrown. This field supports only Boolean values.
  • DisplayName - The display name of the activity. This field supports only Strings or String variables.

Input​

  • File ID - The ID of the file that you want to copy. This field supports only Strings or String variables. To get the File ID value, add an activity or run an external process that outputs a File.Id object (e.g., Upload File, Search for Content, etc.).
  • Parent Folder ID - The ID of the parent folder where you want to copy the file. This field supports only Strings or String variables.
    • Enter a value of "0" to use the root folder of the application.
    • To get the ID of a folder that is not the root, use the Search for Content activity.

Misc​

  • Private - If selected, the values of variables and arguments are no longer logged at Verbose level.

Options​

  • File Name - The name that you want to apply to the file. This field supports only Strings or String variables. If this property is left empty, the existing file name is applied.

Output​

  • Box File - The BoxFile object that includes the file properties. Enter a BoxFile variable. The BoxFile object includes multiple properties that you can use in other activities.