UiPath Documentation
activities
latest
false
Productivity activities

Download File

Download File activity that downloads a specified file to a local folder in Microsoft 365.

UiPath.MicrosoftOffice365.Activities.Files.DownloadFileConnections

Description​

Downloads a specified file to a local folder.

Scopes​

This activity requires the following scopes:

  • Sites.Read.All

OR

  • Sites.ReadWrite.All

OR

  • Sites.Selected
Note:

Sites.Selected works only for SharePoint locations that a SharePoint administrator has granted to your application. Browsing doesn't list any sites, so enter the URL or the ID of the file or folder instead. For setup steps, refer to Restrict access to specific SharePoint sites.

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. %7Band%7Dare the delimiters around the file ID. This field supportsString` type input.
      • 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 type input.
      • 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 type input.
    • Enter Url option:
      • File or folder Url - The URL of the file or folder. This property supports String variables and string formatted values. Retrieve the URL by opening the file in a browser.
    • Use the See more docs image button menu to use a variable or select the Reload Folder Data option if you've modified your folders and need to retrieve the latest data.

Properties​

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:

    • Documents: .doc, .docx, .dot, .dotx, .dotm, .odt, .rtf
    • Web and text: .htm, .html, .md, .markdown, .epub
    • Spreadsheets: .xls, .xlsm, .xlsx, .ods
    • Presentations: .ppt, .pptx, .pps, .ppsx, .odp
    • Email: .eml, .msg
    • Images and drawings: .tif, .tiff, .dwg, .dsn
    • Other formats: .fluidframework, .loop, .loot, .pulse, .form, .note, .page, .task, .whiteboard, .wbtx

  • Destination path - The path where to save the downloaded file.

  • If a file already exists - Choose what is the expected behavior when a file with the same name already exists in the destination folder. Select one of the following options:

    • Replace
    • Don't replace
    • Auto rename

    The default option is Don't replace.

Output

  • Downloaded file - The downloaded file. Automatically generated output variable. You can use it as it is or save it with a different name. In addition, you can use this in other activities, for example, in For Each File/Folder.

For more details, also check the following resources:

  • Description​
  • Scopes​
  • Project compatibility​
  • Configuration​
  • Properties​

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated