Zum Hauptinhalt springen

Speambox Installations-Anleitungen (SpeamboxInstallationGuides)

Zweck

SpeamboxInstallationGuide modelliert eine multi-step Installations-Anleitung für Speambox-Geraete. Pro Anleitung werden über /speambox-installation-guides/:id/steps Schritte gepflegt — jeder Schritt hat einen name und einen type (text, html, image, video), der bestimmt, wie der Inhalt für Techniker angezeigt wird.

Anleitungen werden über installationGuideId an SpeamboxSystemType gebunden — beim Anlegen einer neuen Speambox sieht der Techniker direkt die richtige Anleitung.

Voraussetzungen

- Berechtigung `view:SpeamboxInstallationGuide` und `create:SpeamboxInstallationGuide`. - Für Schritte: `view:SpeamboxInstallationGuideStep`/`create:SpeamboxInstallationGuideStep`.

Berechtigungen (CASL)

ActionSubjectWirkungKeycloak-Rolle
viewFE_SpeamboxInstallationGuide, SpeamboxInstallationGuideListe/Detail aufrufbar
create/update/deleteSpeamboxInstallationGuidePflegenAPP_SPEAMCORE_CREATE/UPDATE/DELETE_SPEAMBOX_INSTALLATION_GUIDE
view/create/update/deleteSpeamboxInstallationGuideStepSchritt-Sub-ListeAPP_SPEAMCORE_VIEW/CREATE/UPDATE/DELETE_SPEAMBOX_INSTALLATION_GUIDE_STEP

Schritt-für-Schritt-Anleitung

  1. Anleitungen (/speambox-installation-guides) → + Neu.
  2. Stammdaten pflegen (Name, Beschreibung).
  3. Sub-Route /speambox-installation-guides/:id/steps öffnen.
  4. Schritte anlegen — pro Schritt type wählen:
    • text — einfacher Text.
    • html — Rich-Text via HTML-Editor.
    • image — Bild-Upload.
    • video — Video-Verweis.
  5. Anleitung an SpeamboxSystemType über installationGuideId binden.

Listenansicht — speambox-installation-guides

Toolbar (Detail-Seite)

Schlanke Toolbar oben rechts:

IconAktion (aria-label)CASLWirkung
ZurückgehenZurück zur Liste.
🏠Zur Startseite gehenSpringt auf das Dashboard / /.
⏮/◀/▶/⏭PaginationNavigation durch die gefilterte Liste — Massen-Bearbeitung ohne Liste-Sprung.

Wie auf jeder Detail-Seite verfuegbar — siehe Floating-Quickbar:

  • KAL. (Mini-Kalender)
  • ZEIT (Persoenliche Wochen-Arbeitszeit)
  • ARBEIT (Eigene bevorstehende Aufträge)

Felder und Eingaben

Step-Felder

FeldnamePflichtDatentypWirkung beim AusfuellenVoraussetzung
nameneinStringSchritt-Name.
typejaENUM (text, html, image, video)Bestimmt das Inhalts-Render.

Wiederverwendbare Konzepte

Verknuepfungen zu anderen Modulen

API/Schnittstellen

MethodeEndpointZweckCASL
GET/api/speambox-installation-guidesListeview SpeamboxInstallationGuide
POST/api/speambox-installation-guidesAnlegencreate SpeamboxInstallationGuide
GET/api/speambox-installation-guides/:idDetailview SpeamboxInstallationGuide
PATCH/api/speambox-installation-guides/:idÄndernupdate SpeamboxInstallationGuide
DELETE/api/speambox-installation-guides/:idSoft-Deletedelete SpeamboxInstallationGuide
GET/api/speambox-installation-guide-steps?filter[guideId]Schritt-Sub-Listeview SpeamboxInstallationGuideStep

Versionshinweise

  • 2026-04-30: Initiale Veroeffentlichung.