Mfg Dashboard & Settings
The control-center of the Advanced Manufacturing area: a read-only Dashboard that shows the state of the shop floor at a glance, a Manufacturing Settings screen where you tune how the whole area behaves, and a Units of Measure catalog that every BOM, work order and requisition draws on.
module_manufacturing sub-feature is enabled — see
Getting Started.
Manufacturing (dashboard) and MfgSettings
controllers are wrapped in with_module('manufacturing'). If
module_manufacturing is switched off — or your role lacks the required permission —
you are redirected, not shown a 403 page. A missing link that silently bounces you away
usually means the module is disabled or your permission is missing, not that the page is broken.
The three screens at a glance
production/Manufacturing — read-only KPI cards, recent
in-progress orders, expiring compliance documents, quick actions, and recent inspections.
Gated by the manufacturing permission.
production/MfgSettings — default UOM, document-number
prefixes, requisition auto-approval, and the compliance expiry-warning window. Gated by the
manufacturing_settings permission.
production/MfgSettings/uom — the catalog of measurement units
(Piece, Kilogram, Liter …) with symbols, categories and conversion factors. Also gated by
manufacturing_settings.
The dashboard is reporting only — you cannot change anything from it. Settings and Units of Measure are where you actually configure the area. If you are setting up Manufacturing for the first time, jump to the Configure Manufacturing before first use SOP near the bottom of this page.
The Manufacturing Dashboard
Open Production → Manufacturing → Mfg Dashboard (route
production/Manufacturing). Everything on it is a point-in-time read — there is
no date filter or range picker. Reload the page to refresh the numbers.
KPI cards
Four stat tiles run across the top of the dashboard:
| Field | Meaning | Required | Notes |
|---|---|---|---|
total_orders — Total Orders |
Count of all work orders in any status (not deleted). | Read-only | From get_dashboard_stats(): COUNT(*) on
manufacturing_work_orders where deleted = 0. Shown with an
industry icon. |
in_progress — In Progress |
Count of work orders whose status is in_progress. |
Read-only | The number is coloured orange (warning). |
completed — Completed |
Count of work orders whose status is completed. |
Read-only | The number is coloured green (success). |
open_ncr — Open NCRs |
Number of Non-Conformance Reports currently in open status. |
Read-only | Counts manufacturing_ncr rows with status = 'open'. The number
is coloured red (danger). |
Recent Manufacturing Orders
The wide panel on the left (8/12 width) lists the most recent in-progress work orders so supervisors can see what is running right now. Each row carries a live progress bar.
| Column | Meaning | Required | Notes |
|---|---|---|---|
order_number — Order # |
The work order number. | Read-only | Links to production/MfgWorkOrders/view/{id} — click to open the order. See
Work Orders. |
product_name — Product |
Name of the product being manufactured on that order. | Read-only | — |
priority — Priority |
Order urgency, shown as a coloured badge: low, normal, high, urgent. | Read-only | Colour map below. |
progress — Progress |
Percent produced, drawn as a green progress bar. | Read-only | quantity_produced ÷ quantity_ordered × 100. Shows 0% when
quantity_ordered is 0. |
status — Status |
Work order lifecycle badge: draft, released, in progress, completed, cancelled. | Read-only | Colour map below. The list itself is filtered to in-progress orders. |
Priority badges
Work order status — lifecycle & colours
The dashboard only displays these states; they are driven and changed in the Work Orders screen, never from here.
Expiring Documents panel
On the right, this panel lists active compliance documents that expire soon, so you can act before a permit or certificate lapses. Each entry shows the document number, its type, and the expiry date.
| Field | Meaning | Required | Notes |
|---|---|---|---|
document_number — Number |
Compliance document number for the expiring document. | Read-only | — |
document_type — Type |
The kind of compliance document. | Read-only | — |
expiry_date — Expires |
The document's expiry date. | Read-only | Only active docs with an expiry date within the window appear. Read via
get_expiring_documents(30). See Compliance. |
compliance_expiry_warning_days value you set in Settings.
Changing that setting will not change what appears here. The setting affects other
compliance warnings, not this dashboard panel.
Quick Actions panel
A panel of shortcut buttons on the right jumps you straight to the most common tasks. None of them ask for confirmation — they simply open a form or navigate.
| Button | Effect | Permission | Notes |
|---|---|---|---|
| New Work Order | Opens the Work Orders modal form to create a work order. | Gated on the target screen (manufacturing_work_order). |
Opens a modal — no page navigation. |
| Bill of Materials | Navigates to the Manufacturing BOM screen. | Gated on each target screen. | See Mfg Work Centers & BOM. |
| Quality Control | Navigates to the Quality Control screen. | Gated on each target screen. | See Quality Control. |
| Material Requisitions | Navigates to the Material Requisitions screen. | Gated on each target screen. | See Material Requisitions. |
Recent Inspections table
At the bottom of the dashboard, a Recent Inspections table shows the latest quality checks and their pass/fail split. It only appears when at least one inspection exists.
| Column | Meaning | Required | Notes |
|---|---|---|---|
inspection_number — Inspection # |
Reference number of a recent quality inspection. | Read-only | — |
inspection_type — Type |
The kind of inspection. | Read-only | Underscores are shown as spaces and the label is capitalised. |
inspection_date — Date |
Date the inspection was performed. | Read-only | — |
quantity_inspected — Qty Inspected |
Total quantity inspected. | Read-only | Formatted to 2 decimals. |
quantity_passed / quantity_failed — Pass/Fail |
Passed quantity (green) and failed quantity (red). | Read-only | Two coloured figures side by side. |
status — Status |
Inspection result badge: pending, in progress, passed, failed, conditional. | Read-only | Colour map below. |
Inspection status — lifecycle & colours
SOP — Daily dashboard review
Open the dashboard
Any user with the
manufacturingpermission opens Production → Manufacturing → Mfg Dashboard.Read the KPI counts
Note Total Orders, In Progress, Completed, and especially Open NCRs — a rising red number means quality issues are piling up.
Scan the in-progress orders
In Recent Manufacturing Orders, follow up on any order with low progress or a High/Urgent priority. Click an Order # to open its detail.
Act on expiring documents
Address anything in the Expiring Documents panel (due within 30 days) before it lapses.
Review inspection outcomes
Check the Recent Inspections pass/fail figures and chase up failures.
Manufacturing Settings
Open Production → Manufacturing → Mfg Settings (route production/MfgSettings).
This screen configures module-wide behaviour: the default unit of measure, document-number
prefixes for every record type, requisition auto-approval, and the compliance expiry-warning
window. The form is grouped into four panels — General, Quality, Material
Requisition, and Compliance — with a single Save button at the bottom that
submits the whole form by AJAX (no page reload).
manufacturing_settings permission (category Manufacturing: Settings, action
Manage Manufacturing Settings). Without it you are redirected away.
General Settings
| Field | Meaning | Required | Notes |
|---|---|---|---|
default_uom — Default UOM |
The unit of measure pre-selected across manufacturing entry forms. | Optional | Select2 dropdown populated from active UOMs, each shown as Name (symbol);
the first option is - (none). Stored as the UOM id. |
work_order_prefix — Work Order Prefix |
Prefix used when auto-generating work order numbers (e.g. WO-0001). |
Optional | Default WO-. See the trailing-dash note below. |
bom_prefix — BOM Prefix |
Prefix for auto-generated Bill of Materials codes. | Optional | Default BOM-. |
eco_prefix — ECO Prefix |
Prefix for auto-generated Engineering Change Order numbers. | Optional | Default ECO-. See Engineering Changes. |
Quality Settings
| Field | Meaning | Required | Notes |
|---|---|---|---|
qc_plan_prefix — QC Plan Prefix |
Prefix for Quality Control plan numbers. | Optional | Default QCP-. |
inspection_prefix — Inspection Prefix |
Prefix for inspection record numbers. | Optional | Default INS-. |
ncr_prefix — NCR Prefix |
Prefix for Non-Conformance Report numbers. | Optional | Default NCR-. |
capa_prefix — CAPA Prefix |
Prefix for Corrective And Preventive Action numbers. | Optional | Default CAPA-. See Quality Control. |
Material Requisition Settings
| Field | Meaning | Required | Notes |
|---|---|---|---|
requisition_prefix — Requisition Prefix |
Prefix for material requisition numbers. | Optional | Default MR-. |
issue_prefix — Issue Prefix |
Prefix for material issue numbers. | Optional | Default MI-. |
auto_approve_requisitions — Auto-Approve Requisitions |
Whether material requisitions are approved automatically instead of requiring manual approval. | Optional | Dropdown No (0) / Yes (1). Default 0 (No). Consumed by the
Material Requisitions feature. |
Compliance Settings
| Field | Meaning | Required | Notes |
|---|---|---|---|
compliance_expiry_warning_days — Expiry Warning (Days) |
How many days before a compliance document expires the system should start warning. | Optional | Number input, default 30. Help text: “Number of days before expiry to show
warnings.” |
Saving settings
Click Save and the whole form POSTs to production/MfgSettings/save. Each
setting is upserted by its unique setting_name — inserted if new (as a
string type), or its value and timestamp updated if it already exists.
Make your changes
Edit any of the four panels — General, Quality, Material Requisition, Compliance.
Click Save
The form submits by AJAX; the page does not reload.
Confirm the toast
A green toast appears for about 10 seconds reading “Settings saved successfully.”
get_prefix()
strips one trailing dash, underscore, or space and the calling feature re-appends its own
separator. So WO and WO- produce the same result. Do not add
multiple trailing dashes expecting them to appear in the generated number.
require_qc_approval, enable_lot_tracking,
standard_working_hours_per_day, overtime_multiplier,
default_scrap_percentage, plus seed prefix keys work_order_number_prefix
and bom_code_prefix) that this screen does not expose. Note the seed prefix
keys differ from the form keys (work_order_prefix, bom_prefix), so this
form writes a separate set of prefix rows.
Units of Measure
The Units of Measure (UOM) catalog holds every measurement unit used across manufacturing — Piece,
Kilogram, Liter, Meter, Hour and so on — with its symbol, category, and how it converts to a base
unit. BOMs, work orders, requisitions and other manufacturing quantities all reference this
catalog, and the Default UOM setting stores one of these units'
ids. Open it from Mfg Settings → Units of Measure (route
production/MfgSettings/uom).
The Units of Measure list
The list is an appTable DataTable sorted by Name ascending, with an Add
UOM button in the top-right and per-row Edit/Delete actions.
| Column | Meaning | Required | Notes |
|---|---|---|---|
| Name | Full human name of the unit (e.g. Kilogram). | — | Default sort column, ascending. |
| Symbol | Short symbol/abbreviation (e.g. kg). | — | — |
| Category | The dimension the unit measures. | — | Quantity, Weight, Volume, Length, Area, or Time. |
| Base Unit | The unit this one converts to, or blank if it is itself a base unit. | — | — |
| Conversion Factor | How many base units equal one of this unit. | — | — |
| Status | Active or Inactive label. | — | See the status legend below. |
| Actions | Per-row Edit (pencil) and Delete (×) buttons. | — | — |
Add / Edit UOM — the modal
Both Add UOM (blank modal) and the per-row pencil (Edit, pre-filled) open the same modal
(production/MfgSettings/uom_modal_form), with a Close and a Save button
in the footer. On save the list table reloads automatically.
| Field | Meaning | Required | Notes |
|---|---|---|---|
name — Name |
Full human name of the unit (e.g. Kilogram). | Required | Placeholder “e.g. Kilogram”. Enforced client-side and server-side. |
symbol — Symbol |
Short symbol/abbreviation (e.g. kg). | Required | Placeholder “e.g. kg”. Enforced client-side and server-side. |
uom_type — Category |
The dimension the unit measures. | Optional | Dropdown: Quantity, Weight, Volume, Length, Area, Time. Defaults to
quantity. |
base_unit — Base Unit |
The base unit this record converts to. Leave as None if this unit is itself the base of its category. | Optional | Dropdown lists only units flagged is_base_unit = 1, shown as
Name (symbol); first option is “- None (Base Unit) -”. Picking a base unit
marks this record as derived (is_base_unit = 0); leaving it None marks
this record as a base unit (is_base_unit = 1). |
conversion_factor — Conversion Factor |
How many base units equal one of this unit (e.g. 1 kg = 1000 g). | Optional | Number input, step 0.000001, default 1. Placeholder
“e.g. 1000 (1 kg = 1000 g)”. Stored as decimal(15,6); saved as
null if left blank. |
is_active — Active |
Whether this unit is available for selection elsewhere. | Optional | Checkbox, checked by default for new records. Unchecked = Inactive (still stored, just hidden from active-only dropdowns). |
is_base_unit = 0; saving without one forces is_base_unit = 1. You
cannot manually flag a record as a base unit — it is decided entirely by whether you pick a Base
Unit. And because the Base Unit dropdown only lists units already flagged as base units, if you
never create a base unit for a category, derived units in that category have nothing to reference.
UOM status — lifecycle & colours
deleted = 1;
filtered out of every query and not shown anywhere. Terminal from the UI.SOP — Add a new unit of measure
Open Units of Measure
Go to Mfg Settings → Units of Measure (
production/MfgSettings/uom) and click Add UOM.Enter Name and Symbol
Both are required — e.g. Name Kilogram, Symbol kg.
Pick a Category
Choose the dimension, e.g. Weight. Leave it to default to Quantity if unsure.
Set the base unit if derived
If this is a derived unit, choose its Base Unit and enter the Conversion Factor. Otherwise leave Base Unit as None and the record becomes a base unit itself.
Keep Active checked & Save
Leave Active ticked and click Save. The table reloads with the new unit.
SOP — Add a derived unit with conversion
Confirm the base unit exists
Precondition: the base unit already exists and is flagged as a base unit (it was created with Base Unit = None).
Add UOM
Go to Units of Measure → Add UOM.
Enter Name and Symbol
Both required.
Choose the matching Category
Pick the category that matches the base unit.
Select the Base Unit
Choose it from the dropdown (only base units appear).
Enter the Conversion Factor
Set it to how many base units equal one of this unit.
Keep Active checked & Save
Save. The unit is stored as derived (
is_base_unit = 0).
SOP — Deactivate an obsolete unit (instead of deleting)
Edit the unit
Open Units of Measure and click the pencil (Edit) on the unit.
Uncheck Active & Save
Uncheck Active and click Save. The unit now shows the red Inactive label and disappears from active dropdowns, but stays in the list.
Deleting a unit
The per-row × button soft-deletes the unit (sets deleted = 1) after a
confirmation dialog.
Validation & save messages
| When | Message | Type |
|---|---|---|
| Name or Symbol left blank | “This field is required.” | Validation (client + server) |
| UOM saved | “Record saved successfully.” | Success |
| UOM save fails | “Error occurred. Please try again.” | Error |
| UOM deleted | “Record deleted successfully.” | Success |
| UOM cannot be deleted | “This record cannot be deleted.” | Error |
| Settings saved | “Settings saved successfully.” | Success (green toast, ~10s) |
SOP — Configure Manufacturing before first use
Run this once when you first switch on the Advanced Manufacturing area, so numbering, units and defaults are correct before anyone raises a work order.
manufacturing_settings
permission and the module_manufacturing sub-feature enabled.
Confirm the module is enabled
In Settings → Manage Modules, confirm Manufacturing (
module_manufacturing, beneath the Production package) is on. See Getting Started.Confirm your permission
Ensure your role has the
manufacturing_settingspermission — otherwise the Settings and Units of Measure screens redirect you away.Review the unit catalog
Open Units of Measure and review/seed units (the starter set — Piece, Dozen, Kilogram, Gram, Liter, Milliliter, Meter, Centimeter, Hour, Minute — is pre-seeded). Add any units your products need.
Set the Default UOM
Open Mfg Settings → General and pick the Default UOM.
Set all document prefixes
Set the Work Order, BOM, ECO (General/Quality), QC Plan, Inspection, NCR, CAPA (Quality), Requisition and Issue (Material Requisition) prefixes to match your numbering scheme.
Decide requisition auto-approval
In Material Requisition Settings, set Auto-Approve Requisitions to Yes or No.
Set the expiry warning window
In Compliance Settings, set Expiry Warning (Days).
Save & confirm
Click Save and confirm the green “Settings saved successfully.” toast.
Permissions & access
| Permission | Gates | Category / Action | On denial |
|---|---|---|---|
manufacturing |
The Manufacturing Dashboard (Manufacturing controller). |
Manufacturing: Overview / Access Manufacturing. | Redirect (not 403). |
manufacturing_settings |
The Settings screen and all UOM management (MfgSettings controller). |
Manufacturing: Settings / Manage Manufacturing Settings. | Redirect (not 403). |
module_manufacturing (module gate) |
Both controllers — the sub-feature toggle must be on beneath
module_production. |
Enabled in Settings → Manage Modules. | Redirect (not 403). |
Key terms on this page
- UOM
- Unit of Measure — a measurement unit (Piece, Kilogram, Liter …) used to quantify materials and products.
- Base Unit
- The reference unit of a category to which other units convert (e.g. kilogram for weight). A unit with no base unit is itself a base unit.
- Conversion Factor
- How many base units equal one of this unit; used to convert quantities between related units.
- NCR
- Non-Conformance Report — a record of a quality defect/deviation; open NCRs are counted on the dashboard.
- CAPA
- Corrective And Preventive Action — follow-up actions to resolve an NCR / root cause.
- ECO
- Engineering Change Order — a controlled change to a product design or BOM.
- Compliance Document
- A regulatory/quality document with an expiry date; warned about before expiry.