{{ 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 * List folders * Create folder * Rename 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 files//, //Upload file//, //Upload files//, //Delete file//, //Delete files//, //List folders//, //Create folder//, //Rename folder//, //Delete folder//, or //List libraries//. See below for details of each command type.| * Setting can be specified using a [[:parameters|parameter]].\\ 1 Setting can be specified using a [[:parameters|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//, and //Date modified//.| * 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*|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 [[: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*|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 [[:parameters|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 [[: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*|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 [[:parameters|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 [[: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).| * 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.| \\ ====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//, and //Folder name only//.| * Setting can be specified using a [[:parameters|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 [[:parameters|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 [[:parameters|parameter]].\\ \\ ====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 [[:parameters|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. \\ =====See also===== * [[transformations:filecommand|File command]] * [[transformations:filelist|List of files]] * [[transformations:amazoncommand|Amazon S3 command]] * [[transformations:azureblobstoragecommand|Azure Blob Storage command]] * [[transformations:dropboxcommand|Dropbox command]] * [[transformations:googledrivecommand|Google Drive command]] * [[transformations:onedrivecommand|OneDrive command]]