Download File
Description
Download File plugin step downloads a file from the Document Library present in a specified site in SharePoint Online.
Prerequisites
You require the following permissions for app on Azure:
| Account Type | Permission type | Permission (from least to most privileged) |
|---|---|---|
| Work or School account | Delegated | Files.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All |
44.8.3 Configurations
Configuration:
| No. | Field Name | Description |
|---|---|---|
| 1 | Step Name | Specify the name of the step. This name has to be unique in a single workflow. This is a mandatory field. |
| Connection: | ||
| 2 | Client ID | Specify the Client ID of SharePoint App. For information about creating a client ID, see Appendix: SharePoint: App Registration & Refresh Token Generation. The field data type is String. This is a mandatory field. |
| 3 | Accept value as variable/static | Select the checkbox if you want to enter the Refresh Token name in the Refresh Token field. If you do not select the checkbox, then you can select the refresh token in the Refresh Token field. |
| 4 | Refresh Token | Specify or select the Refresh Token generated using Client ID, which is generated after creating the App in Azure AD. This is a mandatory field. |
| 5 | Test Connection | Verifies whether the connection is established or not. Note: This connection will not work for the previous step variables. The button will only work with static values and environment variables. |
Input Tab
| No. | Field Name | Description |
|---|---|---|
| 1 | Site Relative URL | Select the SharePoint site-relative URL. Format: {Tenant Name}.sharepoint.com:/{SharePoint Site Path} Example: firstUser.sharepoint.com:/sites/TestingSite This is a mandatory field. Note: For the root site (Communication Site), you do not need to specify the {SharePoint Site Path}. |
| 2 | Document Library Name | Select the name of the source Document Library in which the file is present. This is a mandatory field. |
| 3 | SharePoint File Path | Select the full path (from the root of the Document Library). Example: Folder1/Example_1.txt, Folder1/Folder2 This is a mandatory field. |
| 4 | Output Folder Path | Select the full folder path on the local machine where the file is to be downloaded. If the folders do not exist, the workflow will create them. This is a mandatory field. Note: If the path is invalid, the folders will be created in the Process Studio directory. |
Additional Input tab:
| No. | Field Name | Description |
|---|---|---|
| Input Fields: | ||
| 1 | Delete Output Folder Contents before Downloading | Select the local folder from which all files and folder are deleted before downloading. Allowed value is ‘’Yes’’, ’’No’’. |
| 2 | Add DateTimeStamp for Duplicate Files | Select to add timestamp to newly downloaded folder if local folder contains same file name. If value is false, then file will be overwritten. Allowed value is ‘’Yes’’, ’’No’’. |
| 3 | Add File To Result | Select to add downloaded file in result of workflow. Allowed value is ‘’Yes’’, ’’No’’. |
Output tab:
| Field Name | Description |
|---|---|
| Output Fields: | |
| File Overwritten | Specify if file is overwritten and returns Yes else No. |