Skip to main content

User guide

The Workflow Editor is a single web app. After logging in through Keycloak you land on the Warehouse.

The editor: header, the left navigation rail and the Warehouse.
The editor: header, the left navigation rail and the Warehouse.

Layout​

  • Header — project name, a Documentation button (opens this site), a theme toggle (light / dark / system), logout and your initials (click to open Settings).
  • Navigation rail (left) — one icon per page, in this order:
PageWhat it is for
WarehouseYour catalogue: workflows, digital resources, workers, data kinds, processor definitions and (admins) data interface types.
Workflow LabDesign, configure, save, run and monitor one workflow.
Workflow Assistant (Preview)Draft workflows and resources by chatting.
Kibana VisualizationsOpen Elasticsearch resources in Kibana with ready-made dashboards.
Worker RuntimeContainers per worker: health, logs, start / stop / restart.
Logstash MonitorStatus and event counters of every Logstash pipeline.
Airflow DAGsThe Airflow UI (administrators only).
SettingsTheme, credentials, GitHub tokens, AI provider, initialization.

Roles​

Everyone sees their own catalogue objects plus shared and built-in ones. Users whose Keycloak roles contain admin additionally get the Data Interface Types tab, the Airflow DAGs page and the Initialize Resources action, and can edit or delete any workflow template.

Typical order of work​

  1. Initialize resources (once per user).
  2. Register workers.
  3. Add or reuse processor definitions.
  4. Describe data with data kinds and digital resources.
  5. Compose and run a workflow in the Workflow Lab.
  6. Observe and operate: Observations, Kibana, Worker Runtime.

Stuck? See Troubleshooting & FAQ.