Differences

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

--- workflows:workflow [2020/01/21 16:02] – benjamin
+++ workflows:workflow [2024/01/28 10:16] (current) – benjamin
@@ Line 1: / Line 1: @@
-====== Workflow General information======
+====== Workflow General information ======
-This page should describe all "basic workflow information around workflows, e.g. branching behaviour etc...
+This page should describe detailed background information around workflows, e.g. branching behaviour etc...
-=== File Flow ===
+===== File Flow =====
-{{:workflows:workflow_file_flow.png?400|}}
+{{gallery>:workflows:workflow_file_flow.png?500x260&1500X1500&lightbox}}
-=== Workflow Properties ===
+===== Workflow Properties =====
 All these properties are accessible by right-clicking on a workflow in workflow manager.
+==== General Tab====
 |< 100% 15% 85% >|
-^    **General Tab**  ^^^
+^Setting^Description|
-^ **Description** |Description of your workflow. Has no implication on functionality but it will be displayed in the upper editor area if description is enabled there.|
+| **Description** |Description of your workflow. Has no implication on functionality bu it will be displayed in the upper editor area if description is enabled there.|
-^**Work folder**| This info tells you where the work folder for the workflows jobs reside. This is set automatically from the "Work cache" options in the main configuration and cannot be changed by the user.|
+|**Work folder**| This info tells you where the work folder for the workflows jobs reside. This is set automatically from the "Work cache" options in the main configuration and cannot be changed by the user.|
-^**Workflow ID**|Shows the ID of the workflow. This is automatically generated and cannot be changed by the user.|
+|**Workflow ID**|Shows the ID of the workflow. This is automatically generated and cannot be changed by the user.|
-^**Sleep timer**|Here you set the loop for how many seconds FFAStrans should wait for the workflows monitors to start looking for new files. In workflows without monitors this setting as no effect.|
+|**Sleep timer**|Here you set the loop for how many seconds FFAStrans should wait for the workflows monitors to start looking for new files. In workflows without monitors this setting as no effect.|
-^**Priority**|This sets the workflow priority. This is NOT a CPU priority but rather job run order priority. The higher priority jobs will be processed before lower priority jobs. However, already started lower priority jobs will not stop or pause if higher priority jobs is queued. __//**Note**//__: Jobs manually submitted from the GUI will always have the highest priority. Jobs submittet through the API will use the default workflow priority unless specified different in the job post.|
+|**Cron**|Monitoring for new files support the Cron notation for more complex scheduling. Please consult https://en.wikipedia.org/wiki/Cron for more info or see the graph below table|
-^**Timeout level**|Defines how quick FFAStrans will abort jobs that seem to have stopped for various reasons. Usually due to encoding/decoding hangups. The lower the number the faster FFAStrans will abort. When working with very large files you might need to set this higher.|
+|**Priority**|This sets the workflow priority. This is NOT a CPU priority but rather job run order priority. [[system:processes#priority_flow_chart_and_example|The higher priority jobs will be processed before lower priority jobs]]. Lower priorities jobs will be paused if higher priority job is starting.  \\ __//**Note**//__: Jobs manually submitted from the GUI will always have the highest priority. Jobs submitted through the API will use the default workflow priority unless specified different in the job post.|
-^**Active on**|Here you can set on what week day on which the workflows monitors will be active.__//**Note**//__: Regardeless of this setting and the workflow state, one can always submit jobs either manually from the GUI or through the API.|
+|**Timeout level**|Defines how quick FFAStrans will abort jobs that seem to have stopped for various reasons. Usually due to encoding/decoding hangups. The lower the number the faster FFAStrans will abort. When working with very large files you might need to set this higher.|
+|**Run on**|Here you can set on what week day on which the workflows monitors will be active. \\ __//**Note**//__: Regardless of this setting and the workflow state, one can always submit jobs either manually from the GUI or through the API.|
+\\
 \\
+{{gallery>:workflows:cron.png?600x200&1500X1500&lightbox}}
 \\
+\\
+==== Maintenance Tab===
+|< 100% 15% 85% >|
+^**Setting**^**Description**|
+|**Keep all job work folders on completion**|Enabling this option will prevent FFAStrans from deleting all the files and work folders it creates for jobs. \\ __//**Note**//__: You should avoid enabeling this as the it may fill up your storage. Use only for debugging.|
+|**Keep only failed job work folders**|Enabling this option will prevent FFAStrans from deleting the work folders for failed jobs. \\ __//**Note**//__: In this regard, a job is considered failed only if the last executing branch has failed outcome.|
+|**Validate records after <n> days**|This option tells FFAStrans how many days it should "remember" what files it has processed. If a file has been registered longer than the number of days specified, AND the original file is gone, the file record will be removed. If the file comes back after removal, FFAStrans will see it as a new file.|
+|**Keep work files for <n> days**|This option tells FFAStrans how many days it should keep the work folders for each job.|
+\\
+==== Farming Tab ====
+Here you can include or exclude hosts in the workflow. The purpose of this is to create segregated farming environment that lets you design special workflow for special members of the farm.
 |< 100% 15% 85% >|
-^    **Maintenance Tab**  ^^^
+^**Setting**^Description|
-^**Keep all job work folders on completion**|Enabling this option will prevent FFAStrans from deleting all the files and work folders it creates for jobs.__//**Note**//__: You should avoid enabeling this as the it may fill up your storage. Use only for debugging.|
+|**Host**|The host to add to the list. Default is the current host. You can insert any host on the list. The hosts will not be validated so you must write the correct name for the host.|
-^**Keep only failed job work folders**|Enabling this option will prevent FFAStrans from deleting the work folders for failed jobs.__//**Note**//__: In this regard, a job is considered failed only if the last executing branch has failed outcome.|
+|**Add host**|Add the host to the group.|
-^**Cleanup time**|Here you can set the time of day on which FFAStrans will perform cleanup of cachefile. This option may disappear in future versions.|
+|**Add group**|Add the hosts group to the list (For more information about groups, see below the table).|
-^**Validate records after <n> days**|This option tells FFAStrans how many days it should "remember" what files it has processed. If a file has been registered longer than the number of days specified, AND the original file is gone, the file record will be removed. If the file comes back after removal, FFAStrans will see it as a new file.|
+|**Remove**|Removes selected host(s) or selected group(s) from the list.|
-^**Keep work files for <n> days**|This option tells FFAStrans how many days it should keep the work folders for each job.|
+|**List includes hosts/groups**|Option tells the workflow that the hosts (or groups) on the list will take part of the workflow jobs.|
+|**List excludes hosts/groups**|Option tells the workflow that the hosts (or groups) will NOT take part of the workflow jobs.|
+\\
+__//**Note**//__: An empty list makes all the host participate in the workflow jobs regardless of the two latter options.
+\\
+==== Special Tab ====
+|< 100% 15% 85% >|
+^**Setting**^Description|
+|**Log Level**|Sets the log level of the workflow. Higher log levels produce more detailed logging information for debugging. Logging is always on.|
+|**Protect workflow**|Here you can protect you workflow with a password. Note that this is not a foolproof protection. It's purpose is to make sure your workflow has a basic protection so it's not easily tampered with.|
+|**Force 32bit dependencies**|Force FFAStrans to use only 32 bit versions of all dependencies like FFMpeg and AviSynth. This option will override all other 64 bit settings in any workflow nodes.|
+----------------------------------------------------
+<html>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</html>[[workflows:workflow|Back to top]]