Modul Generator: Eigene Module mit Zusatzmodul Generator erstellen

Dieser Artikel führt dich durch die Erstellung und Konfiguration eines Moduls am Beispiel „Reklamationsprozess". Weitere Inspirationen und Best Practices findest du auf unserer Webseite: Q.wiki Module (extern).

Erstellen eines eigenen Moduls

Leere Konfiguration anlegen

Eine leere Konfiguration enthält zunächst keine Konfigurationsparameter. Folge diesen Schritten:

1. Öffne Modul Verwaltung im Werkzeugmenü
2. Klicke auf Neue Konfiguration
3. Wähle Leere Konfiguration und klicke Modul anlegen
4. Klicke auf der sich öffnenden Seite auf Konfiguration beginnen

Felder zum Erfassen von Daten anlegen

Mit Datenfeldern konfigurierst du die Inhalte, die das Modul später abbilden soll.

• Im Reiter Daten und Ansichten legst du einen Ersten Inhalts-Block an
• Im sich öffnenden Dialog stehen dir folgende Bausteine zur Verfügung:
  • Daten-Felder 1 / 2 / 3-spaltig: Felder für Kerninformationen in ein-, zwei- oder dreispaltiger Anordnung. Hier konfigurierst du:
    • Den Abschnitts-Name – die Überschrift unter der weitere Felder hinzugefügt werden
    • Zusätzliche Felder mit Name und Typ
  • Großes Freitext-Feld: Für längere Beschreibungen; kann einmal pro Modul angelegt werden
  • Aufgabenverwaltung: Zum Anlegen von Aufgaben zum Vorgang
  • Anhänge: Zum Hochladen von Dateianhängen
  • Verknüpfungen mit Prozessen und Modulen: Zum Verknüpfen von Prozessen und Modulen aus Q.wiki

Workflow konfigurieren

Im Workflow definierst du den Ablauf eines Vorgangs: welche Status es gibt und welche Handlungsschritte zwischen den Status möglich sind.

• Im Reiter Workflow legst du Status mit + Status hinzufügen an
• In jedem Status fügst du Transitionen mit + Transition hinzufügen ein:
  • Eine Transition verbindet zwei Status miteinander und beschreibt die Handlung zwischen ihnen
  • Ein Status kann mehrere Transitionen haben, die in verschiedene Status führen
• Im Transitions-Dialog konfigurierst du:
  • Den Zielstatus
  • Bei Name eine aussagekräftige Bezeichnung für die Handlung
  • Berechtigte Nutzergruppen und Benachrichtigungsgruppen (diese können eingetragen werden, nachdem du Rollen angelegt hast – siehe Rollen definieren)
  • Klicke Transition hinzufügen, um die Parameter zu übernehmen
  • Die Grafik auf der rechten Seite wird aktualisiert

Übersicht konfigurieren

Im Reiter Übersicht stellst du die Erstansicht des Moduls ein.

• Im Bereich Basis nimmst du Grundeinstellungen vor:
  • Name der Übersichtseite – wird im Hauptfenster als Seitenname angezeigt
  • Modul Name – die Bezeichnung in der linken Navigationsleiste
  • Buttontext – wird auf dem Button angezeigt, mit dem neue Vorgänge angelegt werden
  • Zusammensetzung des Titels eines Modul Inhalts – beschreibt den Anzeigenamen eines angelegten Vorgangs
• Im Bereich Reiter fügst du Reiter zur Erstansicht hinzu. Du kannst diese benennen und ihre Sichtbarkeit einschränken
• Im Bereich Tabelle definierst du die Darstellung der Tabellen in den Reitern:
  • Die Struktur bleibt in allen Reitern gleich
  • Mit + Neue Spalte legst du Spalten an, die auf den Feldern aus Daten und Ansichten basieren
• Im Bereich Filter legst du Filter für die Inhalte an – empfohlen bei Modulen mit vielen Vorgängen

Rollen definieren

Durch das Hinzufügen von Rollen legst du fest, welcher Nutzer welche Transitionen durchführen und welche Status bearbeiten darf.

• Im Bereich Rollen fügst du Rollen hinzu und hinterlegst darin Nutzer oder Gruppen:
  • Nur diese Nutzer haben Zugriff auf die ihnen zugewiesene Aktion (siehe Workflow)
  • Nach der Definition kannst du diese Rollen im Workflow eintragen

Konfiguration testen und Modul anlegen

Nach den erforderlichen Konfigurationen kannst du das Modul durch das Anlegen von Vorgängen, das Durchlaufen der Workflows und das Überprüfen der Ansichten testen.

• Speichere das Modul über den kleinen Pfeil neben Konfiguration testen
• Eine Überarbeitung des Moduls erfolgt über die Modul Verwaltung
• Mit Konfiguration testen > Konfiguration überprüfen wird der Workflow und andere Parameter des Moduls geprüft. Du erhältst Hinweise, wenn eine Konfiguration fragwürdig oder fehlerhaft ist
• Mit Konfiguration testen > Fortfahren öffnet sich ein neuer Browser-Tab, in dem das Modul gestartet wird:
  • Hier führst du vollständige Funktionstests des Moduls durch
  • Alle eingegebenen Inhalte gehen nach dem Schließen des Tabs verloren
• Mit dem Pfeil neben Konfiguration testen > Modul anlegen wird das Modul endgültig angelegt