User Tools

Site Tools


transformations:sharepointcommand
no way to compare when less than two revisions

Differences

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


Previous revision
Next revision
transformations:sharepointcommand [2021/07/05 01:20] craigt
Line 1: Line 1:
 +{{ transformations:SharePointCommandAction.png}}
 +====== SHAREPOINT COMMAND ======
 +Category: Workflow / App/Cloud\\
 +
 +\\ 
 +=====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.
 +
 +Currently, the following commands are available:
 +  * List files
 +  * Download file
 +  * Download files
 +  * Upload file
 +  * Upload files
 +  * Delete file
 +  * Delete files
 +
 +\\ 
 +=====Action settings=====
 +^ Setting  ^ Description  ^
 +|Connector<sup>*</sup>|Select the preconfigured SharePoint connector, or, build one by selecting //Add connector//.|
 +|Library<sup>*</sup>|Select the Library to perform the command in.|
 +|Command|Select the file operation this action will perform.  Options:  //List files//, //Download file//, //Download files//, //Upload file//, //Upload files//, //Delete file//, or //Delete files// See below for details of each command type.|
 +<sup>*</sup> Setting can be specified using a [[:parameters|parameter]].
 +
 +\\ 
 +====List files settings====
 +**Description:**  Produce a list of files, with selected details, in a specified folder in the SharePoint site.
 +^ Setting  ^ Description  ^
 +|Folder<sup>*</sup>|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//, and //Date modified//.|
 +<sup>*</sup> Setting can be specified using a [[:parameters|parameter]].
 +
 +\\ 
 +====Download file settings====
 +**Description:** Downloads the specified file from the SharePoint site to the local location defined.
 +^ Setting  ^ Description  ^
 +|File path<sup>*</sup>|Enter or browse to the file in the SharePoint site to be downloaded.|
 +|Local folder<sup>*</sup>|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.|
 +<sup>*</sup> Setting can be specified using a [[:parameters|parameter]].
 +
 +\\ 
 +====Download 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<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]].
 +
 +\\ 
 +====Upload file settings====
 +**Description:** Uploads the specified local file to the defined SharePoint folder.
 +^ Setting  ^ Description  ^
 +|File path<sup>*</sup>|Enter or browse to the local file to upload.|
 +|Target folder<sup>*</sup>|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.|
 +<sup>*</sup> Setting can be specified using a [[:parameters|parameter]].
 +
 +\\ 
 +====Upload 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<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]].
 +
 +\\ 
 +====Delete file settings====
 +**Description:** Deletes the specified file stored on the SharePoint site.
 +^ Setting  ^ Description  ^
 +|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).|
 +<sup>*</sup> Setting can be specified using a [[:parameters|parameter]].
 +
 +\\ 
 +====Delete 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).|
 +<sup>*</sup> Setting can be specified using a [[:parameters|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.|
 +
 +\\ 
 +=====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.
  
transformations/sharepointcommand.txt · Last modified: 2024/02/05 14:46 by craigt

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki