Subscribe

UiPath Activities

The UiPath Activities Guide

Download File

Overview

The Download File activity downloads a specified SlackFile object (File) and saves it to a local destination (Path).

To identify the SlackFile object that you want to download, you first locate the file using the Search or Get Messages activities.

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 Slack Scope activity to your project.
  3. Complete one of the following two options (A or B):
    A. Add the Search activity inside the Slack Scope activity.
    B. Add the Get Messages activity inside the Slack Scope activity.
  4. Add the Download File activity after the Search or Get Messages activity.
  5. Enter values for the Input properties.
  6. Run the activity.
    • Your input property values are sent to the Slack API where the Working with Files process occurs.

Properties

The values for the following properties are specified when adding this activity to your project in UiPath Studio.

Common

DisplayName

The display name of the activity.

Attributes

Details

Type

String

Required

Yes

Default value

Download File

Allowed values

Enter a String or String variable.

Notes

N/A


Input

File ID

The specific file that you want to download.

Attributes

Details

Type

String

Required

Yes

Default value

Empty

Allowed values

Enter a SlackFile variable.

Notes

To enter your SlackFile variable, use the Files output property variable from the Search activity.

  • When using the Files output property, be sure to specify which item in the array that you want to use (e.g., foundFiles(0)).
    You can also use the Messages output property from the Search or Get Messages activity by requesting the File property (e.g., item.Files(0)).
    Both examples are shown in the image below.

Local File Path

The local destination where you want to save the downloaded file.

Attributes

Details

Type

String

Required

Yes

Default value

Empty

Allowed values

Enter a String or String variable.

Notes

If left empty, the activity saves the file to the directory of the automation project.
By default, the file is saved using the name it was uploaded to Slack with. 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.xlsx")


Example

The following image shows an example of the activity dependency relationship and input/output property values.

For step-by-step instructions and examples, see the Quickstart guides.

Updated 27 days ago


Download File


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.