Module screens

Most desktop screens are generated from metadata by the generic widgets. This reference lists the hand-written screens in the seven folders of src/cluster_erp/desktop/modules/, how a sidebar section reaches each one, the server routes each calls, and what each adds. Business rules behind the routes are documented on the module pages linked in each section.

Scope and source¶

• Defined in: src/cluster_erp/desktop/modules/ and the registry _CUSTOM_WIDGET_REGISTRY (src/cluster_erp/desktop/widgets/main_window.py:501-528).
• Count: 7 folders. 13 Python files with code, found by listing non-empty .py files. 10 registry entries. The folder purchasing_quotations holds only an empty __init__.py.
• Server routes were collected by searching each file for string literals that start with a module path. Paths are relative to the API base.

How a section reaches a screen¶

A sidebar section with view_type custom names a custom_widget. MainWindow looks up <module>.<custom_widget> in the registry, imports the class, and calls it with the API client, the signal bus, the translator, the metadata store, and the foreign-key cache (src/cluster_erp/desktop/widgets/main_window.py:530-553). The sidebar hides a custom section whose key is not in the registry (src/cluster_erp/desktop/widgets/sidebar.py:217-221).

Three more classes are not in the registry. BomBuilderPanel is embedded in BomExplorer (src/cluster_erp/desktop/modules/bom/bom_explorer.py:1494-1497). TimePhasedDialog and PeggingDialog open from PlannedOrdersView (src/cluster_erp/desktop/modules/procurement/mrp/planned_orders.py:492-519).

Bill of materials¶

BomExplorer is a two-tab explorer. The docstring describes a component tree fed by GET /bom/bom-versions/{id}/tree, with drill-down and a where-used view, and an operation tree for routings with inline standard-time editing and input assignment (src/cluster_erp/desktop/modules/bom/bom_explorer.py:1-15). It has apply_navigation, so a record link can open it on one bill of materials (src/cluster_erp/desktop/modules/bom/bom_explorer.py:1846). It reads the colour-blind mode for its tree delegate and listens to accessibility_changed (src/cluster_erp/desktop/modules/bom/bom_explorer.py:1412-1419, src/cluster_erp/desktop/modules/bom/bom_explorer.py:1118).

BomBuilderPanel is the explorer's edit mode: a product palette, an item hierarchy edited by drag and drop with a cycle guard, and an inspector form. Only draft versions are editable, and every mutation emits a bom_item change signal (src/cluster_erp/desktop/modules/bom/bom_builder.py:1-12, src/cluster_erp/desktop/modules/bom/bom_builder.py:838-840).

Business rules: BOM module.

Calendars¶

GlobalCalendarView has two tabs: the group calendar, edited with WorkingCalendarPanel in group mode, and an overview grid of every organisation calendar over a date range (src/cluster_erp/desktop/modules/calendars/global_calendar_view.py:1-11, src/cluster_erp/desktop/modules/calendars/global_calendar_view.py:83). In a worker, the overview reads /calendars/calendars, /owned_organisations/organisations/, and /calendars/calendars/{id}/preview for each group or organisation calendar (src/cluster_erp/desktop/modules/calendars/global_calendar_view.py:50, src/cluster_erp/desktop/modules/calendars/global_calendar_view.py:136-165). Business rules: calendars module and working time.

Inventory¶

WarehouseDashboard reads /inventory/warehouses/dashboard and draws cards and bar charts. A double-click on a card emits navigate_to for the card's module and section (src/cluster_erp/desktop/modules/inventory/warehouse_dashboard.py:76-97, src/cluster_erp/desktop/modules/inventory/warehouse_dashboard.py:258). Business rules: inventory module.

Logs¶

Both use their own QAbstractTableModel (src/cluster_erp/desktop/modules/logs/activity_log_view.py:67, src/cluster_erp/desktop/modules/logs/error_log_view.py:61). Business rules: logs module.

Procurement and MRP¶

The bulk action create_pr posts selected planned items to .../items/bulk-action (src/cluster_erp/desktop/modules/procurement/mrp/planned_orders.py:411-417). MrpDashboard cards emit navigate_to (src/cluster_erp/desktop/modules/procurement/mrp/dashboard.py:94). Business rules: MRP.

Production¶

SchedulingBoard is a Gantt board: rows are work centers, the axis is time, and bars are scheduled work orders. The docstring describes drag with snapping, conflict colouring computed on the client, cancel with Esc, undo with Ctrl+Z, nudging with arrow keys, and a precise date-time editor on double-click (src/cluster_erp/desktop/modules/production/scheduling_board.py:1-16). It reads /production/scheduling/board and writes /production/scheduling/work-orders/{wo_id}/schedule and /production/scheduling/work-orders/{wo_id}/auto-schedule with a work_order descriptor (src/cluster_erp/desktop/modules/production/scheduling_board.py:2096-2099, src/cluster_erp/desktop/modules/production/scheduling_board.py:2263-2293). It reloads when a work order or work center changes (src/cluster_erp/desktop/modules/production/scheduling_board.py:1516-1525) and opens records through open_entity (src/cluster_erp/desktop/modules/production/scheduling_board.py:2220). Business rules: scheduling.

Purchasing quotations¶

The package src/cluster_erp/desktop/modules/purchasing_quotations/ contains only an empty __init__.py. Supplier quotations appear on the desktop through the generic widgets when the server metadata declares them. Business rules: purchasing quotations module.

Constraints and validation¶

• Every registered class takes the five keyword arguments that _create_custom_widget passes (src/cluster_erp/desktop/widgets/main_window.py:544-553).
• The docstrings of BomExplorer and SchedulingBoard state that the screens use only the REST API and no direct module calls (src/cluster_erp/desktop/modules/bom/bom_explorer.py:13-14, src/cluster_erp/desktop/modules/production/scheduling_board.py:3-4).

Discrepancies¶

Terms introduced¶

Related pages¶

• Desktop client
• Tabs, panes, and layout
• Generic widgets
• Modules

Verified against commit 92f8051 on 2026-11-13.