| author | title | revision | lang | cssextra | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
|
de |
assets/doc1.css |
Das Absolventenfeiersystem kurz AFS nutzt eine Server-Client-Architektur. Bei dem Client handelt es sich um ein Thin-Client, da das Rendering der Darstellungen auf dem Server durchgeführt wird. Da es sich um eine Webapplikation handelt, ist der genutze Client ein Webbrowser. Über diesen werden die Nutzerinteraktionen an den Server gesendet. Die Peristierung wird von einer Persistierungsschnitstelle im Zusammenspiel mit mongoDB durchgeführt. Die Absolventendaten werden über einen Adapter von Prüfungsamt bezogen.
![[1] Übersicht UML-Komponenten-Diagramm für Absolventenfeiersystem](/firelort/HSNR-5-SWE-P-2/blob/master/images/uml/%C3%BCbersicht-komponenten.png "Übersicht über die Komponenten")
Die Benutzungsschnittstelle greift auf Funktionen der Applikationslogik zu um Daten an die Applikation zu senden. Desweitern erfolgt das Rendern der HTML-Seite auf dem Server, sodass der Client/Web-Browser auch auf diese Funktionalität zugreift.
Die Applikationslogik wiederrum, benötigt für das Speichern sowie für das Abrufen von Informationen/Daten die Persistenzschicht. Die Persistenzsicht dient als Mediator zwischen Applikationslogik und Datenbank (MongoDB).
![[2] Applikationslogik UML-Komponenten-Diagramm für Absolventenfeiersystem](/firelort/HSNR-5-SWE-P-2/blob/master/images/uml/app-komponenten.png "Übersicht über die Applikationslogik")
Die Applikationslogik ist im oberen Bild verfeinert, da diese in der Übersicht nur grob eingezeicht ist. Die vier verschiedenen Komponenten bieten verschiedene Export- und Import-Schittstellen an, welche im folgenden genauer erklärt werden.
Der Webbrowser wird genutzt, damit die Nutzer die Applikation verwenden können. Der Browser muss HTML und CSS anzeigen können. Je nach Use-Case und Benutzerrolle werden verschiedene HTML-Seiten angezeigt, welche von der Applikation gerendert worden sind. Der Webbrowser muss Formulardaten an den Server senden können.
Diese Komponente ermöglicht die Registierung und Anmeldung am AFS, um so Absolventen und Mitarbeitern des Prüfungsausschuss die Möglichkeit zu geben, Daten innerhalb der Anwendung zu verwalten und zu ändern.
Die Komponente Registierung / Login bietet die folgenden Exportschnittstellen an:
- Registierung am AFS
- Login am AFS
- Passwort setzen
Registierung am AFS bietet einem Mitarbeiter des Fachbreiches(Prüfungsausschus) die Möglichkeit Zugangsdaten am AFS zu hinterlegen, um so im Zugriff auf das Backend des AFS zu erhalten. Dies Funktion darf nur von Berechtigten, also Mitgliedern des Prüfungsauschuss genutzt werden.
Datenstruktur:
new_login ::= #email + passwort;
email ::= string;
passwort ::= string;
Der Login am AFS ermöglicht den Absolventen und den Mitarbeitern des Prüfungsausschusses sich am AFS an zu melden, um so Funktionen der Rolle wahr zunehmen.
Datenstruktur:
login ::= #email + passwort;
email ::= string;
passwort ::= string;
Absolventen ohne Nutzeraccount müssen vor Nutzung des AFS ein Passwort festlegen, damit diese Möglich ist, exportiert die Registierung/Login Komponente die Möglichkeit ein Passwort zu vergeben. Nach dem ein Passwort vergeben worden ist, kann der Absolvent das AFS nutzen.
Datenstruktur:
new_login ::= #email + passwort;
email ::= string;
passwort ::= string;
Das Festschreiben der Nutzerdaten wird aus der Peristenzsicht importiert, um das Abspeichern von Daten zu ermöglichen. Die Daten umfassen die Nutzereingaben, welche durch die Export-Schnittstellen an die Komponente gesandet werden können. Die Aktionen auf der Datenbank ist entweder eine Abfrage oder ein Einfügen.
Datenstruktur:
login ::= #email + passwort;
email ::= string;
passwort ::= string;
Diese Komponente ermöglicht den Benutzern eine Anmeldung für die Absolventenfeier auszusprechen. Desweitern ermöglicht die Komponente Absolventen die Anzahl der Begleitpersonen sowie ihre Zusage zu ändern.
Die Komponente Teilnahmebekundung bietet die folgenden Exportschnittstellen an:
- Teilnahmebekunden
- Status ändern
- Anzahl Begleitpersonen ändern
Diese Export-Schnittstelle bitet den Mitarbeitern des Fachbereichs die Möglichekeit ihr kommen zur Absolventenfeier anzumelden.
Datenstruktur:
login ::= #email + name + vorname;
email ::= string;
name ::= string;
vorname ::= string;
Durch diese Export-Schnittstelle, ist es dem Absolventen möglich, sein kommen anzumelden bzw. zu wiederrufen.
Datenstruktur:
login ::= #email + name + teilnahmestatus;
teilnahmestatus ::= boolean;
Diese Export-Schnittstelle ermöglicht es den Absolventen, die Anzahl an Begleitpersonen, welche diesen zur Absolventefeier begleiten zu ändern.
Datenstruktur:
login ::= #email + name + anzahl;
anzahl ::= number;
Das Festschreiben der Daten wird aus der Peristenzsicht importiert, um das Abspeichern von Daten zu ermöglichen. Die Daten umfassen die Nutzereingaben, welche durch die Export-Schnittstellen an die Komponente gesandet werden können. Die Aktionen auf der Datenbank ist entweder ein Einfügen oder ein Update auf bestehende Datenbestände.
Datenstruktur:
teilnahmebekunden ::= #email + name + vorname;
status_ändern ::= #email + teilnahmestatus;
anzahl_begleitpersonen ::= #email + anzahl;
email ::= string;
name ::= string;
vorname ::= string;
teilnahmestatus ::= boolean;
anzahl ::= number;
Die Komponente Absolventenfeierverwaltung ermöglicht es eine Absolventenfeier anzulegen bzw. diese zu bearbeiten.
Durch diese Exportschittstelle haben die Mitglieder des Prüfungsausschusses die Möglichkeit eine Absolventenfeier im AFS zu hinterlegen. Sollte bereits eine andere Feier angelegt sein, wird diese überschrieben.
Datenstruktur:
neue_feier ::= name + #datum + uhrzeit + ort;
name ::= string;
datum ::= date;
uhrzeit ::= time;
ort ::= string;
Durch die Exportschnittstelle "Bearbeiten" hat der Prüfungssausschuss die Möglichkeit die Daten der Absolventenfeier im AFS zu ändern.
Datenstruktur:
feier ::= name + #datum + uhrzeit + ort;
name ::= string;
datum ::= date;
uhrzeit ::= time;
ort ::= string;
Die Import-Schnittstelle ermöglicht, das eine Erstellung einer Absolventenfeier sowie die Änderungen an einer Absolventenfeier in die Datenbank geschrieben werden und somit persistent sind.
Datenstruktur:
feier ::= name + #datum + uhrzeit + ort;
name ::= string;
datum ::= date;
uhrzeit ::= time;
ort ::= string;
Diese Komponete umfasst ein server seitiges rendern der Ansicht, sowie eine Auslieferung an den Client.
Die Export-Schnittstelle liefert dem Browser/Client eine gerenderte HTML-Seite mit Informationen aus der Datenbank, sofern diese benötigt werden.
Datenstruktur: Auslieferung einer HTML/CSS-Seite
Die Import-Schnittstelle wird benötigt, damit HTML-Seiten mit unter anderem Datenbank inhalt gerendert werden können.
Datenstruktur: Abhängig von der angeforderten Seite
Die Persistenzsicht hat die folgenden Aufgaben: Sie kümmert sich um das Transofmieren der Daten in eines für die Datenbank nutzbares Format. Desweitern ermöglicht diese, SQL Abfragen auf vorhandene Daten. Neben diesem stellt die Persitenźsicht auch eine Möglichtkeit bereit mit Hilfe eines Adapters auf die benötigten Daten des Prüfungsamtes zuzugreifen
Der Query-Manager ermöglicht es SQL Datenbank abfragen auszuführen.
Der Object-Pool verwaltet die Objekte welche in der Datenbank vorhanden sind bzw. welche in die Datenbank geschrieben werden sollen.
Diese Komponente wandelt die von der Applikation übergebenden Objekte in das JSON Format aus.
Der Adapter ermöglicht es die umgewandelten Daten in der MongoDB Datenbank abzuspeichern.
Die Datenbank erhält von der Persistenzsicht Daten, welche abgespeichert werden sollen. Desweitern gibt die Datenbank Daten auf Anforderung Daten an die Persistenzsicht.
Diese Komponente stellt einen Adapter für die benötigten Daten des Prüfungsamtes dar, sodass nur benötigte Daten an die Persistenzschicht weiter gegeben werden.
In den folgenen Frames steht "Benutzername" als Platzhalter für den für den Namen des angemeldeten Nutzers, "Absolventenfeier" steht für den Namen der aktuellen Feier. LOGO/TITLE im AFS werden durch das Logo bzw einen stellvertretenden Text ersetzt.
![[3] Login-Maske für alle Benutzer/Teilnehmer](/firelort/HSNR-5-SWE-P-2/blob/master/images/wireframes/login_step_1.png "Login-Maske")
Diese Maske wird als globaler Login genutzt, jenachdem welche Email-Adresse eingegeben wird, wird die nächste Eingabe Maske angezeigt. Dort wird unterschieden zwischen Mitarbeiter und Absolventen.
![[4] Maske zum Setzen eines Passwortes für Absolventen](/firelort/HSNR-5-SWE-P-2/blob/master/images/wireframes/login_step_2_password_not_set_student.png "Passwort-Maske")
Wenn der Absolvent noch kein Password für seine Email gesetzt hat, muss er das in dieser Maske tun.
![[5] Maske zur Eingabe des Passwortes für Absolventen](/firelort/HSNR-5-SWE-P-2/blob/master/images/wireframes/login_step_2_password_already_set_student.png "Passwort-Maske")
Wenn ein Passwort für den Absolventen hinterlegt ist, kann dieser sich damit in dieser Maske anzumelden.
![[6] Maske zur Bekundung der Teilnahme für Absolventen](/firelort/HSNR-5-SWE-P-2/blob/master/images/wireframes/participate_not_participating.png "Maske zur Teilnahmebekundung - Absolventen")
Nach dem erfolgreichen Login besteht die Möglichkeit die Teilnahme an der Absolventenfeier zu bekunden und die Anzahl der Begleitpersonen anzugeben.
![[7] Maske zur Stornierung der Teilnahme für Absolventen und Änderungen der Anzahl der Begleitpersonen](/firelort/HSNR-5-SWE-P-2/blob/master/images/wireframes/participate_participating.png "Maske zur Teilnahmebekundung - Absolventen")
Nach Bekundung der Teilnahme steht Absolventen nach dem Login die Möglichkeit zur Verfügung die Anzahl der Begleitpersonen zu ändern oder die Teilnahme zu stornieren.
![[8] Maske zur Bekundung der Teilnahme für Mitarbeiter, sowie Registrierung für Mitarbeiter am AFS](/firelort/HSNR-5-SWE-P-2/blob/master/images/wireframes/login_step_2_account_not_set_not_participating_worker.png "Maske zur Teilnahmebekundung/Registrierung am AFS - Mitarbeiter")
Wenn ein Mitarbeiter sich weder am AFS angemeldet hat, noch seine Teilnahme zur Absolventenfeier bekundet hat kann er diese Vorgänge in dieser Maske vollenden.
![[9] Status zur Teilnahme, sowie Registrierung für Mitarbeiter am AFS](/firelort/HSNR-5-SWE-P-2/blob/master/images/wireframes/login_step_2_account_not_set_participating_worker.png "Maske zur Teilnahmebekundung/Registrierung am AFS - Mitarbeiter")
Falls noch kein AFS-Account besteht aber die Teilnahme bereits bekundet wurde, wird die Maske zur Bekundung durch einen Statustext ersetzt.
![[10] Maske zur Bekundung der Teilnahme für Mitarbeiter und Login zum AFS](/firelort/HSNR-5-SWE-P-2/blob/master/images/wireframes/login_step_2_account_set_not_participating_worker.png "Maske zur Teilnahmebekundung sowie Login - Mitarbeiter")
Besteht bereits ein Account, wird die Registrierung mit einem Login getauscht, bei Nicht-Teilnahme wird zusätzlich die Maske zur Teilnahmebekundung angezeigt.
![[11] Status zur Teilnahme, sowie Login zum AFS](/firelort/HSNR-5-SWE-P-2/blob/master/images/wireframes/login_step_2_account_set_participating_worker.png "Status zur Teilnahmebekundung sowie Login - Mitarbeiter")
Bei bestehen Account und bekundeter Teilnahme wird die Loginmaske angezeigt und der Status der Teilnahme.
![[12] Template für das AFS](/firelort/HSNR-5-SWE-P-2/blob/master/images/wireframes/dashboard/template.png "Template AFS")
Dieses Template wird für jede Unterseite des AFS benutzt, welche sich im passwortgeschützten Bereich befindet. Ein Klick auf den Benutzernamen öffnet ein Untermenü, das die Option zur Abmeldung beinhaltet.
![[13] Maske zur Erstellung/Änderungen der Absolventenfeier](/firelort/HSNR-5-SWE-P-2/blob/master/images/wireframes/dashboard/gc_createedit.png "Maske der Absolventenfeier")
Die Maske zur Bearbeitung und Erstellung einer neuen Absolventenfeier ist identisch bisauf die Begriffe "anlegen" und "bearbeiten" werden entsprechend getauscht. Falls eine Absolventenfeier bearbeitet wird sind die Felder vorbelegt mit den vorhandenen Daten.
![[14] Tabelle zur Betrachtung der Mitglieder des Prüfungsausschusses mit der Option der Löschung](/firelort/HSNR-5-SWE-P-2/blob/master/images/wireframes/dashboard/user.png "Tabelle der Benutzer")
Eine Übersicht der registrierten Benutzer des AFS, diese Mitglieder können gelöscht werden bei Bedarf.
![[15] Tabelle zur Betrachtung der Abschlussarbeiten, sortierbar](/firelort/HSNR-5-SWE-P-2/blob/master/images/wireframes/dashboard/thesis_.png "Tabelle der Abschlussarbeiten")
Übersicht der Abschlussarbeiten, die Kombobox ermöglicht den Wechsel der Sortierung.
![[16] Tabelle zur Betrachtung der Teilneher - Absolventen](/firelort/HSNR-5-SWE-P-2/blob/master/images/wireframes/dashboard/participants_students.png "Tabelle der Teilnehmer - Absolventen")
Übersicht der angemeldeten Absolventen.
![[17] Tabelle zur Betrachtung der Teilneher - Mitarbeiter](/firelort/HSNR-5-SWE-P-2/blob/master/images/wireframes/dashboard/participants_worker.png "Tabelle der Teilnehmer - Mitarbeiter")
Übersicht der angemelden Mitarbeiter.
![[18] Übersicht UML-Zustandsdiagramm-Diagramm für Absolventenfeiersystem](/firelort/HSNR-5-SWE-P-2/blob/master/images/uml/%C3%BCbersicht-state.png "Übersicht Zustandsdiagramm")
![[19] ASF UML-Zustandsdiagramm-Diagramm für Absolventenfeiersystem](/firelort/HSNR-5-SWE-P-2/blob/master/images/uml/app-state.png "ASF-Zustandsdiagramm")
![[20] ASF-Backend UML-Zustandsdiagramm-Diagramm für Absolventenfeiersystem](/firelort/HSNR-5-SWE-P-2/blob/master/images/uml/asf-state.png "ASF-Backend-Zustandsdiagramm")
![[21] Klassendiagramm](/firelort/HSNR-5-SWE-P-2/blob/master/images/uml/uml-classes-v2.png "Klassendiagramm")
:(feier): Zusammenstellung Attribute
+----------+--------+------------------------------------------------------------+ | Attribut | Typ | Beschreibung | +==========+========+============================================================+ | name | string | Der Name der Absolventenfeier | +----------+--------+------------------------------------------------------------+ | datum | date | Das Datum der Absolventenfeier | +----------+--------+------------------------------------------------------------+ | uhrzeit | time | Die Uhrzeit der Absolventenfeier | +----------+--------+------------------------------------------------------------+ | ort | string | Der Standort der Absolventenfeier | +----------+--------+------------------------------------------------------------+
:(absolventen_in): Zusammenstellung Attribute
+---------------------+---------+------------------------------------------------------------+ | Attribut | Typ | Beschreibung | +=====================+=========+============================================================+ | absolventen_ex | number | ID des externen Datensatzes, der zu diesen | | | | Zusatzinformationen gehört | +---------------------+---------+------------------------------------------------------------+ | passwort | string | Passwort zur Anmeldung im ASF - Leerstring, wenn noch | | | | nicht erstellt | +---------------------+---------+------------------------------------------------------------+ | teilnahmestatus | boolean | Teilnahmestatus, ob Teilnahme bestätigt | +---------------------+---------+------------------------------------------------------------+ | anzahlBegleitperson | number | Anzahl der Begleitpersonen des Absolventen | +---------------------+---------+------------------------------------------------------------+
:(mitarbeiter): Zusammenstellung Attribute
+----------+--------+------------------------------------------------------------+ | Attribut | Typ | Beschreibung | +==========+========+============================================================+ | name | string | Nachname des Mitarbeiters | +----------+--------+------------------------------------------------------------+ | vorname | string | Vorname des Mitarbeiters | +----------+--------+------------------------------------------------------------+ | email | string | E-Mail des Mitarbeiters | +----------+--------+------------------------------------------------------------+
:(zugangsdaten): Zusammenstellung Attribute
+----------+--------+------------------------------------------------------------+ | Attribut | Typ | Beschreibung | +==========+========+============================================================+ | name | string | Nachname des Prüfungsausschussmitglieds | +----------+--------+------------------------------------------------------------+ | vorname | string | Vorname des Prüfungsausschussmitglieds | +----------+--------+------------------------------------------------------------+ | email | string | E-Mail des Prüfungsausschussmitglieds | +----------+--------+------------------------------------------------------------+ | passwort | string | Passwort des Prüfungsausschussmitglieds | +----------+--------+------------------------------------------------------------+
:(absolventen_ex): Zusammenstellung Attribute
+--------------+--------+------------------------------------------------------------+ | Attribut | Typ | Beschreibung | +==============+========+============================================================+ | name | string | Nachname des Absolventen | +--------------+--------+------------------------------------------------------------+ | vorname | string | Vorname des Absolventen | +--------------+--------+------------------------------------------------------------+ | email | string | E-Mail des Absolventen | +--------------+--------+------------------------------------------------------------+ | arbeitstitel | string | Titel der Abschlussarbeit | +--------------+--------+------------------------------------------------------------+ | arbeitstyp | string | Passwort des Prüfungsausschussmitglieds | +--------------+--------+------------------------------------------------------------+ | pruefer1 | string | Name des ersten Prüfers | +--------------+--------+------------------------------------------------------------+ | pruefer2 | string | Name des zweiten Prüfers | +--------------+--------+------------------------------------------------------------+
MongoDB speichert die Daten in JSON ab. Die Object2JSON Komponente wandelt die vorhanden Instanzen in JSON um oder die JSON zurück in Instanzen der Objekte. Die Referenzen werden erneut gesetzt.
Die Felder in JSON besitzen die identsichen Namen wie die Klassen, Beispiel für ein Objekt in JSON:
{
"name": "Mueller",
"vorname": "Marius",
"email": "marius@mueller.de",
"arbeitstitel": "Thema 1",
"arbeitstyp": "Bachelor",
"pruefer1": "Prof A",
"pruefer2": "Prof C"
}
Die Applikationslogik verwednet das Entwurfsmuster Singelton um nur genau einen Pool an Verbindungen zur Datenbank herzustellen.
Da die Applikationslogik Daten benötigt, welche nur in einer Datenbank des Prüfungsamtes vorhanden sind, wird hier ein Adapter benutzt. Dieser Adapter stellt die externen Daten im benötigten Format (der benötigten Klasse) bereit.