Vaatimusmaaritelma.md

+# Vaatimusmäärittely
+
+
+## Sisällysluettelo
+
+* [Asiakastarina ja asiakaspolku](https://gitlab.labranet.jamk.fi/PRJTEAM-H/halinallet/wikis/Vaatimusmaaritelma#asiakastarina-ja-asiakaspolku)
+* [Sidosryhmät ja profiilikuvaukset](https://gitlab.labranet.jamk.fi/PRJTEAM-H/halinallet/wikis/Vaatimusmaaritelma#sidosryhm%C3%A4t-stakeholders-ja-profiilikuvaukset-profile-descriptions)
+* [Sidosryhmäkuva](https://gitlab.labranet.jamk.fi/PRJTEAM-H/halinallet/wikis/Vaatimusmaaritelma#sidosryhm%C3%A4kuva-stakeholder-map)
+* [Yleiset käyttötapaukset](https://gitlab.labranet.jamk.fi/PRJTEAM-H/halinallet/wikis/Vaatimusmaaritelma#yleiset-k%C3%A4ytt%C3%B6tapaukset-general-use-cases)
+* [Yleiset toiminnalliset vaatimukset](https://gitlab.labranet.jamk.fi/PRJTEAM-H/halinallet/wikis/Vaatimusmaaritelma#palveluun-liittyv%C3%A4t-toiminnalliset-vaatimukset-functional-requirements)
+* [Yleiset ei-toiminnalliset vaatimukset](https://gitlab.labranet.jamk.fi/PRJTEAM-H/halinallet/wikis/Vaatimusmaaritelma#palveluun-liittyv%C3%A4t-ei-toiminnalliset-vaatimukset)
+* [Palvelu MockUp](https://gitlab.labranet.jamk.fi/PRJTEAM-H/halinallet/wikis/Vaatimusmaaritelma#palvelu-mockup-prototyyppi)
+* [Tärkeimmät ominaisuudet](https://gitlab.labranet.jamk.fi/PRJTEAM-H/halinallet/wikis/Vaatimusmaaritelma#t%C3%A4rkeimm%C3%A4t-tunnistetut-ominaisuudet-features)
+* [Julkaisun suunnitelma](https://gitlab.labranet.jamk.fi/PRJTEAM-H/halinallet/wikis/Vaatimusmaaritelma#julkaisun-suunnitelma)
+* [Palvelun/ohjelmiston arkkitehtuuri](https://gitlab.labranet.jamk.fi/PRJTEAM-H/halinallet/wikis/Vaatimusmaaritelma#palvelunohjelmiston-arkkitehtuuri)
+* [Testauksen vaatimukset](https://gitlab.labranet.jamk.fi/PRJTEAM-H/halinallet/wikis/Vaatimusmaaritelma#testauksen-vaatimukset-testing-requirements)
+
+## Johdatus
+
+Kyseessä on Jyväskylän ammattikorkeakoululle tehtävän opintojen valintaa helpottavan sivuston vaatimusmäärittely.
+
+
+Vaatimusmäärittelyssä perehdytään tarkemmin eri sidosryhmiin sekä käyttäjäprofiileihin. Tämän lisäksi määrittelystä löytyy kaksi käyttötapausta:
+
+- Opiskelijan HOPS:n eteneminen alusta loppuun
+- Yrityksen suositusten vastaanottaminen
+
+
+Vaatimusmäärittelyssä on myös määritelty useampia eri vaatimuksia, joita sovelluksen tulisi noudattaa.
+
+
+Näiden lisäksi tässä vaatimusmäärittelyssä pääset tutustumaan muutamaan erilaiseen ominaisuuteen, sekä näiden perusteella tehtyihin testitapauksiin.
+
+
+
+### Palvelukuvaus
+
+Jyväskylän ammattikorkeakoulun tieto- ja viestintätekniikan opiskelijat valitsevat omat kurssinsa neljän eri suuntautumisvaihtoehdon joukosta. Tällä hetkellä opintojen valitseminen voi olla opiskelijalle sekavaa ja opintojen seuraamiseen tarvittavaa henkilökohtaista opintosuunnitelmaa (HOPS:ia) pitää päivittää manuaalisesti.
+
+
+Tavoitteena olisi saada selkeä sovellus, joka hakisi opiskelijalle hänen saatavillaan olevat kurssit helposti esille. Sovellus hakisi myös opiskelijan jo suorittamat kurssit, joka auttaa valintojen tekemisessä.
+
+
+Sovelluksen tulisi myös voida kerätä dataa eri yrityksiltä. Yrityksen henkilöstö voisi käydä äänestämässä juuri heidän yritykselleen tärkeitä kursseja. Mikäli tarpeellisia kursseja ei ole saatavilla, niitä voisi ehdottaa. Näin koulu saa ajantasaista tietoa tulevia lukukausia ja uusia kursseja suunnitellessaan.
+
+
+Näin sovellus auttaisi opiskelijaa hakeutumaan tiettyyn yritykseen töihin. Opiskelija voisi tarkistaa (olettaen, että ko. yritykseltä on saatu kerättyä jo tietoja), mitä opintoja hänen tulisi ottaa itselleen, jotka ovat tarpeellisia tietylle yritykselle.
+
+
+Tämän lisäksi sovellukseen olisi hyvä kehittää suojausmenetelmiä mahdollisten väärinkäyttöyrityksien estämiseksi.
+
+
+### Vaatimusmäärittelytyön tilaaja
+
+Karo Saharinen
+
+### Vaatimusmäärittelyn toimittaja
+
+Halinallet
+
+## Asiakastarina ja asiakaspolku
+
+Tästä pääset tutustumaan opiskelijan sekä yrityksen asiakastarinoihin ja palvelupolkuihin.
+
+- [opiskelijan tarina](Asiakastarina)
+- [yrityksen tarina](https://gitlab.labranet.jamk.fi/PRJTEAM-H/halinallet/wikis/Yritystarina)
+
+## Sidosryhmät (Stakeholders) ja profiilikuvaukset (Profile descriptions)
+
+Opintojen valintasovellusta käyttäisivät pääsääntöisesti
+
+- opiskelijat
+  - [Osmo Kauppi](Profiili 1)
+- opetushenkilöstö
+  - [Hellä Rahkamo](Profiili 2)
+- koulutusvastaava
+  - [Valma Huhtala](Profiili 3)
+- yrityksien esimiehet
+  - [Aukusti Peltonen](Profiili 4)
+- yrityksien työntekijät
+  - [Pihla Saari](Profiili 5)
+- epämääräiset henkilöitymät, jotka yrittävät jotenkin tuoda palvelun alas / hyötyä siitä
+  - [Manu Inha](Profiili 6)
+
+
+## Sidosryhmäkuva (Stakeholder map)
+
+![Sidosryhmät](/uploads/36de6f4629a9193d332eca9b899757b0/Sidosryhmät.png)
+
+
+
+## Tuotteen yleisiä vaatimuksia ja rajoituksia (General Requirements and restrictions)
+
+
+
+| Id | Vaatimuksen kuvaus | kategoria | Vastuullinen |  
+|:-:|:-:|:-:|:-:|  
+| GENREQ001 | Palveluun tunnistaudutaan Asio-tunnuksilla | Käyttöoikeudet | Tuotantotiimi |  
+| GENREQ002 | Palvelun tulee kestää vähintään 1000 samanaikaista käyttäjää | Suorituskyky | Tuotantotiimi |  
+| GENREQ003 | Palvelun alustana voidaan käyttää Amazonin pilvipalvelu | Järjestelmä | Tuotantotiimi |  
+| GENREQ004 | Palvelua käytetään Chromen ja Firefoxin versioilla : Chrome (Versio 64.0 ja ylöspäin) Firefox (Versio 58.0.2 ja ylöspäin) | Järjestelmä | Tuotantotiimi |  
+| GENREQ005 | Vain pääkäyttäjällä on oikeus päästä palvelun arkkitehtuuriin | Tietoturva | Tuotantotiimi |  
+| GENREQ006 | Vain JAMK:n käyttöön | Käyttöoikeudet | Tuotantotiimi |  
+| GENREQ007 | Palvelua käytetään tietokoneen verkkoselaimella | Käyttöoikeudet | Tuotantotiimi |  
+| GENREQ008 | Palveluun tunnistaudutaan yrityksen omilla generoiduilla tunnuksilla | Käyttöoikeudet | Tuotantotiimi |  
+| GENREQ009 | Palvelua voi selata sinne tunnistautumatta | Käyttöoikeudet | Tuotantotiimi |  
+
+
+
+## Yleiset käyttötapaukset (General Use Cases)
+
+Alta pääset tutustumaan palvelun käyttötapauksiin.
+
+[Opiskelijan opintojaksojen valinta](https://gitlab.labranet.jamk.fi/PRJTEAM-H/halinallet/wikis/Kayttotapaus-1:-Opintojaksojen-valinta)
+
+[Yrityksen suosituksen antaminen](https://gitlab.labranet.jamk.fi/PRJTEAM-H/halinallet/wikis/Kayttotapaus-2:-Suosituksen-antaminen)
+
+[Opiskelijan kirjautuminen palveluun](https://gitlab.labranet.jamk.fi/PRJTEAM-H/halinallet/wikis/Kayttotapaus-3:-obsimo:n-kirjautuminen)
+
+
+## Palveluun liittyvät toiminnalliset vaatimukset (Functional Requirements)
+
+
+| Id | Vaatimuksen kuvaus | kategoria | Vastuullinen |
+|:-:|:-:|:-:|:-:|
+| TV001| Palvelun pitää toimia opiskelijan tunnuksilla | Toiminnallinen | Tuotantotiimi | 
+| TV002| Ulkoisille yrityksille generoidaan avain, jolla kirjautua palveluun | Toiminnallinen | Tuotantotiimi | 
+| TV003| Palvelu osaa hakea opiskelijan suoritetut kurssit asiosta | Toiminnallinen | Tuotantotiimi | 
+| TV005 | Yritys voi vastata vain kerran vuodessa kyselyyn halutuista opintojaksoista | Käyttöoikeudet | Tuotantotiimi | 
+| TV006 | Palvelu huomauttaa jos vastauksissa on valittuna liian vähän tai enemmän kuin vaadittu määrä opintopisteitä	| Toiminnallinen | Tuotantotiimi | 
+| TV007 | Palvelu valitsee automaattiset pakolliset opinnot, joita yrityskäyttäjä ei voi muuttaa	| Toiminnallinen | Tuotantotiimi | 
+| TV008 | Oppilas voi muokata valintojaan koska tahansa | Käyttöoikeudet | Tuotantotiimi | 
+| TV009 | Palvelussa on kurssien haku-toiminto | Toiminnallinen | Tuotantotiimi |
+| TV012 | Yritys voi rekisteröityä palveluun, jonka jälkeen pääkäyttäjän tulee hyväksyä rekisteröityminen | Toiminnallinen | Tuotantotiimi |
+
+
+
+## Palveluun liittyvät ei-toiminnalliset vaatimukset
+
+### Käytettävyys
+
+
+| Id | Vaatimuksen kuvaus | Kategoria | Vastuullinen | 
+|:-:|:-:|:-:|:-:| 
+| ETVK001 | Palvelun tulee olla mahdollisimman yksinkertainen, esimerkiksi valitut kurssit tulee näkyä selkeästi | Käytettävyys | Tuotantotiimi |  
+| ETVK003 | Järjestelmän tulee olla dokumentoitu niin, että uudet pääkäyttäjät pystyvät sisäistämään sen tehokkaasti | Käytettävyys | Tuotantotiimi | 
+| ETVK004 | Järjestelmän tulee olla käytettävissä 99% prosenttia ajasta | Käytettävyys | Tuotantotiimi | 
+| ETVK005 | Palvelu on saatavilla suomeksi ja englanniksi | Käytettävyys | Tuotantotiimi |
+
+### Suorituskyky
+
+
+| Id | Vaatimuksen kuvaus | Kategoria | Vastuullinen | 
+|:-:|:-:|:-:|:-:| 
+| ETVS001 | Sivun aukeamiseen saa kulua korkeintaan 10 sekuntia | Suorituskyky | Tuotantotiimi | 
+| ETVS003 | Tavalliseen tietokannasta tehtävään hakuun saa kulua korkeintaan 0.2 sekuntia | Suorituskyky | Tuotantotiimi | 
+
+### Tietoturva
+
+
+| Id | Vaatimuksen kuvaus | Kategoria | Vastuullinen | 
+|:-:|:-:|:-:|:-:| 
+| ETVT001 | Järjestelmän tulee aina käyttää salattua yhteyttä | Tietoturva | Tuotantotiimi | 
+| ETVT002 | Järjestelmästä sähköpostitse lähtevien linkkien tulee olla uniikkeja ja mahdottomia arvata | Tietoturva | Tuotantotiimi | 
+| ETVT003 | Käytettävien salasanojen tulee voida olla ainakin 40 merkkiä | Tietoturva | Tuotantotiimi | 
+| ETVT004 | Salasanoissa tulee voida käyttää erikoismerkkejä | Tietoturva | Tuotantotiimi | 
+
+### Palautettavuus
+
+
+| Id | Vaatimuksen kuvaus | Kategoria | Vastuullinen | 
+|:-:|:-:|:-:|:-:| 
+| ETVP001 | Järjestelmän tiedoista tulee olla saatavilla korkeintaan kolme päivää vanha varmuuskopio | Palautettavuus | Tuotantotiimi | 
+| ETVP002 | Järjestelmään tulee tallentua, kuka sitä on käyttänyt ja milloin | Palautettavuus | Tuotantotiimi | 
+
+### Tekniset vaatimukset
+
+| Id | Vaatimuksen kuvaus | Kategoria |
+|:-:|:-:|:-:|
+| TEKT001 | Tietokannalle ja Webbi serverille omat Lightsail virtuaalipalvelimet | Tekninen |  
+| TEKT002 | Vähintään 1GB keskusmuistia virtuaalipalvelimille | Tekninen | 
+| TEKT003 | Palvelun tulee olla käytössä 24/7 | Tekninen |
+| TEKT004 | Palvelimet pyörivät Linuxilla (vähintään Ubuntu 16.04) | Tekninen |
+| TEKT005 | Web serveri käyttää Apachea (vähintään 2.4.18) | Tekninen |
+| TEKT006 | Tietokanta vähintään MySQL:llä (14.14) | Tekninen |
+| TEKT007 | Palvelu tehdään käyttäen Javascriptiä ja PHP:ta (vähintään 7.0.22)  | Tekninen | 
+| TEKT008 | Pitää käyttää mahdollisimman luotettavia ja ajantasalla olevia kirjastoja | Tekninen | 
+| TEKT009 | Vähintään 20GB SSD virtuaalipalvelimille | Tekninen | 
+
+Huom. Tekniset vaatimukset olivat aiemmin ID:llä REQ
+
+
+## Palvelu MockUp-prototyyppi
+
+Täältä pääset tutustumaan OBSIMO-palvelun prototyyppiin
+
+[Obsimo](/uploads/b972e7e8a246f0a2e37ca2243885e4fc/image.png)
+
+
+## Tärkeimmät tunnistetut ominaisuudet (Features)
+
+
+| Ominaisuus | Prioriteetti | Muuta |
+| :-: | :-: | :-: |
+| [Kurssitarjottimen kielivalinta](https://gitlab.labranet.jamk.fi/PRJTEAM-H/halinallet.gitlab.io/wikis/Ominaisuus-1:-Kurssitarjottimen-kielivalinta) | Matala | Puuttuu Fluidista |
+| [Autentikointi](https://gitlab.labranet.jamk.fi/PRJTEAM-H/halinallet.gitlab.io/wikis/Ominaisuus-2:-Autentikointi) | Normaali | |
+| [Kurssitarjottimen näkyvyys](https://gitlab.labranet.jamk.fi/PRJTEAM-H/halinallet.gitlab.io/wikis/Ominaisuus-3:-Kurssitarjonnan-n%C3%A4kyvyys) | Korkea | |
+| [Kurssitarjottimen suodattaminen](https://gitlab.labranet.jamk.fi/PRJTEAM-H/halinallet.gitlab.io/wikis/Ominaisuus-4:-Kurssitarjonnan-suodattaminen) | Korkea | |
+| [Tietojen tallentaminen](https://gitlab.labranet.jamk.fi/PRJTEAM-H/halinallet.gitlab.io/wikis/Ominaisuus-6:-Tietojen-tallentaminen) | Normaali | |
+| [Yhteenveto](https://gitlab.labranet.jamk.fi/PRJTEAM-H/halinallet.gitlab.io/wikis/Ominaisuus-7:-Yhteenveto) | Normaali |  |
+| [Käyttäjätyypit](https://gitlab.labranet.jamk.fi/PRJTEAM-H/halinallet.gitlab.io/wikis/Ominaisuus-8:-K%C3%A4ytt%C3%A4j%C3%A4tyypit) | Normaali | |
+| [Tulostaminen](https://gitlab.labranet.jamk.fi/PRJTEAM-H/halinallet/wikis/Ominaisuus-9:-HOPS:in-tulostaminen) | Normaali | Opiskelija voi tulostaa palvelun tarjoaman HOPS:in |
+
+
+
+## Julkaisun suunnitelma
+![roadmap](/uploads/a16588c67456a42b7614d0bcea4aee81/roadmap.PNG)
+[roadmap.xlsx](/uploads/3e3ea3b16b3abf8f974797103eed789b/roadmap.xlsx)
+
+
+| Aika | Ominaisuus | Kuvaus | Vastuu | Prioriteetti | Tila |
+|:-:|:-:|:-:|:-:|:-:|:-:|
+| %"Sprint 7" | [Kurssitarjonnan näkyvyys](https://gitlab.labranet.jamk.fi/PRJTEAM-H/halinallet/wikis/Ominaisuus-3:-Kurssitarjonnan-n%C3%A4kyvyys) | Sivuston pohja pystyssä, voi klikkailla ja katsoa asioita vaikka paljoa ei tapahdu | Projektiryhmä | 5 | OK |
+| %"Sprint 9" | [Kurssien suodatus](https://gitlab.labranet.jamk.fi/PRJTEAM-H/halinallet/wikis/Ominaisuus-4:-Kurssitarjonnan-suodattaminen) | Kursseja voi hakea | Projektitiimi | 5 | OK |
+| %"Sprint 9" | [Kurssien haku](https://gitlab.labranet.jamk.fi/PRJTEAM-H/halinallet/wikis/Ominaisuus-5:-Kurssin-hakeminen) | Kursseja voi hakea | Projektitiimi | 5 | OK |
+| %"Sprint 11" | [Autentikointi](https://gitlab.labranet.jamk.fi/PRJTEAM-H/halinallet/wikis/Ominaisuus-2:-Autentikointi) | Järjestelmää pääsee käyttämään JAMKin/tietokannan tunnuksilla | Projektitiimi | 5 | WIP |
+| %"Sprint 13" | [Tietojen tallentaminen](https://gitlab.labranet.jamk.fi/PRJTEAM-H/halinallet/wikis/Ominaisuus-6:-Tietojen-tallentaminen) | Tietojen tallentaminen | Projektitiimi | 2 | WIP |
+| %"Sprint 13" | [Yhteenveto](https://gitlab.labranet.jamk.fi/PRJTEAM-H/halinallet/wikis/Ominaisuus-7:-Yhteenveto) | Valintojen yhteenveto | Projektitiimi | 2 | |
+| %"Sprint 13" | [Kielivalinta](https://gitlab.labranet.jamk.fi/PRJTEAM-H/halinallet/wikis/Ominaisuus-1:-Kurssitarjottimen-kielivalinta) | Suomi ja englanti valittavissa | Projektitiimi | 2 | |
+| %"Sprint 14" | [Pisteiden laskeminen](https://gitlab.labranet.jamk.fi/PRJTEAM-H/halinallet/wikis/Ominaisuus-7:-Yhteenveto) | Järjestelmä ilmoittaa, paljonko pisteitä on ja paljonko niitä pitäisi olla | Projektitiimi | 5 | WIP |
+| %"Sprint 14" | Tulostaminen | Suunnitelman voi tulostaa | Projektitiimi | 5 | |
+
+
+
+# Palvelun/ohjelmiston arkkitehtuuri 
+
+### Yleinen sijoittelunäkymä (Deployment diagram )
+![diagrammi3](/uploads/5e37d1f09ddb96092b214d60230f3157/diagrammi3.JPG)
+
+
+# Arkkitehtuuriin/teknologiaan liityvät vaatimukset
+
+### Yleinen tietokantakuvaus (Database ER-diagram)
+
+ER-kaavio
+![tietokanta_final](/uploads/730eaab8f1f6a51730b8b89ec534908a/tietokanta_final.JPG)
+
+[Tekniseen dokumentaatioon](https://gitlab.labranet.jamk.fi/PRJTEAM-H/halinallet/wikis/Tekninen-dokumentaatio#tietokantakuvaukset)
+# Testauksen vaatimukset (Testing requirements)
+
+### Testattavuus
+
+| Id | Vaatimuksen kuvaus | Kategoria | Vastuullinen |
+|:-:|:-:|:-:|:-:|
+| TESTV001 | Käyttöliittymään toteutetaan Robot Frameworkia varten tarttumapinta | Testattavuus |  | 
+| TESTV002 | Palvelu pitää pystyä käynnistämään ilman, että se toimii testaajan koneessa | Testattavuus |  | 
+
+
+
+# Tunnistetut riskit ja testikohteet
+
+#### Riskit
+
+Projektin riskit löytyvät riskien hallintasuunnitelmasta.
+
+[Riskien hallintasuunnitelma](https://gitlab.labranet.jamk.fi/PRJTEAM-H/halinallet/wikis/Riskien-hallintasuunnitelma)
+
+#### Testikohteet
+
+| ID | Aiheuttaja | Kuvaus | Linkki | 
+|:-:|:-:|:-:|:-:| 
+| TID001 | TV001 | Toimiiko palvelu vain asianmukaisilla tunnuksilla | https://gitlab.labranet.jamk.fi/PRJTEAM-H/halinallet/wikis/Vaatimusmaaritelma#palveluun-liittyv%C3%A4t-toiminnalliset-vaatimukset-functional-requirements | 
+| TID002 | TV002 | Ulkoiseen käyttöön luotu avain toimii ja on kertakäyttöinen | https://gitlab.labranet.jamk.fi/PRJTEAM-H/halinallet/wikis/Vaatimusmaaritelma#palveluun-liittyv%C3%A4t-toiminnalliset-vaatimukset-functional-requirements | 
+| TID003 | TV003 | Palvelu hakee opiskelijan juuri hänen suorittamansa kurssit oikein | https://gitlab.labranet.jamk.fi/PRJTEAM-H/halinallet/wikis/Vaatimusmaaritelma#palveluun-liittyv%C3%A4t-toiminnalliset-vaatimukset-functional-requirements | 
+| TID004 | TV005 | Voiko kyselyyn vastata vain kerran | https://gitlab.labranet.jamk.fi/PRJTEAM-H/halinallet/wikis/Vaatimusmaaritelma#palveluun-liittyv%C3%A4t-toiminnalliset-vaatimukset-functional-requirements | 
+| TID005 | TV006 | Laskeeko palvelu opintopisteiden määrän oikein | https://gitlab.labranet.jamk.fi/PRJTEAM-H/halinallet/wikis/Vaatimusmaaritelma#palveluun-liittyv%C3%A4t-toiminnalliset-vaatimukset-functional-requirements | 
+| TID006 | TV007 | Valitseeko palvelu opiskelijalle oikeasti pakolliset opinnot | https://gitlab.labranet.jamk.fi/PRJTEAM-H/halinallet/wikis/Vaatimusmaaritelma#palveluun-liittyv%C3%A4t-toiminnalliset-vaatimukset-functional-requirements | 
+| TID007 | TV008 | Voivatko käyttäjät vaihtaa vastaustaan vain kerran lukuvuodessa | https://gitlab.labranet.jamk.fi/PRJTEAM-H/halinallet/wikis/Vaatimusmaaritelma#palveluun-liittyv%C3%A4t-toiminnalliset-vaatimukset-functional-requirements |