| Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision |
| transformations:filetransfer [2021/06/19 21:08] – craigt | transformations:filetransfer [2023/07/25 13:27] – [Upload settings] craigt |
|---|
| {{ transformations:FileTransferAction.png}} | {{ transformations:FileTransferAction.png}} |
| ====== TRANSFER FILE ====== | ====== FILE TRANSFER ====== |
| Category: Workflow / External\\ | Category: Workflow / External\\ |
| |
| \\ | \\ |
| =====Description===== | =====Description===== |
| This action transfers files to or from a remote server over an SSH connection using the SFTP or SCP protocol. | This action can perform various commands on files and folders on a remote server over an SSH connection using the SFTP or SCP protocol: |
| | * Upload file(s) |
| | * Download file(s) |
| | * List files |
| | * List folders |
| | * Delete file(s) |
| | * Create folder |
| | * Rename folder |
| | * Delete folder |
| |
| \\ | \\ |
| |Protocol|Select the transfer protocol to use. Options: //SFTP// or //SCP//.| | |Protocol|Select the transfer protocol to use. Options: //SFTP// or //SCP//.| |
| |Connector<sup>*</sup>|Select the pre-configured connector, or create a new connector, to the remote server.| | |Connector<sup>*</sup>|Select the pre-configured connector, or create a new connector, to the remote server.| |
| |Direction|Select the transfer direction. Options: //Download// or //Upload//. See the "Download settings" and "Upload settings" tables below for details.| | |Command|Select the file/folder command to perform. Options: //Download//, //Upload//, //List files//, //List folders//, or //Delete file//.| |
| |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]].\\ | <sup>*</sup> Setting can be specified using a [[:parameters|parameter]].\\ |
| \\ | \\ |
| ====Download settings==== | ====Download settings==== |
| | **Description:** Downloads files from a remote location to a local folder. |
| ^Setting ^Description ^ | ^Setting ^Description ^ |
| |Remote file(s)<sup>*</sup>|Enter the name of the file to be downloaded. Use wildcards to download multiple files.| | |Remote file(s)<sup>*</sup>|Enter the name of the file to be downloaded. Use wildcards to download multiple files.| |
| |Local folder<sup>*</sup>|Enter or browse to and select the local folder to save the downloaded file(s) to.| | |Local folder<sup>*</sup>|Enter or browse to and select the local folder to save the downloaded file(s) to.| |
| | |If a file with such name already exists|Select how EasyMorph will handle situations when the downloaded file already exists in the local folder. Options: //Overwrite// (the existing file is overwritten), //Do nothing// (the file is not downloaded), or //Halt project execution// (the workflow stops and a warning is displayed).| |
| <sup>*</sup> Setting can be specified using a [[:parameters|parameter]].\\ | <sup>*</sup> Setting can be specified using a [[:parameters|parameter]].\\ |
| \\ | \\ |
| ====Upload settings==== | ====Upload settings==== |
| | **Description:** Uploads files from a local folder to a remote destination. |
| ^Setting ^Description ^ | ^Setting ^Description ^ |
| |Local file(s)<sup>*</sup>|Enter or browse to the file to be uploaded. Use wildcards to upload multiple files.| | |Local file(s)<sup>*</sup>|Enter or browse to the file to be uploaded. Use wildcards to upload multiple files.| |
| | |Don't use temporary files (unsafe)|Check this to upload directly without the use of temporary files.| |
| |Remote folder<sup>*</sup>|Enter or browse to and select the remote folder to save the uploaded file(s) to.| | |Remote folder<sup>*</sup>|Enter or browse to and select the remote folder to save the uploaded file(s) to.| |
| | |If a file with such name already exists|Select how EasyMorph will handle situations when the uploaded file already exists in the remote folder. Options: //Overwrite// (the existing file is overwritten), //Do nothing// (the file is not uploaded), or //Halt project execution// (the workflow stops and a warning 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==== | ====List files settings==== |
| ^Option ^Description ^ | **Description:** Produce a list of files, with selected details, in a specified folder on the remote server. |
| |Overwrite|The new file replaces the original file.| | ^ Setting ^ Description ^ |
| |Do nothing|EasyMorph will not process files that already exist.| | |Remote folder<sup>*</sup>|Select a subfolder on the remote resource to access.| |
| |Halt project execution|The project will stop processing and this action will display an error.| | |Columns|Select the details of the found files to be included in the dataset. Each detail produces a column. Options: //File name\\ with full path//, //File name only//, //File extension//, //Size//, and //Date modified//.| |
| | <sup>*</sup> Setting can be specified using a [[:parameters|parameter]].\\ |
| | \\ |
| | ====List folders settings==== |
| | **Description:** Produce a list of subfolders under the selected folder. |
| | ^ Setting ^ Description ^ |
| | |Remote folder<sup>*</sup>|Select a folder on the remote resource 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//.| |
| | <sup>*</sup> Setting can be specified using a [[:parameters|parameter]].\\ |
| | \\ |
| | ====Delete file settings==== |
| | **Description:** Deletes the specified file stored on the remote resource. |
| | ^ Setting ^ Description ^ |
| | |Remote file(s)<sup>*</sup>|Enter the filename(s) of the remote file(s) to delete. Wildcards are supported.| |
| | |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]].\\ |
| \\ | \\ |
| | ====Create folder settings==== |
| | **Description:** Creates a new folder under the selected parent folder. |
| | ^ Setting ^ Description ^ |
| | |Parent folder<sup>*</sup>|Select an existing folder that the new folder will be created in.| |
| | |Folder name<sup>*</sup>|Enter the name of the new folder.| |
| | |If a folder with such name already exists|Select how EasyMorph handles situations when a folder with the same name as the new folder already exists. Options: //Fail// (workflow stops, an error is displayed) or //Do nothing// (nothing happens, the workflow continues, no error is displayed).| |
| | <sup>*</sup> Setting can be specified using a [[:parameters|parameter]].\\ |
| | \\ |
| | ====Rename folder settings==== |
| | **Description:** Changes the name of the selected folder. |
| | ^ Setting ^ Description ^ |
| | |Folder<sup>*</sup>|Select an existing folder to be renamed.| |
| | |New name<sup>*</sup>|Enter a new name for the selected folder.| |
| | |If a folder with such name already exists|Select how EasyMorph handles situations when a folder with the same name as the new folder already exists. Options: //Fail// (workflow stops, an error is displayed) or //Do nothing// (nothing happens, the workflow continues, no error is displayed).| |
| | <sup>*</sup> Setting can be specified using a [[:parameters|parameter]].\\ |
| | \\ |
| | ====Delete folder settings==== |
| | **Description:** Removes the selected folder. |
| | ^ Setting ^ Description ^ |
| | |Folder<sup>*</sup>|Select an existing folder, or enter a folder name, to delete.| |
| | |If the folder doesn't exist|Select how EasyMorph handles situations when the selected folder to delete doesn't exist. Options: //Do nothing// (nothing happens, the workflow continues, no error is displayed) or //Fail// (workflow stops, an error is displayed).| |
| | <sup>*</sup> Setting can be specified using a [[:parameters|parameter]].\\ |
| | \\ |
| =====Remarks===== | =====Remarks===== |
| When using SFTP, use the wildcard to transfer multiple files at once. | When using SFTP, use the wildcard to transfer multiple files at once. |
