From Princípy tvorby software

Informačný Systém Študijného Oddelenia (ISŠO) - Systémová špecifikácia

Contents 1 Úvod 1.1 Účel 1.2 Vysvetlenie použitých pojmov 1.3 Cieľová skupina čitateľov 1.4 Rozsah projektu 1.5 Referencie 2 Všeobecný popis 2.1 O produkte 2.2 Funkcie produktu 2.3 Triedy používateľov a ich charakteristika 2.3.1 Študent 2.3.2 Učiteľ 2.3.3 Pracovník študijného oddelenia (PŠO) 2.3.4 Šéf katedry 2.4 Operačné prostredie 2.5 Dizajnové a implementačné obmedzenia 3 Externé rozhranie 3.1 Užívateľské rozhranie 3.2 Hardvérové rozhranie 3.2.1 Serverová časť 3.2.2 Klientská časť 3.3 Softvérové rozhranie 3.3.1 Serverová časť 3.3.2 Klientská časť 3.4 Komunikačné rozhranie 4 Vlastnosti systému 4.1 Správa užívateľského profilu 4.1.1 Popis a priorita 4.1.2 Odpoveď systému 4.1.3 Funkčné požiadavky 4.2 Zoznam predmetov 4.2.1 Popis a priorita 4.2.2 Odpoveď systému 4.2.3 Funkčné požiadavky 4.3 Zoznam študentov 4.3.1 Popis a priorita 4.3.2 Odpoveď systému 4.3.3 Funkčné požiadavky 4.4 Tvorba zápisného listu 4.4.1 Popis a priorita 4.4.2 Odpoveď systému 4.4.3 Funkčné požiadavky 4.5 Termíny hodnotenia predmetu 4.5.1 Popis a priorita 4.5.2 Odpoveď systému 4.5.3 Funkčné požiadavky 4.6 Hodnotenie predmetu 4.6.1 Popis a priorita 4.6.2 Odpoveď systému 4.6.3 Funkčné požiadavky 4.7 Správa predmetov 4.7.1 Popis a priorita 4.7.2 Odpoveď systému 4.7.3 Funkčné požiadavky 4.8 Správa študentov 4.8.1 Popis a priorita 4.8.2 Odpoveď systému 4.8.3 Funkčné požiadavky 4.9 Správa učiteľov 4.9.1 Popis a priorita 4.9.2 Odpoveď systému 4.9.3 Funkčné požiadavky 4.10 Správa PŠO 4.10.1 Popis a priorita 4.10.2 Odpoveď systému 4.10.3 Funkčné požiadavky 5 Ďalšie požiadavky 5.1 Bezpečnostné požiadavky 6 Príloha A: Zoznam použitých pojmov 7 Príloha B: Use Case

Úvod

Účel

Tento dokument definuje požiadavky pre Informačný Systém Študijného Oddelenia (ISŠO).

Vysvetlenie použitých pojmov

Nasledujúca tabuľka opisuje pojmy špecifické pre tento dokument

Pojem / Skratka	Vysvetlenie
ISŠO	Informačný Systém Študijného Oddelenia
PŠO	Pracovník študijného oddelenia

Cieľová skupina čitateľov

Táto špecifikácia je cielená pre systémových architektov a systémových programátorov.

Rozsah projektu

Tento dokument opisuje systém ISŠO, ktorého cieľom je vytvoriť rozhranie pre administráciu študijného procesu študentov na fakulte.

Referencie

Systém AIS2

Všeobecný popis

O produkte

Tento dokument opisuje nový systém, ktorý má pomôcť v administratíve štúdia na vysokých školách a univerzitách, vytvorením jednotného a prístupného rozhrania pre študentov ako aj pracovníkov fakulty.

Funkcie produktu

• Študenti si zapisujú predmety z ponuky predmetov. Zápis si môžu meniť do troch týždňov od začiatku semestra.
• Učitelia majú možnosť vidieť, kto si predmet zapísal.
• Učitelia posielajú informácie k predmetu zapísaným študentom, vytvárajú termíny skúšok a hodnotia študentov.
• Študenti sa prihlasujú na skúšky a vidia svoje hodnotenie.
• Pracovníci študijného oddelenia môžu zadávať predmety a vidia ako sú na tom študenti, ktorých majú na starosti.
• Šéf katedry vidí, aký bol študijný priemer predmetov, ktoré majú na starosti pracovníci katedry.

Triedy používateľov a ich charakteristika

Študent

Najpočetnejšia trieda používateľov, pri tejto triede sa nepredpokladá absolvovanie potrebných školení na prácu so systémom, preto je aj ich odbornosť čo sa týka tejto práce najmenšia.

Učiteľ

Táto trieda používateľov používa systém hlavne na interakciu s užívateľmi z triedy Študent. Školenia určené pre túto triedu síce nie sú povinné, ale odporúča sa pripraviť aspoň základné pomôcky pre prácu so systémom.

Pracovník študijného oddelenia (PŠO)

Používatelia z triedy PŠO majú na starosti administráciu viacerých procesov v systéme, preto je na týchto užívateľov kladený väčší nárok čo sa týka skúseností so systémom. Užívatelia z tejto triedy by mali povinne absolvovať školenie práce so systémom.

Šéf katedry

Je hlavným administrátorom systému, preto má v tomto systéme najviac zodpovedností. Nakoľko dokáže zmeniť dôležité nastavenia ovplyvňujúce chod systému, mal by byť takýto užívateľ plne oboznámený so systémom a jeho administráciou. Za týmto účelom by mali byť vytvorené pre túto triedu používateľov špeciálne pokyny, ako správne postupovať v prípadoch potreby administratívneho zásahu do systému.

Operačné prostredie

Softvér bude pracovať ako služba prevádzkovaná na serveroch fakulty. Na týchto serveroch by mali byť podporované operačné systémy Windows a Linux. Klientská časť systému by mala byť prístupná pomocou webového prehliadača, pričom by mali byť na strane klienta podporované minimálne systémy Windows, Linux a Mac OS. Systém by sa mal dať použiť aj pomocou prehliadača pracujúceho v textovom móde.

Dizajnové a implementačné obmedzenia

Projekt by mal byť napísaný v jazyku PHP a mal by fungovať nad SQL databázou. Odozva systému by sa mala pri jednotlivých akciách zmestiť do 5 sekúnd, v prípade pomalšej reakcie by mal systém poskytnúť užívateľovi grafický priebeh spracovania požiadavky.

Externé rozhranie

Užívateľské rozhranie

Systém poskytuje používateľovi grafické rozhranie vo forme webových stránok. Vygenerované stránky musia spĺňať štandardy XHTML 1.0 Transitional, CSS 2.1 a WCAG 2.0 AA (alebo vyššie). Na každej stránke musí byť odkaz, ktorý zobrazí užívateľovi podrobný zoznam jednotlivých akcií aj s vysvetlením, ktoré mu aktuálna stránka ponúka.

Hardvérové rozhranie

Na poskytnutie špecifikovanej funkcionality by mal hardvér spĺňať aspoň nasledujúce minimálne požiadavky.

Serverová časť

Procesor Intel Xeon pracujúci na frekvencii aspoň 2 GHz.

Pamäť RAM o kapacite aspoň 2048 MiB.

Diskové pole o kapacite aspoň 500 GB.

Internetové pripojenie s rýchlosťou aspoň 10 Mbit/s v oboch smeroch.

Klientská časť

Klientský počítač by mal byť schopný zobraziť a prevádzkovať internetový prehliadač v reálnom čase, s odozvou menšou ako 3 sekundy.

Internetové pripojenie aspoň 800 kbit/s pri sťahovaní a 200 kbit/s pri uploadovaní.

Tlačiareň, za predpokladu že je požadovaná aj tlačená verzia dokumentov.

Softvérové rozhranie

Serverová časť

OS: Windows, Linux

PHP: od verzie 5 vyššie

SQL: MySQL, Oracle RDBMS

Klientská časť

OS: Windows, Linux, Mac OS

Webový prehliadač: Internet Explorer 7(a vyššie), Mozilla Firefox 3.0(a vyššie), Opera(10.0) a vyššie, podpora pre textové prehliadače.

Komunikačné rozhranie

Protokol pre prenos dát: HTTP a HTTPS.

Protokol pre prenos správ: POP3.

Prenos dát na fyzickej vrstve pomocou TCP/IP, vo verziách IPv4 a IPv6.

Vlastnosti systému

Správa užívateľského profilu

Popis a priorita

Užívatelia si môžu spravovať svoj profil s cieľom poskytovať aktuálne a pravdivé hodnoty o svojom konte. PŠO navyše spravuje kontá Študentov a Šéf katedry spravuje kontá všetkých užívateľov okrem tých z triedy Študent.

Priorita: stredná

Odpoveď systému

Užívateľ vyplní webový formulár určený na zmenu údajov. Systém overí vstupné dáta, vykoná zmeny a užívateľa informuje o výsledku formou správy na obrazovke. V prípade chyby systém zmeny nevykoná a informuje užívateľa formou chybovej hlášky na obrazovke.

Funkčné požiadavky

1. Profil užívateľa obsahuje nasledujúce údaje o užívateľovi: meno, priezvisko, rodne číslo, adresa, e-mail, tel. kontakt.
2. Profil užívateľa z triedy Študent navyše obsahuje rok štúdia, študijný odbor/program a prideleného PŠO.
3. Učiteľ navyše obsahuje pracovisko, kancelária.
4. PŠO a Šéf katedry navyše obsahuje kancelária.
5. Užívateľ môže meniť nasledujúce položky v svojom profile: e-mail, tel. kontakt.
6. Užívateľ z triedy PŠO môže meniť všetky položky profilu všetkých užívateľov triedy Študent.
7. Užívateľ z triedy Šéf katedry môže meniť všetky položky profilu všetkých užívateľov z tried Učiteľ, PŠO a Šéf katedry.
8. Všetky zmeny profilu sú uchovávané po dobu 8 rokov.

Zoznam predmetov

Popis a priorita

Generuje zoznam predmetov nachádzajúcich sa v databáze spolu so zapísanými Študentami všetkým užívateľom. Študentom umožňuje zaraďovať predmety do svojich zápisných listov v určených termínoch.

Priorita: vysoká

Odpoveď systému

Systém zobrazí zoznam predmetov usporiadaný podľa vybraných kritérií. Po zaradení predmetu Študentom do zápisného listu zobrazí oznam o vykonanej akcií a ponúkne presmerovanie na zápisný list. Po označení predmetu sa zobrazia jeho detaily spolu so zoznamom Študentov, ktorí si predmet zapísali.

Funkčné požiadavky

1. Systém generuje zoznam predmetov obsahujúci názov predmetu, kód predmetu, odporúčaný rok štúdia, semester výučby, počet kreditov, typ výučby, max. počet Študentov a meno garanta/ov predmetu.
2. Zoznam je možné usporiadať podľa ľubovoľného z kritérií.
3. Je implementované vyhľadávanie medzi predmetmi.
4. Študent si môže zaradiť predmet do zápisného listu, ak je možnosť tvorby zápisných listov povolená.

Zoznam študentov

Popis a priorita

Umožnenie generovania zoznamu Študentov. Pre oprávnené osoby je možné zobraziť profil Študenta.

Priorita: stredná

Odpoveď systému

Systém zobrazí zoznam Študentov usporiadaný podľa vybraných kritérií. Po označení Študenta sa vybraným užívateľom (z tried PŠO, Učiteľ) zobrazí profil Študenta spolu so zoznamom zapísaných predmetov, hodnotení.

Funkčné požiadavky

1. Systém generuje zoznam Študentov obsahujúci meno, študijný odbor, rok štúdia, počet získaných kreditov (vidí len PŠO), študijné priemery pre každý semester štúdia (vidí len PŠO).
2. Zoznam je možné usporiadať podľa ľubovoľného z kritérií.
3. Je implementované vyhľadávanie medzi Študentami.

Tvorba zápisného listu

Popis a priorita

Študent si v určenom období zapisuje predmety do zápisného listu. Hotový zápisný list potvrdzuje PŠO. PŠO vytvára zápisné listy pre Študentov a odomyká či uzatvára ich pre ďalšie úpravy.

Priorita: vysoká

Odpoveď systému

Systém generuje zápisný list s údajmi o Študentovi a zapísanými predmetmi. Umožňuje nielen obrazový výstup ale aj výstup pre tlač.

Funkčné požiadavky

1. Zápisný list obsahuje položky Študent, rok štúdia, zoznam zapísaných predmetov a dátum pridania každého z predmetov.
2. Každý zápisný list môže PŠO uzamknúť/odomknúť pre ďalšie úpravy.
3. Zápisný list sa po potvrdení Študentom uzamyká pre ďalšie úpravy a PŠO sa posunie na potvrdenie.

Termíny hodnotenia predmetu

Popis a priorita

Študent má možnosť sa prihlásiť na termín hodnotenia zapísaného predmetu a zistiť jeho výsledok. Učiteľ upravuje termíny hodnotenia svojich predmetov a ich výsledky.

Priorita: nízka

Odpoveď systému

Systém generuje zoznam termínov zapísaných predmetov a ich výsledky.

Funkčné požiadavky

1. Študent vidí a môže sa prihlásiť iba na termíny predmetov, ktoré má zapísané.
2. Študent vidí len svoje hodnotenia.
3. Učiteľ vidí zoznam termínov hodnotenia predmetov, ktoré má na starosti a zoznam Študentov spolu s výsledkami.
4. Študent nesmie vedieť zistiť výsledok iného študenta.
5. Učiteľ nesmie vidieť iné výsledky Študentov.
6. Výsledky nemajú štandardný tvar, sú vedené ako textový reťazec ľubovoľného tvaru.

Hodnotenie predmetu

Popis a priorita

Študent vidí zoznam zapísaných predmetov spolu s ich výsledným hodnotením a vidí svoje vážené priemery. Učiteľ a Šéf katedry vidia zoznam predmetov spolu s priemermi hodnotení. Učiteľ a Šéf katedry majú možnosť upravovať Študentom hodnotenia predmetov, na ktoré majú oprávnenie (Šéf katedry - všetky, Učiteľ - len tie, ktoré má na starosti).

Priorita: vysoká

Odpoveď systému

Generuje zoznam predmetov spolu s priemerným hodnotením. Na požiadanie Učiteľom alebo Šéfom katedry generuje formulár na úpravu hodnotení pre vybraný predmet a informuje o výsledku.

Funkčné požiadavky

1. Študent vidí iba svoje hodnotenia.
2. Učiteľ vidí hodnotenia iba predmetov, ktoré má pridelené.
3. Šéf katedry vidí všetky hodnotenia.
4. Priemerné hodnotenie predmetu zobrazuje údaj za posledný ukončený semester, v ktorom sa predmet vyučoval.
5. Hodnotenia sú z množiny {A,B,C,D,E,Fx} a sú im pridelené váhy 1; 1,5; 2; 2,5; 3; 4.

Správa predmetov

Popis a priorita

Šéf katedry má možnosť pridávať, upravovať a mazať predmety. Učiteľ má možnosť upravovať vybrané položky pridelených predmetov.

Priorita: stredná

Odpoveď systému

Systém generuje oznam o úspešnosti vykonanej zmeny. V prípade úpravy predmetu systém rozpošle Študentom, ktorí ho majú zapísaný, notifikačnú e-mailovú správu obsahujúcu informácie o zmenách.

Funkčné požiadavky

1. Predmet sa skladá z položiek názov predmetu, kód predmetu, odporúčaný rok štúdia, semester výučby, počet kreditov, typ výučby, max. počet študentov, garanta/ov predmetu a poznámka k predmetu.
2. Učiteľ má oprávnenie iba na zmenu poznámky k predmetu.
3. Notifikačný e-mail je posielaný z adresy v tvare nazov_predmetu@domena_organizacie. Predmet správy je v tvare "Informácia o zmene predmetu: nazov_predmetu". Na notifikačný e-mail nie je možné odpovedať.
4. Notifikácia obsahuje správu s textom "V predmete nazov_predmetu boli vykonané nasledujúce zmeny: popis_zmien".
5. Vymazaný predmet je v systéme naďalej evidovaný s príznakom identifikujúcim vymazanie.
6. Nie je možné vymazať predmet, ktorý má zapísaný aspoň jeden Študent.

Správa študentov

Popis a priorita

PŠO spravuje užívateľov typu Študent, tzn. pridávať, upravovať a mazať Študentské kontá, ak je to možné. Pridávanie užívateľov je možné jednotlivo alebo hromadne.

Priorita: vysoká

Odpoveď systému

Systém informuje o (ne)úspešnosti vykonania krokov a prípadný zoznam nových prihlasovacích mien a dočasných hesiel. Pri vytvorení nového konta systém vygeneruje nové prihlasovacie meno a dočasné heslo.

Funkčné požiadavky

1. Spravovať Študentov môžu iba užívatelia z triedy PŠO.
2. Študent nie je po vymazaní vyradený zo systému, ale je odhlásený zo všetkých predmetov v aktuálnom akademickom roku a je mu zmenené prihlasovacie meno na tvar !prihlasovacie_meno a náhodne vygenerované nové heslo, ktoré nie je nikomu oznámené.
3. Údaje o užívateľovi triedy Študent sú prihlasovacie meno, heslo, reálne meno a profil.
4. Dočasné heslo má 16 náhodných alfanumerických znakov bez diakritiky, v ktorom je aspoň 1 znak z množiny veľkých písmen, aspoň 1 znak z množiny malých písmen a aspoň 1 číslicu.
5. Prihlasovacie heslo sa nezobrazuje v žiadnom tvare, PŠO ho môže iba zmeniť.
6. Hromadný import nových užívateľov z triedy Študent je realizovaný nahraním súboru obsahujúcim prihlasovacie meno, dočasné heslo, reálne meno, e-mail, rodné číslo, adresa, tel. kontakt, študijný odbor/program.

Správa učiteľov

Popis a priorita

Šéf katedry má možnosť spravovať Učiteľov - pridať, zrušiť a upraviť.

Priorita: nízka

Odpoveď systému

Systém generuje zoznam Učiteľov a správy o (ne)úspešnosti vykonania príkazov.

Funkčné požiadavky

1. Spravovať Učiteľov môžu iba užívatelia z triedy Šéf katedry.
2. Učiteľ nie je po vymazaní vyradený zo systému, ale je odstránený zo všetkých predmetov ako garant a je mu zmenené prihlasovacie meno na tvar !prihlasovacie_meno a náhodne vygenerované nové heslo, ktoré nie je nikomu oznámené.
3. Údaje o užívateľovi Učiteľ sú prihlasovacie meno, heslo, reálne meno a profil.
4. Dočasné heslo má 16 náhodných alfanumerických znakov bez diakritiky, v ktorom je aspoň 1 znak z množiny veľkých písmen, aspoň 1 znak z množiny malých písmen a aspoň 1 číslicu.
5. Prihlasovacie heslo sa nezobrazuje v žiadnom tvare, Šéf katedry ho môže iba zmeniť.
6. Učiteľ nemôže byť vymazaný, ak existuje predmet, ktorého je jediným garantom.

Správa PŠO

Popis a priorita

Šéf katedry má možnosť spravovať PŠO - pridať, zrušiť a upraviť.

Priorita: nízka

Odpoveď systému

Systém generuje zoznam PŠO a správy o (ne)úspešnosti vykonania príkazov.

Funkčné požiadavky

1. Spravovať PŠO môžu iba užívatelia z triedy Šéf katedry.
2. PŠO nie je po vymazaní vyradený zo systému, ale je mu zmenené prihlasovacie meno na tvar !prihlasovacie_meno a náhodne vygenerované nové heslo, ktoré nie je nikomu oznámené .
3. Údaje o užívateľovi z triedy PŠO sú prihlasovacie meno, heslo, reálne meno a profil.
4. Dočasné heslo má 16 náhodných alfanumerických znakov bez diakritiky, v ktorom je aspoň 1 znak z množiny veľkých písmen, aspoň 1 znak z množiny malých písmen a aspoň 1 číslicu.
5. Prihlasovacie heslo sa nezobrazuje v žiadnom tvare, Šéf katedry ho môže iba zmeniť.
6. Ak PŠO spravuje nejakých Študentov, musia byť títo pri jeho vymazaní pridelení inému PŠO.

Ďalšie požiadavky

Bezpečnostné požiadavky

Všetka komunikácia medzi serverom a klientom prebieha šifrovane, pomocou HTTPS šifrovania, alebo ekvivalentne bezpečným spôsobom. V druhom prípade musí táto komunikácia prebiehať na pozadí, a nemôže od užívateľa vyžadovať dodatočnú inštaláciu softvéru.

Používatelia sa prihlasujú pomocou prihlasovacieho mena a hesla, pričom heslo sa musí skladať z minimálneho počtu 8 znakov, a musí obsahovať aspoň jednu číslicu.

Príloha A: Zoznam použitých pojmov

1 GB - jednotka množstva dát rovná 1 000 000 Bajtom.

1 kbit/s - jednotka rýchlosti prenosu dát rovná prenosovej rýchlosti 1 000 bitov za sekundu.

1 Mbit/s - jednotka rýchlosti prenosu dát rovná prenosovej rýchlosti 1 000 000 bitov za sekundu.

1 MiB - jednotka množstva dát rovná 1 048 576 Bajtom.

CSS 2.1 - odporúčania pre tvorbu kaskádových štýlov vytvorené konzorciom W3C, verzia 2.1

HTML - základný jazyk pre hypertextové dokumenty používaný na Internete.

HTTP - protokol určený pre výmenu hypertextových dokumentov vo formáte HTML.

HTTPS - nadstavba protokolu HTTP, ktorá umožňuje zabezpečiť spojenie pred odposluchom, podvrhom dát a umožňuje overiť identitu protistrany.

Intel Xeon - rodina serverových procesorov vyvinutá spoločnosťou Intel Corporation.

Internet Explorer - webový prehliadač vyvinutý spoločnosťou Microsoft Corporation.

IPv4 - verzia 4 protokolu TCP/IP.

IPv6 - verzia 6 protokolu TCP/IP.

Linux - operačný systém podobný systému Unix.

Mac OS - operačný systém vyvinutý spoločnosťou Apple Inc.

Mozilla Firefox - webový prehliadač vyvinutý spoločnosťou Mozilla Corporation.

MySQL - systém riadenia bázy dát.

Opera - webový prehliadač vyvinutý spoločnosťou Opera Software.

Oracle RDBMS - systém riadenia bázy dát vytvorený spoločnosťou Oracle Corporation.

PHP - skriptovací jazyk používaný na tvorbu dynamických webových stránok.

POP3 - protokol používaný na prenos pošty cez protokol TCP/IP

SQL - jazyk určený na správu dát v databáze.

TCP/IP - sada protokolov určená primárne na komunikáciu v sieti Internet.

Windows - operačný systém vyvinutý spoločnosťou Microsoft Corporation.

WCAG - odporúčania pre tvorbu prístupného webu vytvorené konzorciom W3C.

XHTML - XML rozšírenie HTML jazyka.

XML - množina pravidiel opisujúca kódovanie dokumentov.

Príloha B: Use Case