| Both sides previous revisionPrevious revision | |
| transformations:morphservercommand [2025/02/20 15:09] – add Capabilities section craigt | transformations:morphservercommand [2026/06/23 22:41] (current) – update Server to Hub craigt |
|---|
| {{ transformations:MorphServerCommandAction.png}} | {{ transformations:MorphServerCommandAction.png}} |
| ====== EASYMORPH SERVER COMMAND ====== | ====== EASYMORPH HUB COMMAND ====== |
| Category: Workflow / App/Cloud\\ | Category: Workflow / App/Cloud\\ |
| |
| \\ | \\ |
| =====Description===== | =====Description===== |
| This action allows interaction with a remote EasyMorph Server using a configured EasyMorph Server connector. | This action allows interaction with a remote EasyMorph Hub using a configured EasyMorph Hub connector. |
| |
| \\ | \\ |
| \\ | \\ |
| =====Use cases===== | =====Use cases===== |
| The action can be used to interoperate with an EasyMorph Server from Desktop projects. For example, heavy data processing can be offloaded from a low-memory desktop computer to a high-memory Server. In this case, EasyMorph Server Command can be used to upload files to the Server, trigger a Server task that processes them, then download the resulting data from the Server to the local machine. | The action can be used to interoperate with an EasyMorph Hub from Desktop projects. For example, heavy data processing can be offloaded from a low-memory desktop computer to a high-memory server. In this case, EasyMorph Hub Command can be used to upload files to the Hub, trigger a Hub task that processes them, then download the resulting data from the Hub to the local machine. |
| |
| Use integrations that are set up on the Server, but not available on the local machine. In this case, the action can trigger a Server task that in turn pulls data from an external system, then downloads the data to the local machine. | Use integrations that are set up on the Hub, but not available on the local machine. In this case, the action can trigger a Hub task that, in turn, pulls data from an external system, then downloads the data to the local machine. |
| |
| \\ | \\ |
| =====Action settings===== | =====Action settings===== |
| ^ Setting ^ Description ^ | ^ Setting ^ Description ^ |
| |Connector<sup>*</sup>|Select the preconfigured EasyMorph Server connector.| | |Connector<sup>*</sup>|Select the preconfigured EasyMorph Hub connector.| |
| |Command|Select the command this action will perform.\\ Options: //Run task//, //Enable/disable task//, //Upload file//, //Download file//, //Delete file//, //List files//, //List folders//, //List tasks//, //Delete folder//, //Create folder//, //Rename folder//, //Rename file//, or //Find files recursively//. See below for details of each command type.| | |Command|Select the command this action will perform.\\ Options: //Run task//, //Enable/disable task//, //Upload file//, //Download file//, //Delete file//, //List files//, //List folders//, //List tasks//, //Delete folder//, //Create folder//, //Rename folder//, //Rename file//, or //Find files recursively//. 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]]. |
| \\ | \\ |
| ====Run task settings==== | ====Run task settings==== |
| **Description:** Runs a Server task. Task parameters can be specified in the action properties. | **Description:** Runs a Hub task. Task parameters can be specified in the action properties. |
| ^ Setting ^ Description ^ | ^ Setting ^ Description ^ |
| |Task<sup>*</sup>|Select the Server task to run. If the task is specified by a parameter, it should be the task ID.| | |Task<sup>*</sup>|Select the Hub task to run. If the task is specified by a parameter, it should be the task ID.| |
| |Don't wait for completion…|Check this option to continue running the task, ignoring task errors, while the workflow continues.| | |Don't wait for completion…|Check this option to continue running the task, ignoring task errors, while the workflow continues.| |
| <sup>*</sup> Setting can be specified using a [[:parameters|parameter]]. | <sup>*</sup> Setting can be specified using a [[:parameters|parameter]]. |
| \\ | \\ |
| ====Enable/disable task settings==== | ====Enable/disable task settings==== |
| **Description:** Enable or disable an EasyMorph Server task. | **Description:** Enable or disable an EasyMorph Hub task. |
| ^ Setting ^ Description ^ | ^ Setting ^ Description ^ |
| |Task|Select the Server task to enable/disable.| | |Task|Select the Hub task to enable/disable.| |
| |Mode|Select whether this action will enable or disable the selected task. Options: //Enable task// or //Disable task//.| | |Mode|Select whether this action will enable or disable the selected task. Options: //Enable task// or //Disable task//.| |
| |If the task was enabled/disabled|Choose how EasyMorph reacts if the task was already enabled (in "Enable task" mode), or disabled (in "Disable task" mode). Options: //Ignore// (the workflow continues and no error is displayed) or //Fail// (the workflow stops and displays an error).| | |If the task was enabled/disabled|Choose how EasyMorph reacts if the task was already enabled (in "Enable task" mode), or disabled (in "Disable task" mode). Options: //Ignore// (the workflow continues and no error is displayed) or //Fail// (the workflow stops and displays an error).| |
| \\ | \\ |
| ====Upload file settings==== | ====Upload file settings==== |
| **Description:** Upload a local file to a Server space's public folder or its sub-folder. | **Description:** Upload a local file to a Hub space's public folder or its sub-folder. |
| ^ Setting ^ Description ^ | ^ Setting ^ Description ^ |
| |Local file<sup>*</sup>|Enter or browse to the local file to upload.| | |Local file<sup>*</sup>|Enter or browse to the local file to upload.| |
| |Server folder<sup>*</sup>|Enter or browse to the Server folder to upload the file to. Leave this field blank to upload to the root folder.| | |Hub folder<sup>*</sup>|Enter or browse to the Hub folder to upload the file to. Leave this field blank to upload to the root folder.| |
| |If a file with such a 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.| | |If a file with such a 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 file settings==== | ====Download file settings==== |
| **Description:** Download a file from a Server space to a local folder. | **Description:** Download a file from a Hub space to a local folder. |
| ^ Setting ^ Description ^ | ^ Setting ^ Description ^ |
| |Server file<sup>*</sup>|Enter or browse to the file on the Server to be downloaded.| | |Hub file<sup>*</sup>|Enter or browse to the file on the Hub to be downloaded.| |
| |Local folder<sup>*</sup>|Enter or browse to the local folder to download the file to.| | |Local folder<sup>*</sup>|Enter or browse to the local folder to download the file to.| |
| |If a file with such a 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.| | |If a file with such a 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.| |
| \\ | \\ |
| ====Delete file settings==== | ====Delete file settings==== |
| **Description:** Delete a file from a Server space. | **Description:** Delete a file from a Hub space. |
| ^ Setting ^ Description ^ | ^ Setting ^ Description ^ |
| |Server file<sup>*</sup>|Enter or browse to the file on the Server to be deleted.| | |Hub file<sup>*</sup>|Enter or browse to the file on the Hub to be deleted.| |
| |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]]. |
| \\ | \\ |
| ====List files settings==== | ====List files settings==== |
| **Description:** Produce a list of files, with selected file properties, in a Server space. Each selected property creates a column in the dataset. | **Description:** Produce a list of files, with selected file properties, in a Hub space. Each selected property creates a column in the dataset. |
| ^ Setting ^ Description ^ | ^ Setting ^ Description ^ |
| |Folder<sup>*</sup>|Select the folder in the Server space to create the file list from. Leave this field blank for the root folder.| | |Folder<sup>*</sup>|Select the folder in the Hub space to create the file list from. Leave this field blank for the root folder.| |
| |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//.| | |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]]. | <sup>*</sup> Setting can be specified using a [[:parameters|parameter]]. |
| \\ | \\ |
| ====List folders settings==== | ====List folders settings==== |
| **Description:** Produce a list of subfolders under the selected folder, in a Server space. Each selected property creates a column in the dataset. | **Description:** Produce a list of subfolders under the selected folder, in a Hub space. Each selected property creates a column in the dataset. |
| ^ Setting ^ Description ^ | ^ Setting ^ Description ^ |
| |Folder<sup>*</sup>|Select the folder in the Server space to create the list of subfolders from. Leave this field blank for the root folder.| | |Folder<sup>*</sup>|Select the folder in the Hub space to create the list of subfolders from. Leave this field blank for the root folder.| |
| |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//, and //Date modified//.| | |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//, and //Date modified//.| |
| <sup>*</sup> Setting can be specified using a [[:parameters|parameter]]. | <sup>*</sup> Setting can be specified using a [[:parameters|parameter]]. |
| \\ | \\ |
| ====List tasks settings==== | ====List tasks settings==== |
| **Description:** Returns a list of tasks on the EasyMorph Server with a number of attributes such as task ID, project path, annotation, and schedule description. No settings are required for this command. | **Description:** Returns a list of tasks on the EasyMorph Hub with a number of attributes such as task ID, project path, annotation, and schedule description. No settings are required for this command. |
| |
| \\ | \\ |
| ==== Delete folder settings==== | ==== Delete folder settings==== |
| **Description:** Deletes the selected Server folder. | **Description:** Deletes the selected Hub folder. |
| ^ Setting ^ Description ^ | ^ Setting ^ Description ^ |
| |Server Folder<sup>*</sup>|Select the folder to be deleted.| | |Hub Folder<sup>*</sup>|Select the folder to be deleted.| |
| <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:** Creates a new folder under the selected Parent folder on the EasyMorph Server. | **Description:** Creates a new folder under the selected Parent folder on the EasyMorph Hub . |
| ^ Setting ^ Description ^ | ^ Setting ^ Description ^ |
| |Parent Folder<sup>*</sup>|Select the folder under which the new folder will be created.| | |Parent Folder<sup>*</sup>|Select the folder under which the new folder will be created.| |
| \\ | \\ |
| ==== Rename folder settings==== | ==== Rename folder settings==== |
| **Description:** Renames the existing, selected Server folder. | **Description:** Renames the existing, selected Hub folder. |
| ^ Setting ^ Description ^ | ^ Setting ^ Description ^ |
| |Target Folder<sup>*</sup>|Select the existing folder to change the name of.| | |Target Folder<sup>*</sup>|Select the existing folder to change the name of.| |
| \\ | \\ |
| ==== Rename file settings==== | ==== Rename file settings==== |
| **Description:** Renames the existing, selected Server file. | **Description:** Renames the existing, selected Hub file. |
| ^ Setting ^ Description ^ | ^ Setting ^ Description ^ |
| |File path<sup>*</sup>|Select the existing file to change the name of.| | |File path<sup>*</sup>|Select the existing file to change the name of.| |
| |Overwrite|The new file replaces the original file.| | |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.| | |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.| | |Halt project execution|The project will stop processing, and this action will display an error.| |
| |
| \\ | \\ |
| |Do nothing|No change (rename, create, delete) is made to the target folder.| | |Do nothing|No change (rename, create, delete) is made to the target folder.| |
| |Fail|The folder is not renamed, a warning is displayed, and project execution continues.| | |Fail|The folder is not renamed, a warning is displayed, and project execution continues.| |
| |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.| |
| |
| |
