Treenitietokannan suunnitteludokumentti

Transkriptio

1 Treenitietokannan suunnitteludokumentti 1 Johdanto 1.1 Järjestelmän tarkoitus Järjestelmän tarkoituksena on luoda Yliopiston Taido Ry:n treenien vetäjille ja treeneissä kävijöille toimiva ympäristö, jossa vetäjät voivat helposti lisätä kuvauksia ja aiheita omille treeneille sekä tarvittaessa lisätä yleisiä tapahtumia (mm. leirejä, kilpailuja, yms.) tietyille päiville kalenteriin. Myös treenien muokkauksen tulee olla vaivatonta ja se tulee olemaan järjestelmän pääsääntöinen käyttötarkoitus, sillä ylläpidon tehtävänä on hoitaa geneeriset harjoitustiedot scriptin kautta tietokantaan puolen vuoden välein, kun uudet syksy-kevät- tai kesätreeniajat ovat tiedossa. Lisäksi tietojen pitää olla helposti luettavassa ja havainnollisessa muodossa esillä seuran sivuilla, jotta muut treeneissä kävijät näkevät mahdolliset aiheet, muutokset harjoitusajoissa sekä vuorojen peruutukset selkeästi ja nopeasti. Mahdollisista peruutuksista ja aikamuutoksista tiedotetaan myös seuran postituslistalla, mutta treenitietokannassa ne ovat pysyvästi esillä. 1.2 Toimintaympäristö Järjestelmän toimintaympäristöksi tulee suomalaisen internetpalveluja tarjoavan Kapsi Internetkäyttäjät Ry:n Lakka-palvelin. Tietokanta sijoitetaan erilliselle Puolukka-palvelimelle, jolle on yhteys Lakka-palvelimelta. 1.3 Rajaukset Tietokannasta tulee kurssin puitteissa kohtuu suppea, mutta tulevaisuudessa tarkoituksena on lisätä tietokantaan muutakin tietoa seuran toimintaan liittyen. 1.4 Toteutusympäristö Järjestelmä toteutetaan Helsingin Yliopiston Tietojenkäsittelytieteen laitoksen Users-palvelimella ja siihen on mahdollista päästä tutustumaan osoitteessa:

2 2 Yleiskuva järjestelmästä 2.1 Sidosryhmäkaavio 2.2 Käyttäjäryhmät Kuka tahansa alla olevien ryhmien jäsen voi kuulua myös muihin ryhmiin. Taidon harrastaja: Treenien vetäjä: Yliopiston taidon sihteeri ja ilmoittaja: Ylläpito: Katsovat treenitietoja, mahdollisia muutoksia aikatauluissa sekä muita treeneihin vaikuttavia tekijöitä. Lisää treenejä, muuttaa omien treenien tietoja. Lisää mahdollisia poikkeuksia ja muita tapahtumia. Lisää ja poistaa treenejä, muuttaa treenien tietoja, lisää tapahtumia ja poikkeuksia sekä muokkaa ja lisää järjestelmän ominaisuuksia.

3 3 Käyttötapaukset Treenikalenterin katselu Sidosryhmät: Kaikki Tavoite: Saada informaatiota treeneistä Käyttötapauksen kulku: Käyttäjä tulee sivuille, selaa itsensä treenikalenteri näkymään ja tarkastelee treenejä viemällä hiiren osoittimen treenipäivää vastaavalle treenikalenterin taulukon riville. Treenitiedot tulevat esiin treenikalenterin sivuun erilliseen jquery-javascript-kirjaston cluetipnäkymään. Harjoitustietojen muutos Sidosryhmät: Ylläpito, vetäjät, sihteeri, seuran ilmoittaja Tavoite: Muuttaa harjoituksen tiedot vastaamaan toivetta Käyttötapauksen kulku: Käyttäjä tulee sivuille, kirjautuu sisään treenitietokantaan ja valitsee 'muokkaa harjoitusta'-kohdan tietokannan valikosta. Käyttäjä valitsee haluamansa treenin treeninäkymästä, jolloin treenin tiedot ilmestyvät sivun alalaitaan. Käyttäjä muuttaa haluamansa tiedot ja lähettää tiedot lomakkeella eteenpäin. Harjoituksen lisäys: Sidosryhmät: Ylläpito, vetäjät Tavoite: Lisätä uusi harjoitusaika treenikalenteriin Käyttötapauksen kulku: Käyttäjä tulee sivuille, kirjautuu sisään treenitietokantaan ja valitsee 'lisää harjoitus'-kohdan tietokannan valikosta. Käyttäjä ilmoittaa haluamansa päivämäärän, jolloin sivulle ilmestyy näkymä harjoitustiedoista ja ehdotukset valmiista, normaaleista treeniajoista, jos sellaisia päivälle on. Käyttäjä asettaa harjoitustiedot haluamikseen ja lähettää tiedot talletettavaksi tietokantaan. Tapahtuman lisäys / muokkaus Sidosryhmät: Ylläpito, sihteeri, seuran ilmoittaja Tavoite: Lisätä uusi tapahtuma treenikalenteriin Käyttötapauksen kulku: Käyttäjä tulee sivuille, kirjautuu sisään treenitietokantaan ja valitsee 'lisää / muokkaa tapahtumaa'-kohdan tietokannan valikosta. Käyttäjä ilmoittaa haluamansa päivämäärän, jolloin sivulle ilmestyy näkymä tapahtumatiedoista, jos sille päivälle on jo merkitty tapahtuma tietokantaan, jos tapahtumaa ei ole niin tekstikentässä lukee 'Lisää tapahtuma'. Käyttäjä asettaa tapahtumatiedot haluamikseen ja lähettää ne talletettavaksi tietokantaan. Jos aikaisempi tapahtuma pyyhitään ruudulta ja lähetetään tyhjä tekstikenttä, niin sen päivän tapahtuma tuhotaan tietokannasta.

4 4 Järjestelmän tietosisältö 4.1 Tietokohteet Tagi TagID Serial Tunniste Nimi Varchar Tagit ovat harjoituksille annettavia geneerisiä sisältömerkkejä. Niiden on tarkoitus lähinnä helpottaa tilastollista seurantaa ja tarjota vetäjille nopea tapa identifioida harjoituksiaan edes jotenkin, jos ei halua kirjoittaa pitempää kuvausta. Harjoitus HarjoitusID Serial Tunniste Pvm Timestamp Päivämäärä ja harjoituksen alkamisaika Pvm_loppu Timestamp Päivämäärä ja harjoitukset oppumisaika Kurssi Int 0 = värillisten harjoitus, 1 = kurssin harjoitus Harjoitus on tietokannan pääasiallinen tietosisältö ja kaikki muut tietokohteet liittyvät tapahtumia lukuunottamatta suoraan joko yhteen tai useampaan harjoitukseen.

5 Harjoitusaihe / Simo Linkola / Suunnitteludokumentti / Tietokantasovellus S2010 / TKTL / HY Aihe Text Vapaa tekstikuvailu harjoituksen teemoista. Aihe on tagia yksilöllisempi harjoituksen määritelmä. Harjoituksella voi olla maksimissaan vain yksi aihe Vetäjä HenkiloID Serial Tunniste Nimi Varchar Aktiivisuus Varchar 'Kyllä' tai 'Ei'. Harjoituksella on yksi vetäjä. Vetäjiksi tässä yhteydessä lasketaan myös 'Ei vuoroa' ja 'Vapaa'. Aktiivisuus kertoo, onko vetäjä tällä hetkellä aktiivisena vetämässä treenejä vai esim. työkiireiden vuoksi poissa seuran toiminnasta. Vanhat vetäjät asetetaan epäaktiivisiksi, eikä poisteta tietokannasta, vaikka he olisivat 'eläköityneet' lajin parista. Näin heidän vetovuoronsa näkyvät kalenterissa vielä vuosien päästäkin Tapahtuma pvm Timestamp Päivämäärä ja kellonaika 00:00:00 pvm_loppu Timestamp Päivämäärä ja kellonaika 23:59:59 Huom Text Vapaa tekstikuvailu tapahtumasta. Myös yleiset huomiot harjoituksiin liittyvistä asioista tulevat tähän tauluun. Tapahtumat liittyvät harjoituksiin olemalla samaan aikaan (siis samana päivänä). Ne sisältävät kaikki muut - harjoituksiin suoranaisesti liittymättömät - Taidoon liittyvät asiat, joita päivälle osuu. Myös poikkeuksellisista treenipaikoista voidaan esittää tieto täällä, kuin myös harjoituksen aiheessa. (Normaalisti käytössä on vain yksi treenisali, mutta esim. kesällä 2010 se oli suljettuna remontin vuoksi, joten vaihtoehtoisia harjoituspaikkoja jouduttiin luomaan.) Harjoitusaika alku Time Harjoituksen alkamisaika loppu Time Harjoituksen loppumisaika viikonpva Int Viikonpäivä, jolle harjoitus sijoittuu (1= Ma, 7 = Su) voimassa_alku Timestamp Ensimmäinen päivä, jolloin harjoitusaika on voimassa voimassa_loppu Timestamp Ensimmäinen päivä, jolloin harjoitusaika ei ole voimassa Kuten kaaviosta huomaa, harjoitusaika tarkoittaa normaaleja harjoitusvuoroja, jotka ovat toistuvasti joka viikko samat pitemmän ajanjakson. Jokaisella harjoituksella on toki jokin aika, mutta ei välttämättä tällaista normaalia harjoitusaikaa.

6 5 Käyttöliittymän hahmotelma Treenikalenterinäkymä on kaikille sidosryhmille saataville oleva näkymä ja tietokannan sisällön pääasiallinen esitysmuoto. Treenikalenterissa on kolme eri näkymää. 'Kaikki', 'Värilliset' ja 'Kurssi'. 'Kaikki' -näkymässä näkyvät sekä värillisten että kurssin treenit rinnakkain. Muissa vain omansa. Kaikissa näkymissä näkyvät erikseen myös jokaiselle päivälle merkityt erilliset tapahtumat. Tietokantavalikko toimii pääasiallisena sivunäyttönä ja sen alle avautuvat kaikki alinäkymät, joiden lomakekentät vaihtelevat näkymän mukaan. Yleensä tietojen lähetyksen jälkeen sivu palaa tietokantavalikon perusnäkymään, joissakin tapauksissa käytetään testi- ja oppimistarkoituksessa myös muita toimintatapoja. Lisäksi mihin tahansa muuhun valikon alinäkymään pääsee mistä tahansa muusta alinäkymästä, koska itse valikko säilyy näkyvillä sivun yläosassa.

7 6 Tietokannan Create Table -lauseet Päätaulu, määrittelee harjoitusten geneeriset ominaisuudet, ajat ja vetäjät. CREATE TABLE tk_harjoitukset ( harjoitusid serial primary key, pvm timestamp NOT NULL, // harjoitusten alkuaika pvm_loppu timestamp NOT NULL, // harjoitusten loppuaika henkiloid int NOT NULL, // vetäjän henkiloid kurssi int, // onko harjoitus kurssin vai ei, default 0 (= ei) FOREIGN KEY (henkiloid) REFERENCES (tk_vetajat)); Taulu vetäjien nimille ja henkiloid:lle CREATE TABLE tk_vetajat ( henkiloid serial primary key, nimi varchar NOT NULL) ; Taulu mahdollisille tageille jotka liitetään liitostaululla harjoituksiin. CREATE TABLE tk_tagit ( tagid serial primary key, nimi varchar NOT NULL); Liitostaulu tageille ja harjoituksille. CREATE TABLE tk_harjoitustagit ( tagid int NOT NULL, harjoitusid int NOT NULL, FOREIGN KEY (tagid) REFERENCES (tk_tagit), FOREIGN KEY (harjoitusid) REFERENCES (tk_harjoitukset)) ; Taulu vapaille harjoitusaiheiden tekstiselotuksille. CREATE TABLE tk_harjoitusaiheet ( harjoitusid int NOT NULL, aihe text NOT NULL, // vapaa tekstikuvailu harjoitukselle FOREIGN KEY (harjoitusid) REFERENCES (tk_harjoitukset), primary key harjoitusid); // vain yksi tekstikuvaus / harjoitus! Taulu muille tapahtumille. CREATE TABLE tk_tapahtumat ( pvm timestamp primary key, // tapahtuman alku aina kello pvm_loppu timestamp NOT NULL, // tapahtuman loppu aina huom text NOT NULL); // vapaa tekstikuvailu tapahtumalle Taulu normaaleille harjoitusajoille. Myös muut ajat sallitaan tk_harjoitukset-taulussa, mutta nämä ovat oletuksena järjestelmän ehdotuksissa. CREATE TABLE tk_harjoitusajat ( viikonpva int NOT NULL, alku timestamp NOT NULL, // alkamisaika esim loppu timestamp NOT NULL, // loppumisaika esim voimassa_alku timestamp NOT NULL, // ensimmäinen voimassa olo pvm voimassa_loppu timestamp NOT NULL, // ensimmäinen päivä jolloin ei voimassa. primary key (viikonpva, alku, loppu, voimassa_alku, voimassa_loppu));

8 Näkymä kurssin harjoituksille. CREATE VIEW kurssi AS SELECT pvm, pvm_loppu, nimi, harjoitusid, henkiloid, aihe FROM tk_harjoitukset LEFT JOIN tk_vetajat USING (henkiloid) LEFT JOIN tk_harjoitusaiheet USING (harjoitusid) WHERE kurssi = 1 ORDER BY pvm ASC; Näkymä värillisten vöiden harjoituksille. CREATE VIEW varilliset AS SELECT h_pvm.pvm, h_pvm.pvm_loppu, nimi, harjoitusid, henkiloid, aihe FROM (SELECT pvm, pvm_loppu FROM tk_harjoitukset WHERE kurssi = 0) AS h_pvm LEFT JOIN (SELECT * FROM tk_harjoitukset WHERE kurssi = 0) AS h USING (pvm) LEFT JOIN tk_vetajat USING (henkiloid) LEFT JOIN tk_harjoitusaiheet USING (harjoitusid) ORDER BY pvm ASC; Kummatkin harjoitukset rinnakkain näkymänä. CREATE VIEW rinnakkain AS SELECT pvm, pvm_loppu, v.nimi AS v_nimi, v.harjoitusid AS v_harjoitusid, v.henkiloid AS v_henkiloid, v.aihe AS v_aihe, k.nimi AS k_nimi, k.harjoitusid AS k_harjoitusid, k.henkiloid AS k_henkiloid, k.aihe AS k_aihe FROM varilliset AS v FULL JOIN kurssi AS k USING (pvm, pvm_loppu);