Download Storage File

Download Storage File activity that downloads a file from a specified Storage Bucket in Orchestrator.

UiPath.Core.Activities.Storage.DownloadStorageFile

Description

Downloads a file from a specified Storage Bucket in Orchestrator.

Note:

Orchestrator permissions

This activity runs under the Orchestrator account of the robot that executes it. It must hold the following Orchestrator role permissions on the target folder:

• Storage Buckets.View: used to resolve the storage bucket
• Storage Files.View: used to read or download files from the bucket
• Folders.View: used to browse and select the Orchestrator folder

Project compatibility

Windows - Legacy | Windows | Cross-platform

Cross-platform configuration

• Orchestrator folder path - The path to the Orchestrator Folder you want to use with this activity. If left empty, the current Orchestrator folder is used. This field supports only strings and String variables.
• Storage Bucket Name - The name of the Storage Bucket the file is located in. This field supports only strings and String variables.
• File Path - The full path of the file from the Storage Bucket you want to download. The file must exist in the source Orchestrator Storage container. This field supports only strings and String variables.

¹For cross-platform projects created in Studio Web as part of a solution, the Orchestrator folder path field is unavailable.

²For cross-platform projects created in Studio Web as part of a solution, the name field provides options to Define new Orchestrator resources, such as queues, assets, or storage buckets, during design time, or Open Orchestrator for resource management.

Advanced options

Options

• File name and location - The full local path with file name where you want to download the file. Relative paths are resolved based on the runtime execution directory. This path must contain the filename in order for the activity to work. This field supports only strings and String variables.

• Timeout (milliseconds) - Specifies the amount of time (in milliseconds) to wait for Orchestrator to respond, or for the file transfer to make progress, before an error is thrown. It does not limit total transfer time, so large files over slow connections still complete. The default value is 300000 milliseconds (5 minutes). Opening a connection is always limited to 30 seconds.

  Note:

  On a timeout the activity fails with a TimeoutException carrying the error code Orchestrator_Sys_Timeout, so Continue On Error and Retry Scope apply as they do to any other error. A value of 0 or a negative number is replaced with 30 seconds, and cancelling the job is reported as a cancellation rather than a timeout.

  A partially written destination file is deleted before the activity fails.

• Continue On Error - Specifies if the automation should continue even when the activity throws an error. This field only supports Boolean values (True, False). The default value is False. As a result, if the field is blank and an error is thrown, the execution of the project stops. If the value is set to True, the execution of the project continues regardless of any error.

  Note:

  If this activity is included in Try Catch and the value of the Continue On Error property is True, no error is caught when the project is executed.

Output

• File - Reference to the downloaded file to be used in other activities.

Windows - Legacy, Windows configuration

• Path - The full path of the file from the Storage Bucket you want to download. The file must exist in the source Orchestrator Storage container. This field supports only strings and String variables.
• Storage Bucket Name - The name of the Storage Bucket the file is located in. This field supports only strings and String variables.

Properties panel

Common

• Continue On Error - Specifies if the automation should continue even when the activity throws an error. This field only supports Boolean values (True, False). The default value is False. As a result, if the field is blank and an error is thrown, the execution of the project stops. If the value is set to True, the execution of the project continues regardless of any error.

  Note:

  If this activity is included in Try Catch and the value of the Continue On Error property is True, no error is caught when the project is executed.

• DisplayName - The display name of the activity.

• Timeout (milliseconds) - Specifies the amount of time (in milliseconds) to wait for Orchestrator to respond, or for the file transfer to make progress, before an error is thrown. It does not limit total transfer time, so large files over slow connections still complete. The default value is 300000 milliseconds (5 minutes). Opening a connection is always limited to 30 seconds.

  Note:

  On a timeout the activity fails with a TimeoutException carrying the error code Orchestrator_Sys_Timeout, so Continue On Error and Retry Scope apply as they do to any other error. A value of 0 or a negative number is replaced with 30 seconds, and cancelling the job is reported as a cancellation rather than a timeout.

  A partially written destination file is deleted before the activity fails.

Misc

• Folder Path - The path to the Orchestrator Folder you want to use with this activity. If left empty, the current Orchestrator folder is used. This field supports only strings and String variables. Use / as a subfolder separator to specify the desired folder.
• Private - If selected, the values of variables and arguments are no longer logged at Verbose level.

Output

• Result - Reference to the downloaded file to be used in other activities.

Storage

• Path - The full path of the file from the Storage Bucket you want to download. The file must exist in the source Orchestrator Storage container. This field supports only strings and String variables.
• Storage Bucket Name - The name of the Storage Bucket the file is located in. This field supports only strings and String variables.

To

• File name and location - The full local path with file name where you want to download the file. Relative paths are resolved based on the runtime execution directory. This path must contain the filename in order for the activity to work. This field supports only strings and String variables.