This is an old revision of the document!
Table of Contents
SHAREPOINT COMMAND
Category: Workflow / App/Cloud
Description
This action performs file operations with a SharePoint site. A configured SharePoint connector is required. SharePoint Online and on-premises SharePoint sites are supported.
Currently, the following commands are available:
- List files
- Download file
- Download list of files
- Download folder
- Upload file
- Upload list of files
- Upload folder
- Delete file
- Delete list of files
- List folders
- Create folder
- Rename folder
- Copy folder
- Delete folder
- List libraries
Action settings
| Setting | Description |
|---|---|
| Connector* | Select the preconfigured SharePoint connector, or, build one by selecting Add connector. |
| Library1 | Select the Library to perform the command in. |
| Command | Select the file operation this action will perform. Options: List files, Download file, Download list of files, Download folder, Upload file, Upload list of files, Upload folder, Delete file, Delete list of files, List folders, Create folder, Rename folder, Copy folder, Delete folder, or List libraries. See below for details of each command type. |
* Setting can be specified using a parameter.
1 Setting can be specified using a parameter or the first value of a column.
List files settings
Description: Produce a list of files, with selected details, in a specified folder in the SharePoint site.
| Setting | Description |
|---|---|
| Folder* | Select a folder containing the files to create the file list from. |
| Columns | Select the details of the found files to be included in the dataset. Each detail creates a column in the dataset. Options: File name with full path, File name only, File extension, Size, Date created, Date modified, Created by and Modified by. |
* Setting can be specified using a parameter.
Download file settings
Description: Downloads the specified file from the SharePoint site to the local location defined.
| Setting | Description |
|---|---|
| File path* | Enter or browse to the file in the SharePoint site to be downloaded. |
| Local folder* | Enter or browse to the local folder to download the file to. |
| If a file with such name already exists | Select how EasyMorph will handle saving the file if a file with the same name exists in the destination folder. Options: Overwrite, Do nothing, or Halt project execution. See the "File already exists" table below. |
* Setting can be specified using a parameter.
Download list of files settings
Description: Downloads multiple files specified in a column in the action's input dataset from the SharePoint site.
| Setting | Description |
|---|---|
| File list | Select the table column containing the list of fully qualified file names to be downloaded. |
| Local folder* | Enter or browse to the local folder to download the files to. This action will overwrite files with the same name(s) that already exist(s) in the destination folder. |
* Setting can be specified using a parameter.
Download folder settings
Description: Downloads the contents (all files and subfolders, recursively) of the specified SharePoint folder to the defined local folder.
| Setting | Description |
|---|---|
| Folder path* | Select a SharePoint folder to download the contents of. |
| Local folder* | Select the local folder to download the contents into. |
| If the folder already exists | Select how EasyMorph will handle downloading the folder if a local folder with the same name exists in the selected destination folder. Options: Fail (the workflow stops with a warning), Overwrite (replace existing files and folders in the local directory with the latest versions from the OneDrive folder, and download any new files or folders that don't already exist locally), or Copy missing files (only download files and folders from the SharePoint folder that are not present in the local directory). |
* Setting can be specified using a parameter.
Upload file settings
Description: Uploads the specified local file to the defined SharePoint folder.
| Setting | Description |
|---|---|
| File path* | Enter or browse to the local file to upload. |
| Target folder* | Enter or browse to a SharePoint folder to upload the file to. |
| If a file with such name already exists | Select how EasyMorph will handle saving the file if a file with the same name exists in the destination folder. Options: Overwrite, Do nothing, or Halt project execution. See the "File already exists" table below. |
* Setting can be specified using a parameter.
Upload list of files settings
Description: Uploads multiple files specified in a column in the action's input dataset to a folder on the SharePoint site.
| Setting | Description |
|---|---|
| File list | Select the table column containing the list of fully qualified local file names to be uploaded. |
| Target folder* | Enter or browse to a SharePoint folder to upload the files to. This action will overwrite files with the same name(s) that already exist(s) in the destination folder. |
* Setting can be specified using a parameter.
Upload folder settings
Description: Uploads the contents (all files and subfolders, recursively) of a chosen local folder to a SharePoint folder.
| Setting | Description |
|---|---|
| Local folder* | Select the local folder to upload the contents of. |
| Target folder* | Select the SharePoint folder to upload the contents to. |
| If the folder already exists | Select how EasyMorph will handle downloading the folder if a local folder with the same name exists in the selected destination folder. Options: Fail (the workflow stops with a warning), Overwrite (replace existing files and folders in the SharePoint folder with the latest versions from the local folder, and upload any new files or folders that don't already exist in the OneDrive folder), or Copy missing files (only upload files and folders from the local folder that are not present in the SharePoint folder). |
* Setting can be specified using a parameter.
Delete file settings
Description: Deletes the specified file stored on the SharePoint site.
| Setting | Description |
|---|---|
| File path* | Enter or browse to the remote file on the SharePoint site to delete. |
| If the file doesn't exist | Select how EasyMorph handles situations when the specified file does not exist. Options: Do nothing (nothing happens, the workflow continues, no error is displayed), or Halt project execution (workflow stops, an error is displayed). |
* Setting can be specified using a parameter.
Delete list of files settings
Description: Deletes multiple files specified in a column in the action's input dataset from the SharePoint site.
| Setting | Description |
|---|---|
| File list | Select the table column containing the list of fully qualified file names to be deleted from the SharePoint site. |
| If a file from the list doesn't exist | Select how EasyMorph handles situations when a file in the list does not exist. Options: Ignore (nothing happens, the workflow continues, no error is displayed), or Halt project execution (workflow stops, an error is displayed). |
* Setting can be specified using a parameter.
File already exists options
| Option | Description |
|---|---|
| Overwrite | The new file replaces the original file. |
| Do nothing | No file is downloaded/uploaded, the workflow does not halt, and no error is displayed. |
| Halt project execution | The project will stop processing and this action will display an error. |
List folders settings
Description: Produce a list of subfolders under the selected folder.
| Setting | Description |
|---|---|
| Folder* | Select a folder on SharePoint to retrieve a list of subfolders from. |
| Columns | Select the details of the found subfolders to be included in the dataset. Each detail produces a column. Options: Folder name with full path, Folder name only, Date created, Date modified, Created by, and Modified by. |
* Setting can be specified using a parameter.
Create folder settings
Description: Create a new SharePoint folder under the selected parent folder.
| Setting | Description |
|---|---|
| Parent folder* | Select a folder on SharePoint to create the new folder under. |
| Folder name* | Enter the name of the new folder. |
| If a folder with such name already exists | Choose how EasyMorph behaves if a folder with the Folder name already exists. Options: Fail (the workflow stops with a warning) or Do nothing (the workflow continues without creating the new folder). |
* Setting can be specified using a parameter.
Rename folder settings
Description: Rename the selected SharePoint folder.
| Setting | Description |
|---|---|
| Folder* | Select the folder on SharePoint to rename. |
| New name* | Enter the new name for the selected folder. |
* Setting can be specified using a parameter.
Copy folder settings
Description: Copies the contents (all files and subfolders, recursively) of a selected SharePoint folder to another SharePoint folder.
| Setting | Description |
|---|---|
| Folder* | Select the source SharePoint folder to copy the contents of. |
| Target folder* | Select the SharePoint folder to copy the contents to. |
| If the folder doesn't exist | Select how EasyMorph will handle copying the folder if the target folder doesn't exist destination folder. Options: Fail (the workflow stops with a warning), Overwrite (replace existing files and folders in the target folder with the latest versions from the source folder, and copy any new files or folders that don't already exist in the target folder). |
Delete folder settings
Description: Delete the selected SharePoint folder.
| Setting | Description |
|---|---|
| Folder path* | Select the folder on SharePoint to delete. |
| If the folder doesn't exist | Choose how EasyMorph behaves if the selected folder does not exist. Options: Do nothing (the workflow continues without creating the new folder) or Fail (the workflow stops with a warning). |
* Setting can be specified using a parameter.
List libraries settings
Description: This mode generates a dataset of the libraries in the SharePoint site that includes Title, Description, and Type columns. No other settings are required.
Remarks
The easiest way to build a list of remote files on a SharePoint site to be downloaded or deleted is to use this action in its File list configuration, including the "File name with full path" option. This list can then be modified to generate the final list of files to be downloaded or deleted.