FFAStrans wiki

User Tools

Site Tools

Trace: • workflow • processor_nodes • webinterface
custom_proc:custom_processors

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
custom_proc:custom_processors [2020/04/30 12:12] – emcodemcustom_proc:custom_processors [2023/10/25 15:42] (current) – [Plugin Development] emcodem
Line 1: Line 1:
 ====== Plugin Processor development ====== ====== Plugin Processor development ======
  
-Since Version 1.0, FFAStrans supports adding processors as a plugin. This allows anybody (who is able to) to create his own processors or to download existing processors that other users created.+Since Version 1.0, FFAStrans supports adding processors as a plugin. This allows everyone (who is able to) to create his own processors or to download existing processors that other users created.
 Download an example processor to start with here: {{ :custom_proc:custom_node_example.zip |}} and extract it to \FFAStrans\Processors\plugin_nodes\custom_nodes - then restart the workflow editor and find the example node in "Others" category. Download an example processor to start with here: {{ :custom_proc:custom_node_example.zip |}} and extract it to \FFAStrans\Processors\plugin_nodes\custom_nodes - then restart the workflow editor and find the example node in "Others" category.
  
Line 10: Line 10:
 So the folder \Processors\plugin_nodes\custom_nodes can only contain folders, not files. Each subfolder represents one plugin processor. For information about the contents of each plugin subfolder, keep on reading. So the folder \Processors\plugin_nodes\custom_nodes can only contain folders, not files. Each subfolder represents one plugin processor. For information about the contents of each plugin subfolder, keep on reading.
  
-{{:custom_proc:plugin_base_dir.png?400|}}+{{gallery>:custom_proc:plugin_base_dir.png?400x400&800X800&lightbox}}
  
 In this picture, we see the plugin base directory \Processors\plugin_nodes\custom_nodes. The 2 folders represent each one custom plugin. In this picture, we see the plugin base directory \Processors\plugin_nodes\custom_nodes. The 2 folders represent each one custom plugin.
  
-{{:custom_proc:plugin.png?400|}}+{{gallery>:custom_proc:plugin.png?400x400&800X800&lightbox}}
  
 In this picture we see the contents of an example plugin. The file style.css is not mandatory, it is just used by this processor's index.html. The folder /bin is mandatory, it must contain the script/executeable. In this picture we see the contents of an example plugin. The file style.css is not mandatory, it is just used by this processor's index.html. The folder /bin is mandatory, it must contain the script/executeable.
Line 41: Line 41:
         "category":"Others",         "category":"Others",
         "enabled":"1",         "enabled":"1",
-        "priortiy":"1",+        "priority":"1",
         "description":"Example node",         "description":"Example node",
         "guid": "312dccee-88e1-45b1-906c-9c1234724805",         "guid": "312dccee-88e1-45b1-906c-9c1234724805",
Line 47: Line 47:
  "proc_script":"processor.exe",  "proc_script":"processor.exe",
  "timeout_minutes": 120,  "timeout_minutes": 120,
- "gui_window_height": 400+ "gui_window_height": 400, 
 +        "version":"1.1"
 } }
 </code> </code>
Line 54: Line 55:
   * category: display category in the workflow canvas. possible values: TODO   * category: display category in the workflow canvas. possible values: TODO
   * enabled: when set to 0, processor is not shown in the processor menu in workflow canvas   * enabled: when set to 0, processor is not shown in the processor menu in workflow canvas
 +  * priority: 1 is default, when set to -1, the node is not counted as a running job. Used e.g. for sleeping and waiting processes while allowing other jobs to process instead of blocking the que
   * description: tooltip of the processor icon in workflow canvas   * description: tooltip of the processor icon in workflow canvas
   * ** guid: must be unique for each custom plugin**, best use a guid generator. A workflow stores the plugin based on it's guid, so the guid should not ne changed after plugin installation.   * ** guid: must be unique for each custom plugin**, best use a guid generator. A workflow stores the plugin based on it's guid, so the guid should not ne changed after plugin installation.
Line 60: Line 62:
   * timeout_minutes: a running processor will be killed by ffastrans when the timeout exceeded   * timeout_minutes: a running processor will be killed by ffastrans when the timeout exceeded
   * gui_window_height: the processor gui height in the workflow canvas   * gui_window_height: the processor gui height in the workflow canvas
 +  * version: the current version of this processor. Developers need to raise this number with every release and it can and should be displayed on the index.html gui
  
  
Line 116: Line 119:
 This index.html is used to create the User interface of the processor in the workflow editor ONLY, it is not involved in the actual execution of the processor in a running job. You can create a custom web page that accepts inputs from the user. The input names and values of the saved processor instance in your workflow are passed using a temp JSON file to the processor.exe.  This index.html is used to create the User interface of the processor in the workflow editor ONLY, it is not involved in the actual execution of the processor in a running job. You can create a custom web page that accepts inputs from the user. The input names and values of the saved processor instance in your workflow are passed using a temp JSON file to the processor.exe. 
  
-{{:custom_proc:custom_proc.png?400|}}+{{gallery>:custom_proc:custom_proc.png?400x400&lightbox}}
  
 In the picture above, you see the area in green where your index.html is rendered using IE11. You cannot change the area outside as those buttons are created by FFAStrans host. The only thing you can influence is the display height by altering the plugin definition json.  In the picture above, you see the area in green where your index.html is rendered using IE11. You cannot change the area outside as those buttons are created by FFAStrans host. The only thing you can influence is the display height by altering the plugin definition json. 
- 
  
 The example processor that you can download above contains examples how to use all possible functions and inteactions between the FFAStrans Engine and the index.html.  The example processor that you can download above contains examples how to use all possible functions and inteactions between the FFAStrans Engine and the index.html. 
  
 When a user opens the processor GUI on the workflow editor, FFAStrans will create an Embedded Browser which is Internet Explorer 11 so always develop and test in IE 11.  When a user opens the processor GUI on the workflow editor, FFAStrans will create an Embedded Browser which is Internet Explorer 11 so always develop and test in IE 11. 
 +
 +Note that on some Systems, it is needed to force the document to run in IE11 mode by having these 2 lines at the top of index.html. If you do not add this, the javascript base64 encoder and decoder atob and btoa migth not be available and your plugin might randomly not work on a recent Windows Version.
 +<code>
 +<!DOCTYPE html>
 +<meta http-equiv="X-UA-Compatible" content="IE=11" /> 
 +</code>
  
 For interacting with the embedded Browser, FFAStrans host "executes" or evaluates javascript functions with predefined names and passes Base64 encoded data as argument to the functions. See the example processor for more description. The opening procedure is like that: For interacting with the embedded Browser, FFAStrans host "executes" or evaluates javascript functions with predefined names and passes Base64 encoded data as argument to the functions. See the example processor for more description. The opening procedure is like that:
Line 131: Line 139:
     - When user presses the save preset button, call the function ffas_save_preset() - this function must collect all data to save in a special JSON structue, see below.     - When user presses the save preset button, call the function ffas_save_preset() - this function must collect all data to save in a special JSON structue, see below.
  
-== function  ffas_load_preset ==+== javascript function  ffas_load_preset(json_object) ==
  
 FFAStrans Host calls this function on page load to restore the last configuration or when the user loads a preset.  FFAStrans Host calls this function on page load to restore the last configuration or when the user loads a preset. 
Line 146: Line 154:
  
  
-== function  ffas_save_preset ==+== javascript function  ffas_save_preset() ==
  
 The Host calls this function when the user hits the OK button or saves the preset in the preset menu. This function is expected to collect the inputs and outputs from the html page (e.g. using document.getElementById) and create the same JSON structure as described above in the ffas_load_preset function.  The Host calls this function when the user hits the OK button or saves the preset in the preset menu. This function is expected to collect the inputs and outputs from the html page (e.g. using document.getElementById) and create the same JSON structure as described above in the ffas_load_preset function. 
Line 192: Line 200:
  
   * "data-parent" if present, specifies the ID of the HTML Input Box where the chosen value should go to.   * "data-parent" if present, specifies the ID of the HTML Input Box where the chosen value should go to.
 +  * "data-user_vars_only" if present, values allowed: true or false, specifies if you want to hide all other variables than user_vars. Use this for all HTML inputs where a user should just specify a single variable (e.g. which variable should be filled with the outcome of processor.exe)
  
 === The processor (processor.exe) === === The processor (processor.exe) ===
Line 245: Line 254:
  
 ** Set Outputs from a processor ** ** Set Outputs from a processor **
- 
  
 Setting outputs is optional. If you develop a processor that is not intended to deliver any output back to ffastrans, thats ok and you do not have to read on ;-) Setting outputs is optional. If you develop a processor that is not intended to deliver any output back to ffastrans, thats ok and you do not have to read on ;-)
Line 262: Line 270:
     * s_source     * s_source
       * this can be used to override the current source file (in case the processor created a new file e.g. transcoding)       * this can be used to override the current source file (in case the processor created a new file e.g. transcoding)
 +      * **Note:** Setting s_source to an empty value causes the job to end immediately and dissapear from the job monitor. All cache files and records are deleted by ffastrans in that case.
     * s_success     * s_success
       * this can be used to set a status message for the job monitoring       * this can be used to set a status message for the job monitoring
Line 267: Line 276:
       * setting this will cause the FFAStrans host to go the "error" path in the workflow or end the job with error       * setting this will cause the FFAStrans host to go the "error" path in the workflow or end the job with error
  
 +Usually outputs are already part of the job json because they are passed in from the processor GUI html. 
 +So the processor code does not have to "generate" a new object but instead it only sets the "data" attribute of existing outputs in the existing job json.
 +
 +Take special note about the field names, "id" is optional as it is just the html id of the field on index.html GUI. FFAStrans only needs to know "value" and "data", where "value" has to be some existing variable (user var or predefined system var)
 +
 +<code>
 +"proc_data": {
 +    "inputs": [],
 +    "outputs": [
 +      { 
 +        "id": "",
 +        "value": "s_source",
 +        "data": "C:\\test\\test.ts"
 +      }
 +    ]
 +  }
 +</code>
 +
 +
 +---------
 +
 +<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;</html>[[custom_proc_download: Download Additional Custom Processors|To Plugin Processor Download]]
  
----------------------------------------------- 
 <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>[[custom_proc:custom_processors|Back to top]] <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>[[custom_proc:custom_processors|Back to top]]
  
  
custom_proc/custom_processors.1588248753.txt.gz · Last modified: 2020/11/16 19:08 (external edit)
Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki