Differences

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

--- variables:inbuilt_variables [2021/02/10 11:13] – [5.FFAStrans Variables] emcodem
+++ variables:inbuilt_variables [2021/06/01 19:10] – benjamin
@@ Line 131: / Line 131: @@
-***Note** : %%The %s_pickup_file% is ALWAYS the file that's being picked up by monitors, hence its name. But, this might be just a link to another file. Consider the case of for example a "c:\shortcut.lnk" file. This file just point to another file, say "\\server\share\cool.mp4"%%
+<note> : %%The %s_pickup_file% is ALWAYS the file that's being picked up by monitors, hence its name. But, this might be just a link to another file. Consider the case of for example a "c:\shortcut.lnk" file. This file just point to another file, say "\\server\share\cool.mp4"%%</note>
 This gives us the following different contents of the two variables:\\
@@ Line 188: / Line 188: @@
 |**%s_job_id%**|GUID identifier for the current job (20160219-202314-181-4693BFCC0A72).|
 |**%s_job_work%**|Work folder for the current job (D:\_ffas_workroot\2015052120481\20160219-202314-181-4693BFCC0A72).|
+|**%i_job_priority%**|Priority of the current running job.|
 |**%s_wf_id%**|Identifier for the current workflow (20150521204819).|
 |**%s_wf_name%**|Name of the current workflow (Untitled).|
+|**%s_wf_folder%**|Folder name of the current workflow.|
+|**%s_split_id%**|Split/branch id of the current running job.|
 |**%s_node_name%**|Name of the current working processor node (XDCAM-HD).|
 |[[variables:Inbuilt_variables#special_variables|%s_source%]] |Full path to the file work file passed by FFAStrans processors. 4'th level source. Any file set as current input/output source for processors'|
@@ Line 202: / Line 205: @@
 ----
 ===== Special Variables  =====
-**%s_source%** is the most important variable in FFAStrans. It does represent the current "input file" for any processor.
+There is currently one variable that behave a bit different than others:
-{{gallery>:variables:source_tutorial.png?500x500&1200X1200&lightbox}}
+**%s_original_path~n%** = Folder name n-steps backwards.
-__Operations with %s_source%:__
+{{:variables:original_path.jpg?nolink&600|}}
-  * You can use a Populate Variables Processor to change %s_source% to another file if you need to
-    * Typical example: the workflow starts with a .txt file instead of a media file, it calculates the path to the media file and then sets %s_source% to the calculated value
-  * Whenever the value of s_source is changed, FFAStrans will execute the analysis (mediainfo/ffprobe/exiftool) internally and update all Media related variables
-  * If you change %s_source% to a non-media file (or any other value), all the Media Variables will be empty/invalid
-  * Setting %s_source% to "" (nothing) will cause the current branch/job to end and dissapear from the status monitor - the job is not just dispelled but deleted from history
+**%s_source%** represent the input file for any processor. It can be altered using the "Populate variables"-node.
-**%s_success%** represents the "success message" in the Job Status Monitor upon Job completion. It can be altered using the "Populate variables"-node. Workflow developers often use this method to investigate the current value of a variable.
+{{:variables:source_tutorial_m1.png?nolink&1200|}}
-__Operations with %s_success%:__
+**%s_success%** represent the success message upon job completion. It can be altered using the "Populate variables"-node.\\
 In this example, the objective is to ensure that the input file has a video stream to perform the H264 encoding. Otherwise a message in the status monitor and in Webinterface's jobs list will appear. In this particular workflow, each branch leads to a success(but "no video" node isn't one for the user). The trick is to turn that success into "error" for user. Don't forget to use "//execute on success//"(conditional "TRUE") to continue to H264 node OR "//execute on error//"(conditional "FALSE") to continue to another node.\\
 You just have to finish your branch by populated the %s_success% variable to a message of your choice e.g: "error" or "failed" or for the example "No video in input file".
-{{gallery>:variables:success_variable.png?500x500&1200X1200&lightbox}}
+{{:variables:success_variable.png?nolink&800|}}
-**%s_original_path~n%** = Folder name n-steps backwards.
-{{:variables:original_path.jpg?nolink&600|}}
 -----