Differences

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

--- gui:user_interface [2022/02/13 15:54] – ffastra
+++ gui:user_interface [2024/03/19 07:43] (current) – [Undertand priority connection] emcodem
@@ Line 1: / Line 1: @@
 ====== FFAStrans User Interface ======
+---------------------
+===== FFASTRANS Main Menus =====
-----
+  * **File**
-The GUI (Graphical User Interface) has 3 main parts.\\
+     * **Import workflow(s)** : Imports valid workflows packs (. json) into FFAStrans. It also supports importing legacy (. xml) files.
+     * **Export workflow(s)** : Exports the selected workflow as an .ini file. If a folder i selected, all the workflows within that folder are exported.
+     * **Export all workflows** : Exports all the workflows in FFAStrans.
+     * **Shut down FFAStrans farm** : Shuts down and exits all instances of FFAStrans in the farm. In order to give some farm protection you need admin credential to perform this operation.
+     * **Exit FFAStrans** : Exits the local instance of the FFAStrans Workflow Manager. Note that this will not stop a running FFAStans service.
+  * **Workflows**
+     * **Search workflows** : Opens a free text search window. Also works with Ctrl+F.
+     * **Start all enabled workflows** : Start all enabled workflows
+     * **Stop all running workflows** : Stop all running workflows
+     * **Enable all disabled workflows** : Enable all disabled workflows
+     * **Disable all enabled workflows** : Disable all enabled workflows
+  * **Options**
+    * **Show status monitor** : Opens the FFAStrans monitor where you can monitor and abort jobs being executed by workflows. If the FFAStrans folder is on a shared path, the monitor can be opened by any computer with access to the shared path. The status monitor can also be run without starting the main GUI by running FFAStrans.exe with "-monitor" as argument.
+    * **Configuration** : Opens the global configuration for FFAStrans.
+    * **User variables** : Opens the user variables windows to manage user variables and statics.
+    * **Clear all job work cache** : Clear all cache files from work folders. NOT available in passive mode! **Warning: Make sure NO jobs are running when performing this operation.**
+-------------------------------------------
+===== General Interface =====
 {{:gui:ff_interface.png?nolink&700|}}\\
@@ Line 18: / Line 42: @@
   * **Start**  - Starts Watchfolders.
-    * Only relevant for workflows that contain monitor nodes.
+    * Relevant for workflows that contain watchfolder Nodes only.
   * **Stop** - Stops watchfolders.
-    * Only relevant for workflows that contain monitor nodes.
+    * Relevant for workflows that contain watchfolder Nodes only.
   * **Enable** - Activates ability to Start watchfolders
-  * **Disable** - Makes the workflow unstartable. Mostly used for deprecated workflows.
+    * Also enables API to submit Jobs to this workflow
+  * **Disable** - Makes the workflow unuseable by API and one cannot Start watchfolders even by accident
   * **Submit File(s)**  - Submit file(s) manually (browser).
   * **Submit File from Input**  - Enter full path to submit.
@@ Line 45: / Line 70: @@
     * On processor's header : Configure Node.
 {{:gui:ff_wc_interface_lclick_on_header.png?nolink&250|}}
-    * On output link(blue square) : Hold click and release on next node to connect.
+    * On output link(blue square) : Hold click and release on next node to //normal// connect(See [[user_interface#Undertand priority connection|Undertand priority connection]]).
+    * On output link(blue square) then hold shift : Hold click and release on next node to //priority// connect(See [[user_interface#Undertand priority connection|Undertand priority connection]]).
     * + Shift : Copy selection.
     * + Ctrl : Delete selection.
-    * Double-click on Processor's center : Edit node text.
+    * Double-click on Processor's center : Edit node text(Picture A), set your job processing slot and set your hosts group(Picture B,1 and 2).
-<note warning>After changes, the header on a pink background indicates a change in the workflow canvas that has not been saved. Type Crtl+S to save or click on Workflow Manager and choose 'YES' to the warning box. </note>
+{{:gui:ff_wc_interface_ldblclick_on_node2.png?nolink&250|}}
+{{:gui:ff_wc_interface_ldblclick_on_node3.png?nolink&250|}}
-{{:gui:ff_wc_interface_ldblclick_on_node.png?nolink&250|}}
     * + Ctrl on connection to delete it.
     * + Alt lasso functionality for selecting several nodes in the editor(new in version 1.2).
+<note warning>After changes, the header on a pink background indicates a change in the workflow canvas that has not been saved. Type Crtl+S to save or click on Workflow Manager and choose 'YES' to the warning box. </note>
   * **Right Click** :
     * On Node : Node menu.
@@ Line 63: / Line 88: @@
        * **Submit File from input** : Enter full path to submit.
        * **Bypass Processor** : On/Off.
-{{:gui:ff_wc_interface_rclick_on_node.png?nolink&250|}}
+{{:gui:ff_wc_interface_rclick_on_node2.png?nolink&250|}}
     * On Node Input(green square) : Select execute on success, error or any case.
 {{:gui:ff_wc_interface_rclick_on_link.png?nolink&250|}}
     * On Grid : Canvas menu.
        * **Insert Processor** : Create new node(by category).
+       * **Insert Workflow** : Forwards the job and all it's data to another workflow.
        * **Auto Arrange** : Reorganize all nodes.
        * **Enable Snapping** : Enable snapping to the grid.
 {{:gui:ff_wc_interface_rclick_on_grid.png?nolink&250|}}
+===== Understand priority connection=====
+A priority connection (brown line) allows to prioritize a workflow's branch. This means this "priority" branch will go to the end before a normal connection starts.\\
+This animation explains how it works : \\
+{{gui:branch_priority_process.mp4?700x500|branch_priority_process.jpg}} \\
+How to create a priority connection : \\
+{{gui:priority_connection.mp4?700x500|priority_connection.jpg}}