# Pflichtenheft

## Inhalt
1. Zielbestimmung
    1. Musskriterien
    1. Abgrenzungskriterien
1. Produkteinsatz
    1. Anwendungsbereiche
    1. Zielgruppen
    1. Betriebsbedingungen
1. Produktumgebung
    1. Software
    1. Hardware
1. Produktfunktionen
    1. Dozentenfunktionen
        1. Login
        2. Wochenübersicht
        3. Kursdetails
    2. Verwaltungsfunktionen 
        1. Login
        2. Kurse erstellen
        3. Mitglied zu Gruppenkurs hinzufügen
        4. Kursübersicht
        5. Schülerübersicht
        6. Schüler eines Lehrers
        7. Raumübersicht m. Raumplan
        8. Offene Anträge 
        9. Finanzübersichrt


## Zielbestimmung

Das Ziel von Parsec Iron Puffin (*PIP*) ist es, eine Anwendung zu bieten welche die Organisation der Musikschule erlaubt. Hierzu werden für Dozenten und Verwaltung verschiedene administrative Funktionen bereitgestellt. Die aktuellen Betriebsprozesse sollen vereinfacht und beschleunigt werden.

### Musskriterien
  * Es besteht ein Authentifizierung um den Zugriff auf alle Funktionen auf die jeweils berechtigten Personen zu beschränken.
  * Der Dozent
    * Kann seine Stunden in der kommenden Woche sehen können.
    * Kann den Inhalt seiner Kurs für jede Unterrichtseinheit (*UE*) pflegen.
    * Kann die Schüler eines Kurses sehen.
  * Die Verwaltung
    * Kann sehen, welcher Lehrer welchen Kurs leitet.
    * Kann sehen, welcher Schüler an welchem Kurs teilnimmt.
    * Kann sehen, welche Schüler von einem gegebenen Lehrer unterrichtet werden.
    * Kann Räume anlegen.
    * Kann bearbeiten, welche Instrumente in einem Raum zu verfügung stehen.
    * Kann die aktuelle Verfügbarkeit und die nächsten Termine eines Raumes sehen.
    * Kann offene Anträge sehen.
    * Kann aus eingehenden Anträgen neue Kurs erstellen und UE planen.
    * Kann in einer Übersicht die Einnahmen der Musikschule und den Betrag, welcher an jeden Dozent gezahlt wird sehen.
  * Der Administrative Nutzer
    * Konfiguriert die Betriebsparameter des Systems
    * Sichert die Datenbank
  * Ein Kurs hat
    * einen Dozenten
    * einen Typ (Einzel-, Bandunterricht, Früherziehung)
    * einen Raum
    * ein oder zwei Zeitpunkte
    * und eine Laufzeit
  * Sonstiges
    * Deutsch ist Verkehrssprache
    * Alle Funktionen sind über das Internet erreichbar
    * Die Anwendung ist für Mobilgeräte  optimiert
  
### Wunschkriterien
  * Der Administrative Nutzer
    * Möchte bei der Erstellung eines Kurses durch einen Vorschlag zu passendem Raum, Dozenten und Zeitpunkt unterstützt werden.
  * Der Schüler
    * Möchte sich einloggen können um die eigenen Unterrichtszeiten und Inhalte einzusehen
  * Sonstiges
    * Daten sollen soweit sinnvoll möglich auf dem Endgerät zwischengespeichert werden, damit auch ohne Internetverbindung Grundlegende funktionalität geleistet werden kann.

### Abgrenzungungskriterien
  * Das *PIP* 
    * soll keine Abrechnung erstellen oder verschicken.

### Produkteinsatz 

#### Anwendungsbereiche 
Die Anwendung wird von den Dozenten und der Verwaltung zur Planung und Organisation der Musikschule genutzt.

#### Zielgruppe
Die Zielgruppe besteht aus der Verwaltung und allen aktuellen und zukünftigen Dozenten der Musikschule. Eventeuell wird die Zielgruppe um die Schüler der Musikschule erweitert.

#### Betriebsbedingungen 
  * Betriebsdauer: täglich, 24 Stunden
  * Die Anwendung und ihre Teile werden auf einem virtuellen privaten Server bei einem externen Anbieter bereitgestellt
  * Die Anwendung ist global über das Internet erreichbar
  * Der Betrieb wird vom Auftragnehmer überwacht

### Produktumgebung
#### Software
  * Client
    * Chrome oder Chromium basierter Browser der Version 74
  * Server
    * Docker unter Linux (Version 18.09.5)
#### Hardware
  * Client
    * Internetfähiges Endgerät
  * Server
    * Internetfähiger Server
    * Ausreichende Rechen- und Festplattenkapazität

### Produktfunktionen

#### Dozentenfunktionen
#### Login **/F01/**
  * Der Nutzer kann sich mit Benutzername und Passwort anmelden.
  * Benutzername und Passwort werden bei der Erstellung des Dozenten von der Verwaltung vergeben.
#### Wochenübersicht **/FD01/**
  * Der Nutzer sieht eine Übersicht mit von Ihm gegebenen Kursen in den kommenden 7 Tagen, gruppiert nach Wochentag
  * Mit einem Klick auf einen Kurs gelangt man zu den entsprechenden Kursdetails
#### Kursdetails **/FD02/**
  * Der Nutzer sieht Details zu einem Kurs
  * Er sieht alle Schüler, welche an dem Kurs teilnehmen
  * Er sieht die Einträge zu den den Unterrichtsinhalten der vergangen Unterrichtseinheiten und kann den Inhalt des letzten Termins bearbeiten / erfassen.
  
#### Verwaltungsfunktionen
##### Login **/F01/**
* Der Nutzer kann sich mit Benutzername und Passwort anmelden.
* Benutzername und Passwort können von dem Administrativen Nutzer mithilfe von Direktzugriff auf das System angelegt werden
##### Offene Anträge **/FV01/**
* Es werden eingegange Anträge und nicht bestätigte Verträge angzeigt.
* Mit einem Klick auf einen eingegangen Antrag wird die [Kurs erstellen](#kurs-erstellen) ge
##### Kurs Erstellen **/FV02/**
* Nach einem eingegegangen Antrag kann basierent auf diesem ein Kurs erstellt werden. 
* Typ (Einzel, Gruppe, ), Instrument(e), Laufzeit und Personenbezogne Daten werden in der Kurserstllungs Mask vorausgefüllt  
* Es werden Dozenten angezeigt, welche zu den Instrumentenanforderungen passen
* Es werden Räume angezeigt, welche zu den Instrumentenanforderungen passen
* Nach Auswahl von Raum und Dozent wird/werden die Zeit(en) für die Unterrichtseinheiten gewählt werden; Die Möglichkeit der auswahl wird überprüft
* Nach erfolgreicher Auswahl wird der Kurs in der Datenbank angelegt und der Schüler über den Kurs informiert. Dieser muss ihn vor der ersten Unterrichtseinheit bestätigen, ansonster verfällt der Kurs.
##### Mitglied zu Kurs hinzufügen 

1. Mitglied zu Gruppenkurs hinzufügen
2. Kursübersicht
3. Schülerübersicht
4. Schüler eines Lehrers
5. Raumübersicht m. Raumplan
6. Offene Anträge 
7. Finanzübersichrt