Differences

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

--- webinterface:webinterface [2024/01/28 17:17] – benjamin
+++ webinterface:webinterface [2026/04/03 21:34] (current) – [Main Menu] emcodem
@@ Line 17: / Line 17: @@
 Installing the Webinterface as a service is optional, you can also just execute "server.exe" for testing. \\ \\
-Before installing the webinterface, make sure the **FFAStrans API is running** as described here: [[gui:installation|Installation]].
 __**Note:**__ It is recommended to extract the installation package in the same folder than FFAStrans folder. \\
@@ Line 50: / Line 48: @@
 ====Main Menu====
-The Webinterface works only if :
-  * **FFAStrans API is running**
 If your webserver(webinterface) runs on the same server as your main ffastrans server, open your web browser and type : **http://localhost:3002**
@@ Line 70: / Line 65: @@
 === Introduction to Manual Review ===
-{{webinterface:manual_review_1.png?link700&800X800&lightbox}}
 Since Version 1.4 there is Manual review (Review Queue) Menu Item.
@@ Line 83: / Line 78: @@
   - Feature 2: Additionally create a Form using webui Form variables and get very sophisticated information from the user e.g. a MAM Metadata Form
+\\
 How it works:
@@ Line 89: / Line 86: @@
   * Optionally you can present a nice Form using webui form variables, after the user selected one option and before he starts the follow-up
+{{webinterface:manual_review_1.png?link700&800X800&lightbox}}\\
-{{webinterface:manual_review_2.png?link700&800X800&lightbox}}
+{{webinterface:manual_review_2.png?link700&800X800&lightbox}}\\
+{{webinterface:manual_review_3.png?link700&800X800&lightbox}}\\
 ==== User Form ====
@@ Line 100: / Line 97: @@
 There is a GUI for creating and editing the look and feel of Form fields found on Webinterface in the "FFAStrans Admin"/Variables Section
-{{webinterface:manual_review_3.png?link700&800X800&lightbox}}
+{{webinterface:form_vars_demo_.jpg?link700&800X800&lightbox}}
 The following types of userinput are supported:
@@ Line 142: / Line 139: @@
 </code>
-https://docs.dhtmlx.com/suite/form/api/text/api_text_properties/
+==== Segment submission and processing ====
-=== Submit all selected files into one job for concat/stitch ===
+Currently since Webint 1.4.0.38, you need to use the player to set in/out points.
+Of course your workflow must add support for this special type of source.
-In FFAStrans workflow editor - workflow properties, you can enter a workflow description. Add the keyword webui_stitch. If this word is found in the workflow description, all selected files are submitted as json array into s_source variable and you can use e.g. the "Foreach" Processor to process all Files separately.
+In case of segments, Webinterface will submit a special predefined variable called "o_source", this is a complex JSON object containing all the needed information.
-----------------------------------------
-==== User Manager Menu====
+**Simple example:**
+In this case, we just showcase a minimal workflow, due to the nature of ffmpeg "concat" functionality it will only work correctly with I-Frame only source files.
-{{gallery>:webinterface:webinterface_user_manager_menu.png?900x900&1200X1200&lightbox}}
+{{ :webinterface:emcodem_concat_1.4.3_ffmpeg_cuts_no_transcode.json |}}
-This menu is only useful if "STATIC_USE_WEB_AUTHENTIFICATION"(Server Configuration Menu) is enabled. \\
-The purpose is to filter Webinterface access rights based on users. Here is the procedure :
-  - Create first your groups (admin, users, monitoring,etc).
-  - Click on a group (admin for example) and assign rights (drag a grid row from left to right).
-  - Create admin user(name and password), click on it and drag a group from left to right to link user to a group.
-  - Repeat the procedure to link each user to his group.
+**More complex, frame accurate example:**
+This is a complex showcase where we use Avisynth to cut the segments frame accurately and after that, stitch all source files into one.
-You can use filters per group(filter rules), see inbuilt documentation for details.
+{{ :webinterface:emcodem_concat_1.4.3_avisynth_cuts.json |}}
--------------------------------------------
-==== Server Configuration Menu====
-{{gallery>:webinterface:webinterface_server_configuration_menu.png?900x900&1200X1200&lightbox}}
+==== Submit all selected files as array into one job for concat/stitch ====
-This menu allows to configure the Webinterface : Header name, browse locations, port number, etc. Click "Save" after making your settings.\\
+In FFAStrans workflow editor - workflow properties, you can enter a workflow description. Add the keyword webui_stitch. If this word is found in the workflow description, all selected files are submitted as json array into s_source variable and you can use e.g. the "Foreach" Processor to process all Files separately.
-See inbuilt documentation for settings details.\\
-(See [[webinterface#instance Name|Instance Name]] if your header's name is too large)
+  * Note that webui_stitch keyword in the workflow description will cause %s_source% variable to be a JSON array of file paths or URLs.
+----------------------------------------
+==== User Manager Menu====
+{{tutorials:users_manager.mp4?link700}}
+-------------------------------------------
------------------------------------------------
 ==== Scheduler Menu====
@@ Line 225: / Line 224: @@
 <code>http://localhost:3002/webinterface/components/login.html?username=admin&password=Passw0rd</code>
-== New documentation work in progress for webinterface Version 1.4 ==
+=== Jobstarter workflow control using URL Parameters since Version 1.4 ===
 [[webui_jobstarter]]
+=== Override CSS globally ===
+[[webui_alternate_server]]
+=== Retrieve username of logged in user who submitted a job from Webui ===
+If a job was submitted on WebUI Job Submitter page, this variable should carry the username of the logged in user:
+%s_job_submit_username%