Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
transformations:sharepointcommand [2025/06/28 16:38] – update iconcraigttransformations:sharepointcommand [2026/11/18 22:39] (current) – external edit127.0.0.1
Line 1:Line 1:
-{{ transformations:SharePointCmdAction.png}}+{{transformations:SharePointCmdAction.png?nolink }}
 ====== SHAREPOINT COMMAND ====== ====== SHAREPOINT COMMAND ======
-Category: Workflow / App/Cloud\\+Category: Workflow / App/Cloud
  
-\\  
 =====Description===== =====Description=====
 This action performs file operations with a SharePoint site. A configured [[connectors:sharepoint|SharePoint connector]] is required. SharePoint Online and on-premises SharePoint sites are supported. This action performs file operations with a SharePoint site. A configured [[connectors:sharepoint|SharePoint connector]] is required. SharePoint Online and on-premises SharePoint sites are supported.
  
-\\ 
 =====Capabilities===== =====Capabilities=====
   * List files   * List files
Line 25:Line 23:
   * List libraries   * List libraries
  
-\\  
 =====Action settings===== =====Action settings=====
 ^ Setting  ^ Description  ^ ^ Setting  ^ Description  ^
Line 32:Line 29:
 |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.| |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.|
 <sup>*</sup> Setting can be specified using a [[:parameters|parameter]].\\ <sup>*</sup> Setting can be specified using a [[:parameters|parameter]].\\
-<sup>1</sup> Setting can be specified using a [[:parameters|parameter]] or the first value of a column.\\+<sup>1</sup> Setting can be specified using a [[:parameters|parameter]] or the first value of a column.
  
-\\  
 ====List files settings==== ====List files settings====
 **Description:**  Produce a list of files, with selected details, in a specified folder in the SharePoint site. **Description:**  Produce a list of files, with selected details, in a specified folder in the SharePoint site.
Line 42:Line 38:
 <sup>*</sup> Setting can be specified using a [[:parameters|parameter]]. <sup>*</sup> Setting can be specified using a [[:parameters|parameter]].
  
-\\  
 ====Download file settings==== ====Download file settings====
 **Description:** Downloads the specified file from the SharePoint site to the local location defined. **Description:** Downloads the specified file from the SharePoint site to the local location defined.
Line 51:Line 46:
 <sup>*</sup> Setting can be specified using a [[:parameters|parameter]]. <sup>*</sup> Setting can be specified using a [[:parameters|parameter]].
  
-\\  
 ====Download list of files settings==== ====Download list of files settings====
 **Description:** Downloads multiple files specified in a column in the action's input dataset from the SharePoint site. **Description:** Downloads multiple files specified in a column in the action's input dataset from the SharePoint site.
 ^ Setting  ^ Description  ^ ^ Setting  ^ Description  ^
 |File list|Select the table column containing the list of fully qualified file names to be downloaded.| |File list|Select the table column containing the list of fully qualified file names to be downloaded.|
-|Local folder<sup>*</sup>|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.|+|Local folder<sup>*</sup>|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.|
 <sup>*</sup> Setting can be specified using a [[:parameters|parameter]]. <sup>*</sup> Setting can be specified using a [[:parameters|parameter]].
  
-\\ 
 ====Download folder settings==== ====Download folder settings====
 **Description:** Downloads the contents (all files and subfolders, recursively) of the specified SharePoint folder to the defined local folder. **Description:** Downloads the contents (all files and subfolders, recursively) of the specified SharePoint folder to the defined local folder.
Line 65:Line 58:
 |Folder path<sup>*</sup>|Select a SharePoint folder to download the contents of.| |Folder path<sup>*</sup>|Select a SharePoint folder to download the contents of.|
 |Local folder<sup>*</sup>|Select the local folder to download the contents into.| |Local folder<sup>*</sup>|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).|+|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).|
 <sup>*</sup> Setting can be specified using a [[:parameters|parameter]]. <sup>*</sup> Setting can be specified using a [[:parameters|parameter]].
  
-\\  
 ====Upload file settings==== ====Upload file settings====
 **Description:** Uploads the specified local file to the defined SharePoint folder. **Description:** Uploads the specified local file to the defined SharePoint folder.
Line 77:Line 69:
 <sup>*</sup> Setting can be specified using a [[:parameters|parameter]]. <sup>*</sup> Setting can be specified using a [[:parameters|parameter]].
  
-\\  
 ====Upload list of files settings==== ====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. **Description:** Uploads multiple files specified in a column in the action's input dataset to a folder on the SharePoint site.
 ^ Setting  ^ Description  ^ ^ Setting  ^ Description  ^
 |File list|Select the table column containing the list of fully qualified local file names to be uploaded.| |File list|Select the table column containing the list of fully qualified local file names to be uploaded.|
-|Target folder<sup>*</sup>|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.|+|Target folder<sup>*</sup>|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.|
 <sup>*</sup> Setting can be specified using a [[:parameters|parameter]]. <sup>*</sup> Setting can be specified using a [[:parameters|parameter]].
  
-\\  
 ====Upload folder settings==== ====Upload folder settings====
 **Description:** Uploads the contents (all files and subfolders, recursively) of a chosen local folder to a SharePoint folder. **Description:** Uploads the contents (all files and subfolders, recursively) of a chosen local folder to a SharePoint folder.
Line 91:Line 81:
 |Local folder<sup>*</sup>|Select the local folder to upload the contents of.| |Local folder<sup>*</sup>|Select the local folder to upload the contents of.|
 |Target folder<sup>*</sup>|Select the SharePoint folder to upload the contents to.| |Target folder<sup>*</sup>|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).|+|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).|
 <sup>*</sup> Setting can be specified using a [[:parameters|parameter]]. <sup>*</sup> Setting can be specified using a [[:parameters|parameter]].
  
-\\  
 ====Delete file settings==== ====Delete file settings====
 **Description:** Deletes the specified file stored on the SharePoint site. **Description:** Deletes the specified file stored on the SharePoint site.
 ^ Setting  ^ Description  ^ ^ Setting  ^ Description  ^
 |File path<sup>*</sup>|Enter or browse to the remote file on the SharePoint site to delete.| |File path<sup>*</sup>|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).|+|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).|
 <sup>*</sup> Setting can be specified using a [[:parameters|parameter]]. <sup>*</sup> Setting can be specified using a [[:parameters|parameter]].
  
-\\  
 ====Delete list of files settings==== ====Delete list of files settings====
 **Description:** Deletes multiple files specified in a column in the action's input dataset from the SharePoint site. **Description:** Deletes multiple files specified in a column in the action's input dataset from the SharePoint site.
 ^ Setting  ^ Description  ^ ^ Setting  ^ Description  ^
 |File list|Select the table column containing the list of fully qualified file names to be deleted from the SharePoint site.| |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).|+|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).|
 <sup>*</sup> Setting can be specified using a [[:parameters|parameter]]. <sup>*</sup> Setting can be specified using a [[:parameters|parameter]].
  
-\\ 
 ====File already exists options==== ====File already exists options====
 ^Option ^Description ^ ^Option ^Description ^
Line 117:Line 104:
 |Halt project execution|The project will stop processing and this action will display an error.| |Halt project execution|The project will stop processing and this action will display an error.|
  
-\\ 
 ====List folders settings==== ====List folders settings====
 **Description:**  Produce a list of subfolders under the selected folder. **Description:**  Produce a list of subfolders under the selected folder.
Line 123:Line 109:
 |Folder<sup>*</sup>|Select a folder on SharePoint to retrieve a list of subfolders from.| |Folder<sup>*</sup>|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//.| |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//.|
-<sup>*</sup> Setting can be specified using a [[:parameters|parameter]].\\+<sup>*</sup> Setting can be specified using a [[:parameters|parameter]].
  
-\\ 
 ====Create folder settings==== ====Create folder settings====
 **Description:**  Create a new SharePoint folder under the selected parent folder. **Description:**  Create a new SharePoint folder under the selected parent folder.
Line 132:Line 117:
 |Folder name<sup>*</sup>|Enter the name of the new folder.| |Folder name<sup>*</sup>|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).| |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).|
-<sup>*</sup> Setting can be specified using a [[:parameters|parameter]].\\+<sup>*</sup> Setting can be specified using a [[:parameters|parameter]].
  
-\\ 
 ====Rename folder settings==== ====Rename folder settings====
 **Description:**  Rename the selected SharePoint folder. **Description:**  Rename the selected SharePoint folder.
Line 140:Line 124:
 |Folder<sup>*</sup>|Select the folder on SharePoint to rename.| |Folder<sup>*</sup>|Select the folder on SharePoint to rename.|
 |New name<sup>*</sup>|Enter the new name for the selected folder.| |New name<sup>*</sup>|Enter the new name for the selected folder.|
-<sup>*</sup> Setting can be specified using a [[:parameters|parameter]].\\+<sup>*</sup> Setting can be specified using a [[:parameters|parameter]].
  
-\\ 
 ====Copy folder settings==== ====Copy folder settings====
 **Description:** Copies the contents (all files and subfolders, recursively) of a selected SharePoint folder to another SharePoint folder. **Description:** Copies the contents (all files and subfolders, recursively) of a selected SharePoint folder to another SharePoint folder.
Line 148:Line 131:
 |Folder<sup>*</sup>|Select the source SharePoint folder to copy the contents of.| |Folder<sup>*</sup>|Select the source SharePoint folder to copy the contents of.|
 |Target folder<sup>*</sup>|Select the SharePoint folder to copy the contents to.| |Target folder<sup>*</sup>|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).|+|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==== ====Delete folder settings====
 **Description:**  Delete the selected SharePoint folder. **Description:**  Delete the selected SharePoint folder.
Line 156:Line 138:
 |Folder path<sup>*</sup>|Select the folder on SharePoint to delete.| |Folder path<sup>*</sup>|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).| |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).|
-<sup>*</sup> Setting can be specified using a [[:parameters|parameter]].\\+<sup>*</sup> Setting can be specified using a [[:parameters|parameter]].
  
-\\ 
 ====List libraries settings==== ====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. **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===== =====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. 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.
  
-\\  
 =====See also===== =====See also=====
   * [[transformations:filecommand|File command]]   * [[transformations:filecommand|File command]]