Download File

UiPath.MicrosoftOffice365.Activities.Files.DownloadFile

Description

Uses the Microsoft Graph Download file API to download a specified file from your OneDrive or SharePoint site to a local location.

Scopes

This activity requires the following scopes:

• Sites.Read.All

OR

• Sites.ReadWrite.All

Project compatibility

Windows - Legacy | Windows

Configuring the Activity

In the Body of the Activity

• File to download - The DriveItem of the file to download. This object can be retrieved using the Find Files And Folders activity. Use the output property variable from the Find Files And Folders (First or Results). If you're using the Results output property from the Find Files and Folders activity, specify the item in the array that you want to use (e.g., myFiles(0)).
• Download location - The local path to which the file is downloaded. If left blank, the project directory is used. If a directory path is entered, the file is saved under that directory. By default, the file is saved using the file name from OneDrive or SharePoint. If a file with the same name exists in the local path that you enter in this property, the existing file is overwritten. To rename the file (and avoid unwanted overwrites), append the new file name to the end of your local path (e.g., _"C:\\UiPath\Projects\\DownloadExample.docx"). This property supports String variables and string formatted values.
  Note: You can save files or folders for later use in the automation using the Get File/Folder activity.

Properties Panel

Common

• DisplayName - The display name of the activity in the Designer panel. This property supports String variables and string formatted values.

Input

• See the options in the body of the activity.

Misc

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

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 steps.
2. Add the Microsoft Office 365 Scope activity to your project.
3. Add an activity or run an external process that outputs a DriveItem object (e.g., Find Files And Folders).
4. Add the Download File activity inside the Microsoft Office 365 Scope activity.
5. Enter values for the Input properties.

6. Run the activity.

   • Your input property values are sent to the DownloadDriveItem API.