Skip to content

๐Ÿ–ฅ๏ธ Creating Routines and Jobflows via GUI โ€‹

This guide explains how to define and run routines and jobflows using the platformโ€™s visual interface. This GUI-based approach complements the code-driven method by offering an intuitive, form-based experience for designing, configuring, and launching complex workflows.


๐Ÿ“Œ Routine Creation in the GUI โ€‹

Instead of writing wkube.py, the GUI provides a form to define a routine as a reusable routine entity.

๐Ÿงพ Metadata Form โ€‹

When creating a new routine:

  • You fill out a structured form that mirrors all the required WKubeTask fields:
    • name, base_stack, command, etc.
  • These fields are one-to-one mapped with the programmatic API.

๐Ÿ› ๏ธ conf Configuration via JSON Schema โ€‹

  • A separate section of the form is generated dynamically using a JSON Schema.
  • This allows you to define any number of additional configuration parameters.
  • When the form is filled, values are converted into a conf dictionary โ€” just like in code โ€” and passed as * environment variables* to the container.

๐Ÿ”„ Explicit Data Mappings โ€‹

The GUI provides explicit input fields for:

  • input_mappings
  • output_mappings

These support semicolon-separated mapping syntax and help users wire up storage paths easily.


๐Ÿ“ธ Routine Creation Form โ€‹

Routine Output

๐Ÿš€ Launching a Routine in the GUI โ€‹

Once a routine entity is saved, you can launch it in multiple ways:

Option 1: From the Routine List โ€‹

  • Navigate to the Routines section.
  • Click the โ€œRunโ€ button on any saved routine.
  • A dispatch form appears:
    • Fields from the metadata and conf are editable.
    • You can override mappings and configuration at launch time.

Option 2: From the File Explorer โ€‹

  • Select one or more files or folders.
  • Right-click and choose โ€œRun with Routineโ€.
  • This injects special mapping keys:
    • selected_files
    • selected_folders
  • These are resolved into full mappings automatically when the job runs.

๐Ÿ“ธ Routine Launch Form โ€‹

Routine Output

๐Ÿงฉ Visual Jobflow Builder โ€‹

The platform provides a graphical interface for designing and launching Jobflows.

๐ŸŽ›๏ธ Jobflow Construction โ€‹

  • Drag and drop previously saved routine entities into a visual canvas.
  • Connect them with:
    • Child relationships
    • Callback relationships

This builds an acyclic execution graph where tasks can be executed in sequence, in parallel, or conditionally.

๐Ÿงฑ Aggregator (Spanner) Nodes โ€‹

  • You can add a dummy aggregator node to group child routines.
  • These spanners donโ€™t run code โ€” they are used for structuring or parallelizing flows.

๐Ÿ” Parallel Execution with Multipliers โ€‹

  • Parallelism is controlled by a multiplier parameter (typically a CSV file).
  • This file can be:
    • Mapped manually in the flow configuration
    • Or more conveniently: selected in the file explorer at launch time

When launching from the file explorer, the selected file is automatically used as the multiplier source for spanner/aggregator nodes.


๐Ÿ“ธ Jobflow Creation View โ€‹

Routine Output

โœ… Summary โ€‹

FeatureCode-BasedGUI-Based
Define Routinewkube.py and WKubeTaskForm-based entity creation
Configure confPython dictJSON schemaโ€“driven form
Data Mappingsinput_mappings, output_mappingsExplicit fields in form
Launch Routineaccli dispatchRun from Routine list or File Explorer
Build JobflowDefine via task graph in codeDrag-and-drop interface
Control ParallelismManual mappingFile-based multiplier at launch
Spanner/Aggregator SupportHolder WKubeTask()Dummy node in Jobflow builder

GUI workflows provide a user-friendly, modular, and reusable way to define and orchestrate jobs, especially helpful for less code-heavy users or collaborative teams.