Um die Funktionsweise des Modul Generators kennenzulernen, wird in diesem Artikel auf die Erstellung und Konfiguration an dem Beispiel einer Reklamation Modul eingegangen. Für Informationen zur Einrichtung vor konfigurierter Modul, hier der Link zur Website: Hilfestellung und Buchungsoptionen für den Modul Generator

Erstellen eines eigenen Moduls

Anlegen einer leeren Konfiguration

Beim Anlegen einer leeren Konfiguration enthält diese zunächst keine Konfigurationsparameter. 

1. Modul Verwaltung im Werkzeugmenü öffnen
2. Neue Konfiguration anklicken
3. Leere Konfiguration auswählen und Modul anlegen
   
4. Auf der sich öffnenden Seite Konfiguration beginnen anklicken

Felder zum Erfassen von Daten anlegen

Mit dem Anlegen von Datenfeldern werden Inhalte konfiguriert, die das Modul später abbilden soll.

• Im Reiter Daten und Ansichten einen Ersten Inhalts-Block anlegen
• Im rechts erscheinenden Dialog stehen folgende Bausteine zur Verfügung:
  • Daten-Felder 1 / 2 / 3-spaltig: Feld für Kerninformationen zum jeweiligen Vorgang in einem ein-, zwei- oder dreispaltigen Design; Konfigurierbar sind
    • der Abschnitts-Name ist die Überschrift, unter der diesem Block weiteren Felder hinzugefügt werden.
    • zusätzliche Felder, für die ein Name und einen Typ definiert wird
  • Großes Freitext-Feld: Feld für eine längere Beschreibung; kann einmal pro Modul angelegt werden.
  • Aufgabenverwaltung: Anlegen von Aufgaben zum Vorgang
  • Anhänge: Hochladen von Dateianhängen
  • Verknüpfungen mit Prozessen und Modulen: Verknüpfen von Prozessen und Modulen aus dem Q.wiki
    

Workflow konfigurieren

Im Workflow wird der Ablauf eines Vorgangs konfiguriert. Es werden nötige Status und Handlungsschritte für den Übergang zwischen zwei Status definiert.

• Im Reiter Workflow werden Status mit + Status hinzufügen angelegt
• In einem Status wird eine Transition mit + Transition hinzufügen angelegt
  • Die Transition verbindet zwei Status miteinander und beschreibt die Handlung zwischen diesen
  • Ein Status kann mehrere Transitionen besitzen, die in verschiedene Status münden
• Im geöffneten Dialog wird 
  • der Zielstatus ausgewählt
  • bei Name eine aussagekräftige Bezeichnung vergeben, die eine Handlung beschreibt
  • Berechtigte Nutzergruppen und für die Transition und Benachrichtigungsgruppen eingetragen
    • Diese können eingetragen werden, nachdem die Rollen dazu angelegt wurden (siehe Rollen).
  • Der Button Transition hinzufügen übernimmt die eingetragenen Parameter
  • Die Grafik rechts wird mit der hinzugefügten Transition aktualisiert

Übersicht konfigurieren

Mit der Konfiguration im Reiter Übersicht lässt sich die Erstansicht des Moduls einstellen.

• Im Bereich Basis werden die Grundeinstellungen vorgenommen, z.B.
  • Name der Übersichtseite wird im Hauptfenster als Seitenname angezeigt
  • Modul Name ist die Bezeichnung in der linken Navigationsleiste
  • Buttontext wird im Button angezeigt, mit dem ein neuer Vorgang in dem Modul anlegt wird
  • Zusammensetzung des Titels eines Modul Inhalts beschreibt den Anzeigenamen eines angelegten Vorgangs
• Im Bereich Reiter werden Reiter zur Erstansicht hinzugefügt.
  • Diese Reiter können benahmt und der Inhalt bzw. deren Sichtbarkeit eingeschränkt werden.
• Im Bereich Tabelle wird die Darstellung der in den Reitern enthaltenen Tabellen definiert
  • Die Struktur bleibt in den Reitern gleich.
  • Es lassen sich Spalten mit + Neue Spalte anlegen. Diese Spalten gründen sich, bis auf Ausnahmen, auf die Felder aus Daten und Ansichten.
• Im Bereich Filter werden Filter für die Inhalte angelegt. Empfohlen bei Modulen mit vielen Vorgängen.

Rollen definieren

Durch Hinzufügen von Rollen wird festgelegt, welcher Nutzer welche Transitionen durchführen und welche Status bearbeiten darf.

• Im Bereich Rollen werden Rollen hinzugefügt, in denen wiederum Nutzer oder Gruppen hinterlegt werden
  • Nur diese Nutzer haben Zugriff auf die Ihnen zugewiesene Aktion (siehe Workflow).
  • Diese Rollen können nach der Definition in den Workflow eingetragen werden.

Konfiguration testen und Module anlegen

Nach den erforderlichen Konfigurationen kann das Modul durch Anlegen von Vorgängen, Durchlaufen der Workflows und prüfen der Ansichten getestet werden.

• Das Modul über den kleinen Pfeil neben Konfiguration testen speichern.
• Eine Überarbeitung des Moduls erfolgt über die Modul Verwaltung.
• Mit Konfiguration testen > Konfiguration überprüfen wird der angelegte Workflow und andere Parameter des Moduls geprüft und angemerkt, wenn eine Konfiguration fragwürdig oder fehlerhaft ist.
• Mit Konfiguration testen > Fortfahren wird ein neuer Browertab geöffnet, in dem das Modul gestartet wird.
  • Hier können die vollständigen Funktionsprüfungen des Moduls durchgeführt werden.
  • Die hier eingefügten Inhalte gehen nach Schließen des Tabs verloren.

Mit Klick auf den kleinen Pfeil neben Konfiguration testen und Modul anlegen, wird das Modul angelegt.