Benutzer-Werkzeuge

Webseiten-Werkzeuge


admin:issues

Dies ist eine alte Version des Dokuments!


Issues

Das Issues System ermöglicht das Erfassen und Bearbeiten von im Rahmen der Arbeit mit FH Complete auftretenden Fehlern. Wichtig ist dabei die Unterscheidung zwischen

  • Fehler: Bestimmt die Art des Fehlers, legt fest, welcher Fehler mit welchen Eigenschaften auftreten kann. Tabelle system.tbl_fehler
  • Issue: Zu einem konkreten Zeitpunkt in einer konkreten Situation aufgetretener Fehler. Tabelle system.tbl_issue

Ein issue kann für eine Person oder eine Organisationseinheit auftreten.

Fehler Monitoring Übersicht

Zur Abarbeitung der Issues existiert eine Fehler Monitoring Übersicht. Hier werden die zuletzt aufgetretenen Issues aufgelistet. Wenn der Issue behoben wurde, kann dieser hier manuell auf „behoben“ gesetzt werden.

Ein Issue kann folgende Status haben:

  • Neu - unbearbeitet, neu aufgetreten
  • In Bearbeitung - Issue von einem Bearbeiter/einer Bearbeiterin zur Behebung vorgemerkt
  • Behoben - aufgetretener Issue ist beseitigt

Ein issue wird in der Übersicht angezeigt, wenn

  • der User für die Organisationseinheit des Issues berechtigt ist (Berechtigung system/issues_verwalten) ODER
  • über eine bestimmte Funktion (z.B. Assistenz) der Organisationseinheit des Issues zugewiesen ist ODER
  • über eine bestimmte Funktion (z.B. Assistenz) einem Studiengang zugewiesen ist, in dem die Person des Issues studiert ODER
  • der User oder die Organisationseinheit des Users eine spezielle Zuständigkeit (system.tbl_fehler_zuständigkeiten) für einen bestimmten Fehlercode zugewiesen hat.

Auf der linken Seite der Monitoring Übersicht sind vordefinierte Filter zu finden. So werden je nach Auswahl offene oder erledigte issues angezeigt.

Automatisierte Issues Behebung

Das Setzen eines Issues auf „Behoben“ kann entweder manuell in der Fehler Monitoring Oberfläche oder automatisiert durch einen Job erfolgen. Der Job wird folgendermaßen aufgerufen:

  • Für Issues im Core Teil von FH Complete: php index.ci.php/jobs/IssueResolver/run
  • Für in einer extension definierte Issues: php index.ci.php/extensions/FHC-Core-Extensionname/jobs/IssueResolver/run

Der Job arbeitet alle nicht behobenen Issues im Core oder in der Extension ab und prüft für den Fehlercode des Issues, ob der Issue noch besteht. Zur automatisierten Behebung muss pro Fehlercode definiert werden, wenn ein aufgetretener Issue für diesen Fehler als behoben gilt. Hierzu sind folgende Schritte notwendig:

  • Wenn noch nicht erfolgt: Festlegen des Fehlercodes sowie fehler_kurzbz, fehlertext, fehlertyp_kurzbz (z.B. error, warning). Dies erfolgt als SQL entweder im fehlerupdate.php File im Core oder in einer Extension.
  • Anlegen einer library im libraries/issues Ordner mit Definition der Prüfung zur Fehlerbehebung. Die library muss die Methode checkIfIssueIsResolved($params) implementieren. Diese muss ein success objekt mit „true“, wenn der Issue behoben ist, oder „false“, wenn nicht, oder ein error objekt wenn Fehler bei der Prüfung aufgetreten sind, zurückgeben. Die Methode akzeptiert einen $params Array, welcher zusätzliche, zur Behebung notwendige Parameter beinhaltet (z.B. prestudent_id, wenn der Fehler einen bestimmten Prestudent betrifft). Die Parameter müssen bei Auftreten des issues (in der jeweiligen Applikation) in die Issue Tabelle als JSON-Object (Spalte behebung_parameter) geschrieben werden. Gemäss Konvention sollte die library genauso wie der betreffende Fehlercode benannt werden. Im nachfolgenden Beispiel für eine Issue library wird geprüft, ob das ZGV Datum eines Studenten in der Zukunft liegt. Wenn nicht, gilt der Fehler als behoben und es wird success(true) retourniert. Dies hat zur Folge dass der IssueResolver Job den Fehler auf Status „behoben“ setzt. Das ZGV Datum ist pro Prestudent gespeichert, daher muss als Parameter die prestudent_id übergeben werden. Dieser Parameter muss beim Schreiben des Issues mitgespeichert werden.

  • Setzen der Zuordnung des Fehlers zur library im IssueResolver. Damit der IssueResolver erkennt, dass eine library für die automatische Überprüfung des Issuestatus existiert, muss im File IssueResolver.php das codeLibMappings Array ergänzt werden. Der Eintrag hat die Form 'Fehlercode' ⇒ 'Library Name' und weist die library Klasse einem bestimmten Fehlercode zu.

Nun wird bei Aufruf des IssueResolver Jobs für jeden noch nicht behobenen Issue geprüft, ob der Issue noch besteht, und der Status des Issues wird entsprechend angepasst.

Fehler Zuständigkeiten

Für die Prüfung und Behebung bestimmter Fehler können einzelne Mitarbeiter bzw. Abteilungen zuständig sein. Hierzu besteht die Möglichkeit, einzelne Fehlercodes einer Person bzw. Organisationseinheit zuzuteilen. In der Fehler Monitoring Übersicht gibt es dazu das Feld „Hauptzuständig“. Dieses hat der Wert „Nein“ wenn eine Zuständigkeit für einen anderen User als den eingeloggten definiert wurde. Zur Verwaltung der Zuständigkeiten existiert eine grafische Benutzeroberfläche.

/var/www/wiki/data/attic/admin/issues.1649086931.txt.gz · Zuletzt geändert: 2022/04/04 17:42 von karpenko