Dashboard
Scopo
Descrivere il workspace Desk Ez FactoryOS a tutta larghezza, focalizzato su Macchine, Linee di Produzione e Prodotti, e la sincronizzazione delle traduzioni modificabili da Desk.
Prerequisiti
- App installata; utente con
has_app_permission(Factory Admin, Production Manager, Line Operator, Warehouse Operator, Administrator). - Route app:
/desk/ez-factoryos(hooks.add_to_apps_screen). - Concetti Frappe Workspace / Translation: Fondamenti Frappe.
Workspace Ez FactoryOS
File: apps/ez_factoryos/ez_factoryos/ez_factoryos/workspace/ez_factoryos/ez_factoryos.json. Setup: apps/ez_factoryos/ez_factoryos/setup/install.py + setup/dashboard.py + setup/languages.py.
| Elemento | Contenuto |
|---|---|
| Custom HTML Block | Ez FactoryOS Entity Cards (get_entity_cards in ez_factoryos.ez_factoryos.api.dashboard) |
| Card di navigazione | Macchine (Factory Machine), Linee di Produzione (Factory Line), Prodotti (Factory Product) |
| Layout | Full-width (ez_factoryos.bundle.css), workspace standard Frappe non usati nascosti dalla sidebar |
Patch correlate: add_dashboard_entity_cards, remove_workspace_title_header, add_work_order_management, migrate_frappe_v16_workspace, focus_workspace_and_editable_translations.
Nota: i DocType collegati dal form prodotto (Factory Product Category, Factory Product Label, Factory Raw Material, Factory Packaging e relative child table) e i DocType tecnici macchina (Machine Connection Profile, Machine Command, Machine Event, Machine Data Log) restano attivi e raggiungibili dai campi Link o dalla Awesome Bar senza occupare card nella home.
Entity Cards — logica conteggi
Metodo whitelist ez_factoryos.ez_factoryos.api.dashboard.get_entity_cards. Ogni card mostra totale + conteggio errore (rosso) + avviso (giallo); il click apre la List view già filtrata.
| Card | Errore (rosso) | Avviso (giallo) |
|---|---|---|
| Macchine | Offline (is_active=1, status=Offline) | Stato sconosciuto (status=Unknown) |
| Linee | Senza macchine (nessuna riga in Factory Line Machine Item) | Non attive (is_active=0) |
| Prodotti | Senza distinta base (nessuna riga in Factory Product Material Item) | Senza linea (default_line non impostata) |
Traduzioni modificabili da Desk
File sorgente: apps/ez_factoryos/ez_factoryos/translations/it.csv.
All'installazione e ad ogni migrazione (setup_languages / sync_editable_translations in apps/ez_factoryos/ez_factoryos/setup/languages.py) le voci del CSV vengono inserite nel DocType nativo Translation (Traduzione) solo se non esiste già un record per (language, source_text, context). Le correzioni manuali effettuate da Desk nel documento Traduzione hanno precedenza e non vengono sovrascritte alle migrazioni successive.
Logo cliente
Scopo
Mostrare il logo aziendale del cliente o dell'utente finale in tutta la Desk (sidebar su Frappe v16, navbar su Frappe v15) e nella home Ez FactoryOS.
Configurazione
Desk → Awesome Bar → Ez FactoryOS Settings, oppure il segnaposto Aggiungi logo cliente (visibile solo a Factory Admin e System Manager).
| Campo | Tipo | Note |
|---|---|---|
client_name | Data | Nome mostrato accanto al logo nella home e usato come testo alternativo |
client_logo | Attach Image | PNG, JPG, WEBP o SVG caricato nei File di Frappe (/files/... o /private/files/...). Gli URL esterni vengono rifiutati in validate |
hide_client_logo | Check | Default disattivo. Se attivo, il logo è nascosto in tutta la Desk |
File: apps/ez_factoryos/ez_factoryos/ez_factoryos/doctype/ez_factoryos_settings/ (JSON, controller, JS di form, test). Patch: add_client_logo_branding.
Punti di visualizzazione
| Posizione | Ambiente | Implementazione |
|---|---|---|
| Sotto l'intestazione della sidebar | Frappe v16 (target del progetto) | Elemento inserito dopo .body-sidebar .sidebar-header |
| Dopo il brand della navbar | Frappe v15 (bench di sviluppo locale) | Elemento inserito dopo .navbar-brand (su v16 il brand è nascosto su desktop) |
| Testata della home | Blocco Ez FactoryOS Entity Cards | Logo e nome sopra le card |
Il DOM del menu viene riapplicato a ogni cambio di pagina e dopo ogni modifica strutturale della sidebar (MutationObserver), senza duplicati. Dopo il salvataggio delle impostazioni menu e home si aggiornano senza ricaricare la pagina.
flowchart LR
settings["Ez FactoryOS Settings"] -->|"boot_session"| boot["frappe.boot.ez_factoryos_client_branding"]
boot --> bundle["ez_factoryos.bundle.js"]
bundle --> menu["Sidebar v16 o Navbar v15"]
boot --> home["Testata home"]
settings -->|"after_save"| refresh["get_client_branding"]
refresh --> bootPermessi e sicurezza
- Modifica delle impostazioni: ruoli Factory Admin e System Manager (permessi del DocType).
- Visibilità del segnaposto: calcolata lato server (
can_editinez_factoryos.ez_factoryos.api.branding.get_client_branding), non lato client. - Il payload espone solo URL del logo, nome e flag: nessun dato sensibile.
- Il nome cliente viene scritto nel DOM come testo, non come HTML.
Verifica
- Desk → Awesome Bar → Ez FactoryOS Settings → caricare il logo in Logo aziendale cliente → Salvare.
- Il logo compare nel menu (v16) o nella navbar (v15) e nella home senza ricaricare la pagina.
- Un utente con ruolo diverso da Factory Admin / System Manager non vede il segnaposto.
- Test automatici:
bench --site <site> run-tests --module ez_factoryos.ez_factoryos.doctype.ez_factoryos_settings.test_ez_factoryos_settings.
Troubleshooting e rollback
| Sintomo | Causa probabile | Azione |
|---|---|---|
| Nessun logo e nessun segnaposto | hide_client_logo attivo, oppure utente senza ruolo di configurazione | Deselezionare il campo; per il segnaposto verificare il ruolo Factory Admin |
| Immagine non visualizzata | File rimosso dai File di Frappe | Ricaricare il logo |
| "Logo cliente non valido" al salvataggio | URL esterno o estensione non ammessa | Usare il campo Attach Image |
| Voce "Ez FactoryOS: logo cliente non disponibile" nell'Error Log | Errore in boot_session | La Desk si apre senza logo; verificare il traceback nell'Error Log |
Rollback non distruttivo: spuntare Nascondi logo cliente e salvare. Per rimuovere il dato, svuotare Logo aziendale cliente.
Uso quotidiano
- Login Desk → App Ez FactoryOS (
/desk/ez-factoryos). - Leggere le tre Entity Cards in alto (Macchine, Linee, Prodotti): i chip rossi/gialli indicano i record da completare o verificare.
- Click su una card o su un chip → List view filtrata.
- Per correggere una traduzione a caldo: Awesome Bar → Traduzione (
Translation) → modificareTesto Tradottoe salvare.
Verifica
- Login Desk → App Ez FactoryOS.
- Verificare la presenza delle tre card (Macchine, Linee, Prodotti) a tutta larghezza.
- API (da console bench o REST): metodo whitelist
get_entity_cards.
curl -sS -X GET "https://factoryos.ezbit.it/api/method/ez_factoryos.ez_factoryos.api.dashboard.get_entity_cards" \
-H "Authorization: token <api_key>:<api_secret>"Troubleshooting
- Workspace non aggiornato post-migrate: eseguire
bench --site <site> migrate && bench --site <site> clear-cache. - Permesso negato: verificare ruolo utente (solo i 4 ruoli Factory + Administrator vedono l'app).
- Card con conteggio zero ma record presenti: verificare
is_activee permessi di lettura sul DocType.
