Activities
latest
false
Productivity Activities
Last updated Jul 9, 2024

Download File

UiPath.MicrosoftOffice365.Activities.Files.DownloadFileConnections

Description

Downloads a specified file to a local folder.

Scopes

This activity requires the following scopes:

  • Sites.Read.All
  • Sites.ReadWrite.All

Project compatibility

Windows | Cross-platform

Configuration

  • Microsoft OneDrive & SharePoint connection - The connection for the Microsoft 365 account to use in the activity.
  • File to download - The file to download. The method to specify the file to be retrieved: Folder picker, Enter Id, Enter Url
    • Browse option – Browse the OneDrive or SharePoint folders and select the file. This field accepts IResource input.
    • Enter Id option:

      • File or folder Id - The ID of the file or folder. To retrieve the ID, open the file in OneDrive Web and retrieve its URL. The ID is encoded in the URL. For example: if the URL is https://yourcompany.sharepoint.com/Doc.aspx?sourcedoc=%7BA1CA7E78-BA59-4DD4-A6B9-5F5BBC37FA85%7D&file=Merge_sheets.xlsx`, the decoded file ID is A1CA7E78-BA59-4DD4-A6B9-5F5BBC37FA85. %7B and %7D are the delimiters around the file ID. This property supports String variables and string formatted values.
      • SharePoint site address - The URL of the SharePoint site that contains the file or folder. Open your SharePoint site in a browser and retrieve the URL, e.g., https://yourCompany.sharepoint.com/sites/Marketing. This property supports String variables and string formatted values.
      • SharePoint document library - The document library within the indicated SharePoint site that contains the file or folder. Open your SharePoint site in a browser, go to the Documents tab, then retrieve the URL, e.g., https://yourCompany.sharepoint.com/sites/Marketing/Shared%20Documents/Forms/AllItems.aspx. This property supports String variables and string formatted values.
    • Enter Url option:

      • File or folder Url - The URL of the file or folder. Open the file or folder in the browser and retrieve its URL. This property supports String variables and string formatted values.
    • Use the See more button menu to use a variable or select the Reload Folder Picker option if you've modified your folders and need to retrieve the latest data.

Additional options

Options

  • Convert to PDF format - Boolean value. Set to True to convert the file to PDF format. Only files of the following types can be converted: .csv, .doc, .docx, .odp, .ods, .odt, .pot, .potm, .potx, .pps, .ppsx, .ppsxm, .ppt, .pptm, .pptx, .rtf, .xls, and .xlsx.

Output

  • Downloaded file - The downloaded file. Automatically generated output variable. You can use it as it is or save it with a different name. You can use this in other activities.

Example



See also:
  • Description
  • Project compatibility
  • Configuration
  • Example

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.