Download File

UiPath.Slack.Activities.Messages.DownloadFile

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.

1. Add the Download File activity after the Search or Get Messages activity.
2. Enter values for the Input properties.

3. Run the activity.

   • Your input property values are sent to the Slack API where the Working with Files process occurs.

     
     

     

     
     

In the Body of the Activity

• File ID - The specific file that you want to download. Enter a SlackFile variable.
  • 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)).
• Local File Path - The local destination where you want to save the downloaded file. Enter a String or String variable.
  • 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")

Properties

Common

• DisplayName - The display name of the activity. This field supports only Strings or String variables.

Misc

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

Output

• ResponseStatus - The status of the request (success/failure information). Enter a ResponseStatus variable (UiPath.BAF.Models.ResponseStatus). The ResponseStatus object includes three properties that you can use in other activities.
  • Success - Boolean - Specifies whether the API request was successful.
  • ErrorCode - String - The response error if the API request is unsuccessful (Success=False).
  • Message - String - The error message.

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.