Jussi Kähkönen
Copyright ©2002 Joensuun yliopisto
Tietojenkäsittelytieteen laitos

Sisällys

1 Ohjelman käyttö
  1.0 Vaatimusmäärittelyn luominen
  1.1 Käynnistäminen
  1.2 Vaatimusmäärittelyn avaaminen
  1.3 Vaatimuksen lisääminen
  1.4 Vaatimuksen muokkaaminen
  1.5 Vaatimuksen poistaminen
  1.6 Vaatimusten tallentaminen
  1.7 Raporttien luominen
  1.8 Ohjelman lopettaminen
  1.9 Työryhmäkäyttö

2 Ohjelman toiminnot
  2.1 Pääikkunan hierarkinen sisällysluettelo
  2.2 Tiedosto -valikko
      2.2.1 Avaa
      2.2.2 Tallenna
      2.2.3 Raportti luo
      2.2.4 Raportti avaa
      2.2.5 Sulje
      2.2.6 Lopeta
  2.3 Vaatimus -valikko
      2.3.1 Lisää
      2.3.2 Muokkaa
      2.3.3 Muuta järjestystä
      2.3.4 Muuta sijaintia
  2.4 Asetukset -valikko
      2.4.1 Oletuseditori
      2.4.2 Oletusselain
      2.4.3 Kieli
  2.5 Yleistiedot -valikko
      2.5.1 Muokkaa
  2.6 Ohje-valikko
      2.6.1 Ohje
      2.6.2 Tietoja ohjelmasta
  2.7 Vaatimusikkuna
      2.7.1 ID-tunnus
      2.7.2 Nimi
      2.7.3 Kuvaus
      2.7.4 Yhteydet
      2.7.5 Lyhyt teksti
      2.7.6 Pitkä teksti
      2.7.7 Luokitus
      2.7.8 Poista
      2.7.9 Tallenna
      2.7.10 Sulje
  2.8 Raportti-ikkuna
      2.8.1 Raportin nimi
      2.8.2 Yleistiedot
      2.8.3 Raportin esitystapa
      2.8.4 Vaatimusten valintaperusteet
      2.8.5 Valituista vaatimuksista esitettävät tiedot
      2.8.6 Tyhjennä tiedot
      2.8.7 Luo
      2.8.8 Sulje

3 Tiedostojen käsittely
  3.1 Vaatimusmäärittelyn hierarkinen sisällysluettelo (.rmh)
  3.2 Vaatimuksen tietosisällön määrittelytiedosto (.rmc)
  3.3 Vaatimusten tallennustiedosto (.rmd)
  3.4 Yleistiedot (.rmg)
  3.5 Käyttäjäkohtaiset oletusasetukset (.rms)

4 Ohjelman asentaminen

Esittely

1 Ohjelman käyttö

Tiedostojen luomisesta ja rakenteesta on kerrottu enemmän kohdissa 3.1 - 3.5 sekä ohjelman asentamisesta ja tiedostojen sijoittamisesta hakemistoihin on kerrottu kohdassa 4.

1.1 Käynnistäminen

Unix/Linux:
Käynnistä ohjelma kirjoittamalla komentoriville:

     wish sfrm.tcl &

     sfrm.tcl &

Ohjelman käynnistyksen yhteydessä ohjelma lukee oletusasetustiedostosta käyttäjäkohtaisia asetuksia. Jos tiedoston lukemisessa tapahtuu virhe, tai käyttäjälle ei ole määritelty kyseistä tiedostoa (ks. 3.5), ohjelma antaa virheilmoituksen.

1.2 Vaatimusmäärittelyn avaaminen

1.3 Vaatimuksen lisääminen

Ohjelma avaa uuden vaatimusikkunan ja hakee uudelle vaatimukselle ID-tunnisteen. Jos käyttäjälle ei ole määritelty tähän vaatimusmäärittelyyn käytössä olevia vaatimusnumeroita (ks. 3.5) tai kaikki määritellyt vaatimusnumerot on jo käytetty, ohjelma antaa virheilmoituksen. Vaatimusikkunassa voit määrittää haluamasi tiedot.

Vaatimusikkuna. Kentät ID-tunnus, nimi, kuvaus ja yhteydet ovat samanlaisia kaikissa vaatimusmäärittelyissä. Tässä muut kentät ovat vain esimerkkejä ja ikkunan todellinen ulkoasu riippuu siitä, kuinka vaatimusmäärittely on määritelty (ks. 3.2).

Ainoastaan Nimi -kenttä on pakollinen täyttää ennen tallentamista. Luokituksissa on oletuksena valittuna ensimmäinen vaihtoehto. Useamman rivin pitkiä tekstikenttiä voit halutessasi muokata myös määrittelemässäsi editorissa napsauttamalla kyseisen tekstikentän vieressä olevaa Avaa editoriin –painiketta. Lisää kirjoittamaasi tekstiin myös haluamasi HTML-kieliset ohjausmerkit, sillä raporttia luotaessa ohjelma ei lisää tekstin sisälle mitään merkintöjä. HTML:ää käyttämällä voit liittää tekstiin myös esimerkiksi taulukoita tai kuvia. Tällöin on huolehdittava siitä, että kyseiset tiedostot sijaitsevat määrittelemässäsi hakemistossa.

Yhteydet -kentässä voidaan näyttää niiden vaatimusten nimet, joihin tästä vaatimuksesta on jokin asiayhteys tai sivuvaikutus. Yhteys on luonteeltaan yksisuuntainen, eikä ohjelma lisää automaattisesti käsiteltävää vaatimusta sen vaatimuksen yhteyksiin, johon tässä määritellään yhteys. Yhteyksistä on kerrottu tarkemmin kohdassa 2.7.4. Uutta vaatimusta lisättäessä kenttä on aluksi tyhjä. Voit lisätä yhteyksiä napsauttamalla Muokkaa –painiketta. Ohjelma avaa muokka yhteyksiä –ikkunan, jonka vasemman puoleisessa listassa näkyvät kaikkien ohjelmaan aikaisemmin lisättyjen vaatimusten nimet. Valitse listasta haluamasi vaatimus ja napsauta Lisää yhteys –painiketta. Lisätyt vaatimukset näkyvät oikeanpuoleisessa listassa. Ennen ikkunan sulkemista tallenna yhteydet napsauttamalla Tallenna –painiketta, jolloin ohjelma lisää valitsemasi yhteydet myös vaatimusikkunan Yhteydet –kenttään.

Kun olet antanut kaikki haluamasi tiedot napsauta vaatimusikkunan Tallenna –painiketta, jolloin ohjelma tallentaa tiedot, lisää vaatimuksen nimen pääikkunan sisällysluetteloon valitsemaasi paikkaan ja aktivoi vaatimuksen näyttäen sen taustaltaan vaalean punaisena.

Ohjelmassa voi olla yhtä aikaa auki useita vaatimuksia. Ohjelma näyttää aktiivisen vaatimuksen ikkunan otsikkorivin korostettuna. Voit vaihtaa aktiivista vaatimusta napsauttamalla osoittimella haluamasi vaatimusikkunan päällä, jolloin ohjelma muuttaa sen päällimmäiseksi ja korostaa sen. Ohjelma näyttää myös aktiivisen vaatimuksen nimen korostettuna pääikkunassa. Jos vaatimus on uusi ja sitä ei ole vielä tallennettu, ohjelma näyttää pääikkunassa korostettuna otsikon, jonka alle vaatimus lisätään. Kun vaatimus aktivoidaan, ohjelma avaa tarvittaessa vaatimuksen sijainnin mukaiset hierarkiatasot näkyviin.

Jos haluat sulkea vaatimusikkunan tallentamatta vaatimusta, napsauta Sulje –painiketta, ja vastaa ohjelman varmistuskysymykseen napsauttamalla Ei -painiketta.

1.4 Vaatimuksen muokkaaminen

1.5 Vaatimuksen poistaminen

1.6 Vaatimusten tallentaminen

1.7 Raporttien luominen

1.8 Ohjelman lopettaminen

1.9 Työryhmäkäyttö

Työryhmäkäytössä on vaatimusmäärittelyä laadittaessa huomioitava seuraavat seikat. Kaikilla työryhmän jäsenillä on oltava käytössään identtiset vaatimusmäärittelyn asetustiedostot (.rmh ja .rmc) sekä omat henkilökohtaiset oletusasetustiedostot (.rms) (ks. 3.1, 3.2, 3.5). Henkilökohtaisia oletusasetustiedostoja laadittaessa on olennaisen tärkeää se, että kaikille jäsenille annetaan keskenään erilaiset numerosarjat vaatimusten alku- ja loppunumeroiden avulla. Tiedostoja laadittaessa on arviotava myös lisättävien vaatimusten kokonaismäärää ja asetettava numerosarjat niin suuriksi, jotta käytössä on riittävästi numeroita lisättäville vaatimuksille.

Erilliset vaatimusten tallennustiedostot voidaan yhdistää yhdeksi kokonaisuudeksi seuraavasti:

Unix/Linux-järjestelmissä esim. komennolla cat seuraavasti:

     cat vm1.rmd vm2.rmd vm3.rmd > vm.rmd

     copy /a vm1.rmd + vm2.rmd + vm3.rmd vm.rmd /v

2 Ohjelman toiminnot

Pääikkunan sisällysluettelo on rakenteeltaan hierarkinen, jossa sen otsikot voivat sijaita toistensa suhteen eri tasoilla. Voit halutessasi sulkea valitsemasi tason tiedot, jolloin ohjelma näyttää vain seuraavan, ylemmän tason otsikon nimen. Kun avaat vaatimusmäärittelyn, ohjelma näyttää luettelon kaikkien tasojen tiedot. Hierarkista rakennetta kuvataan otsikkorivin edessä olevalla nuolella. Jos otsikon alla ei ole piilossa olevia aliotsikoita tai vaatimuksia, rivillä näytetään pelkästään otsikon tai vaatimuksen nimi. Jos otsikon kaikki seuraavan tason aliotsikot ja vaatimukset ovat näkyvissä, rivin edessä on punainen alaspäin osoittava nuoli (). Jos otsikon alla on piilotettuja aliotsikoita tai vaatimuksia, rivin edessä on sininen, oikealle osoittava nuoli (). Voit avata näkyviin seuraavan tason otsikot napsauttamalla haluamasi otsikon sinisestä nuolesta. Vastaavasti voit sulkea tason näkyvyyden napsauttamalla haluamasi tason punaisesta nuolesta

Sisällysluettelon rivin laatua kuvaa myös valitun rivin taustaväri. Jos valittu rivi on vaatimuksen nimi, sen taustaväri on vaalean punainen. Vaatimus sijaitsee aina alimmalla tasolla hierarkiassa. Sen alle ei voi lisätä uusia vaatimuksia. Mutta valittua vaatimusta voidaan muokata monin tavoin (ks. 2.3.2 – 2.3.4). Alimman tason otsikon taustaväri valittuna on vaalean vihreä. Vaatimuksia voidaan lisätä vain alimman tason otsikon alle (ks. 2.3.1). Kaikkien muiden, hierarkiassa ylemmällä tasolla olevien otsikoiden taustaväri valittuna on harmaa. Tällaisten otsikoiden alle ei voi lisätä vaatimuksia, koska hierarkinen rakenne on määritelty etukäteen erillisessä asetustiedostossa (ks. 3.1).

Pääikkuna.

2.2 Tiedosto -valikko

2.2.2 Tallenna

Mikäli ohjelmassa on avoimia vaatimuksia, joiden muutettuja tietoja ei ole tallennettu, ohjelma kysyy ensin luvan niiden tallentamiseen. Uusien, ohjelman käyttömuistiin tallentamattomien vaatimusten tietoja ei tallenneta tiedostoon. Ohjelma antaa tällöin ilmoituksen ja pyytää ensin tallentamaan nämä vaatimukset (ks. 2.7.9) ja valitsemaan sen jälkeen tämän käskyn Tiedosto/Tallenna uudelleen.

Mikäli komentoa valittaessa ei ole avattuna vaatimusmäärittelyä, ohjelma antaa virheilmoituksen ja huomauttaa, että vaatimusta ei suoritettu, koska vaatimusmäärittelyä ei ole avattuna .

2.2.3 Raportti luo

Mikäli komentoa valittaessa ei ole avattuna vaatimusmäärittelyä, ohjelma antaa virheilmoituksen ja pyytää ensin avaamaan jonkin vaatimusmäärittelyn.

2.2.4 Raportti avaa

2.2.5 Sulje

2.2.6 Lopeta

Mikäli vaatimusmäärittelyä ei ole avattuna, olet valinnut vaatimuksen (valittuna punainen tausta) tai valitsemasi otsikko ei ole alimman tason otsikko (valittuna harmaa tausta), ohjelma antaa virheilmoituksen.

Voit avata uuden vaatimuksen myös osoittimen kaksoisnapsautuksella haluamasi otsikon päällä pääikkunassa.

2.3.2 Muokkaa

Ohjelma avaa tai nostaa päällimmäiseksi jo avoimen vaatimusikkunan ja näyttää siinä valitun vaatimuksen tiedot. Voit muokata ikkunassa tietoja haluamallasi tavalla. Vaatimusikkunan toiminnot on kerrottu tarkemmin kohdassa '2.7 Vaatimusikkuna'.

Mikäli vaatimusmäärittelyä ei ole avattuna tai olet valinnut otsikon, ohjelma antaa virheilmoituksen.

Voit avata vaatimuksen muokattavaksi myös osoittimen kaksoisnapsautuksella haluamasi vaatimuksen päällä pääikkunassa.

2.3.3 Muuta järjestystä

2.3.4 Muuta sijaintia

Mikäli vaatimusmäärittelyä ei ole avattuna tai olet valinnut otsikon, ohjelma antaa virheilmoituksen.

Vaatimuksen sijainnin muuttaminen -ikkuna.

2.4 Asetukset -valikko

2.4.2 Oletusselain

2.4.3 Kieli

2.5 Yleistiedot -valikko

Voit halutessasi muokata tekstiä avaamalla sen määrittelemääsi oletuseditoriin (ks. 2.4.1) napsauttamalla Avaa editoriin -painiketta.

Yleistiedot -ikkuna.

2.6 Ohje-valikko

2.6.2 Tietoja ohjelmasta

2.7 Vaatimusikkuna

Vaatimusikkunassa näytetään kaikki ne tiedot, joita jokaiseen vaatimusmäärittelyn vaatimukseen voidaan liittää. Kaikissa vaatimusmäärittelyissä yhteisiä tietoja ovat ID-tunnus, nimi, kuvaus ja yhteydet. Kaikki muut vaatimuksesta esitettävät tiedot on määritelty erillisessä tiedostossa, joka on vaatimusmäärittelykohtainen. Tiedostossa määritellyt tiedot voivat olla tyypiltään lyhyt teksti, pitkä teksti ja luokitus. Lyhyt teksti on yhden rivin mittainen tekstikenttä. Pitkä teksti voi sisältää useampia rivejä tekstiä, eikä sen pituutta ole rajoitettu. Luokitustyyppisessä tiedossa voidaan valita yksi arvo, joka parhaiten kuvaa kyseistä vaatimusta. Vaatimuksen tietosisällön määrittelytiedoston laatimisperusteista ja sisällöstä on kerrottu tarkemmin kohdassa 3.2.

Vaatimusikkuna.

2.7.1 ID-tunnus

2.7.2 Nimi

2.7.3 Kuvaus

Koska kuvaus-kentän sisältö on HTML-koodia, voit liittää tekstiin myös kuvia. Tällöin joudut kuitenkin huolehtimaan järjestelmän ulkopuolisin tiedostonhallintamenetelmien avulla, että määrittelemäsi kuvatiedostot sijaitsevat määritellyissä hakemistoissa. Myös mahdollinen kuvankäsittely on tehtävä järjestelmän ulkopuolisten sovellusohjelmien avulla.

2.7.4 Yhteydet

Toisensuuntaiset yhteydet voidaan tulostaa raportin valintaehtojen avulla (ks. 2.8). Saat seuraavien toimenpiteiden avulla raporttina luettelon niiden vaatimusten nimistä, joiden Yhteydet -kentään haluamasi vaatimus on lisätty: Valitse Raportin luominen -ikkunassa raportin esitystavaksi 'Vaatimusten luettelo' ja vaatimusten valintaperusteeksi 'Yhteydet' sekä kirjoita viereiseen tekstikenttään valintaehdoksi haluamasi vaatimuksen nimi (tässä esimerkkinä: '4.1.7 Poista vaatimus'). Kun seuraavaksi napsautat Luo-painiketta ja avaat raportin selaimeen, saat luettelon vaatimuksista, joiden Yhteydet-kentään on lisätty vaatiumus '4.1.7 Poista vaatimus'.

Voit avata Yhteydet -kentässä olevan vaatimuksen osoittimen kaksoisnapsautuksella nimen päällä.

2.7.5 Lyhyt teksti

2.7.6 Pitkä teksti

2.7.7 Luokitus

2.7.8 Poista

2.7.9 Tallenna

2.7.10 Sulje

2.8 Raportti-ikkuna

Raportin luominen –ikkunassa voit määritellä perusteet, joiden mukaisesti raportti muodostetaan. Valintaehtojen avulla voit sekä rajoittaa raporttiin mukaan otettavia vaatimuksia että vaatimuksista tulostettavia tietoja. Jokaisen raportin alkuun tulostetaan sekä yleistiedot että raportin muodostamisperusteet, jotka määrittelet tässä ikkunassa.

Raportti-ikkuna.

2.8.1 Raportin nimi

2.8.2 Yleistiedot

2.8.3 Raportin esitystapa

Valitsemalla 'Vaatimusten luettelo' (esimerkki liitteenä), raportissa esitetään vaatimukset aakkosjärjestyksessä luettelona ilman otsikkoja. Myös tässä tulostetaan vain valintaehdot täyttävät vaatimukset ja tiedot.

2.8.4 Vaatimusten valintaperusteet

2.8.5 Valituista vaatimuksista esitettävät tiedot

2.8.6 Tyhjennä tiedot

2.8.7 Luo

Selaimessa voit tarkastella raporttia sekä halutessasi voit tulostaa raportin myös paperille. Voit avata raportin myös myöhemmin valitsemalla pääikkunassa Tiedosto/Raportti/Avaa (ks. 2.2.4).

Raportti avattuna selaimeen. Näkyvissä raportin muodostamisperusteet ja valintaehdot täyttävien vaatimusten nimet luettelona. Kohdassa 'Valituista vaatimuksista esitettävät tiedot' on valittuna ainoastaan (oletuksena oleva) kohta 'Nimi'.

2.8.8 Sulje

3 Tiedostojen käsittely

<-- sfrm-hierarchy -->
<-- tämä tiedosto on esimerkki -->
<-- vaatimusmäärittelyn sisällysluettelon -->
<-- hierarkian määrittämisestä -->

<otsikko1>
4 Toiminnallisuus
</otsikko1>
<otsikko2>
4.1 Toimintovaatimukset
</otsikko2>
<otsikko2>
4.2 Yhteensopivuus
</otsikko2>
<otsikko2>
4.3 Sovellusalueen standardien noudattaminen
</otsikko2>
<otsikko2>
4.4 Turvallisuus
</otsikko2>
<otsikko2>
4.5 Toimintaympäristö
</otsikko2>
<otsikko1>
5 Luotettavuus
</otsikko1>
<otsikko1>
6 Käytettävyys
</otsikko1>
...

• Ensimmäisen rivin on oltava yllä olevassa muodossa, jotta ohjelma tunnistaa tiedoston vaatimusmäärittelyn hierarkiatiedostoksi.
• Voit lisätä kommenttirivejä

  <--        -->

  merkkien väliin.
• Sisällysluettelon yksi rivi käsittää alku- ja lopputunnisterivit

  <otsikkoX> ja </otsikkoX>

  sekä niiden väliselle riville kirjoitettavan varsinaisen sisällysluettelon tekstirivin. Tunnisterivien toiseksiviimeinen merkki (X) on oltava numero väliltä 1 – 9 ja se kuvaa rivin hierarkista tasoa sisällysluettelossa. Tunnuksella 1 olevat sisällysluettelorivit ovat siis sisällysluettelossa pääotsikoita ja tunnuksella 2 olevat rivit ovat edellisten alaotsikoita jne. Ohjelmassa vaatimuksia voidaan lisätä vain luettelon hierarkian alimmille tasoille, jotta tässä tiedostossa määritellyn hierarkian eheys säilyy. Sisällysluetteloon sijoitettavien rivien lukumäärää ei ole rajoitettu. Hierarkiatasoja voi olla enintään yhdeksän.

3.2 Vaatimuksen tietosisällön määrittelytiedosto (.rmc)

<-- sfrm-contents -->
<-- tämä tiedosto on esimerkki -->
<-- vaatimuksen sisältämien tietojen määrittelystä -->

<tekstiL>
Laatija
<tekstiL>

<tekstiP>
Muutoshistoria
</tekstiP>

<luokitus>
Vaatimuksen tila
3
Ehdotettu
Hyväksytty
Hylätty
<perusteet>
Vaatimuksen tila –luokituksen valinta tehdään seuraavien ominaisuuksien perusteella: 

Ehdotettu: 
Tekstiä ...

Hyväksytty: 
Tekstiä ...

Hylätty: 
Tekstiä ...
</perusteet>
</luokitus>

• Ensimmäisen rivin on oltava yllä olevassa muodossa, jotta ohjelma tunnistaa tiedoston vaatimusten tietosisällön määrittelytiedostoksi.
• Voit lisätä kommenttirivejä

  <--        -->

  merkkien väliin.
• Lyhyt teksti on yhdelle riville kirjoitettava tieto. Sen alkutunnisteena on

  <tekstiL>

  ja lopputunnisteena

  <tekstiL>

  Vaatimuksen osatietoa kuvaava nimi kirjoitetaan tunnisteiden väliselle riville.
• Pitkä teksti on pituudeltaan rajoittamaton usalle riville sijoitettava teksti. Sen tunnisteina ovat

  <tekstiP> ja <tekstiP>

  Lyhyen tekstin tapaan osatiedon nimi kirjoitetaan Tunnisteiden väliselle riville.
• Luokituksen alkutunnisteena on

  <luokitus>

  Alkutunnistetta seuraavalle riville kirjoitetaan luokituksen nimi ja sitä seuraavalle riville luokitukseen kuuluvien vaihtoehtojen lukumäärä. Lukumäärää seuraaville peräkkäisille riveille kirjoitetaan luokituksen eri vaihtoehtojen nimet. Luokituksen lopuksi kirjoitetaan vielä luokituksen perusteet. Perusteiden alkutunnisteena on

  <perusteet>

  ja lopputunnisteena

  </perusteet>

  Tunnisteideen väliin kirjoitetaan luokitusta ja sen perusteita käyttäjälle selventävä ja valintoja ohjaava teksti. Ohjelma näyttää tämän tekstin omassa ikkunassaan käyttäjän napsauttaessa vaatimusikkunassa luokituksen kohdalla olevaa painiketta 'Näytä perusteet'. Luokituksen perusteita ei käyttäjä voi muokata ohjelmassa, vaan se määritellään ainoastaan tässä tiedostossa. Perusteiden kirjoittamisen jälkeen luokituksen määrittäminen lopetetaan kirjoittamalla seuraavalle riville luokituksen lopputunniste

  </luokitus>

3.4 Yleistiedot (.rmg)

<-- sfrm-general -->
<-- Tämä on vaatimusmäärittelyyn -->
<-- 'G:/jkahko/Et/sfrm/vm/vm' -->
<-- liittyvä yleistiedot -tiedosto -->
<-- 'G:/jkahko/Et/sfrm/vm/vm.rmg' -->
<-- Tekijä: jkahko -->
<-- Päiväys: 07.02.2002 12.46 -->
<yleiset>
Tähän voidaan kirjoittaa vaatimusmäärittelyyn liittyviä yleisiä tietoja. 
Tämä teksti tulostetaan jokaisen raportin alkuun. Tekstin pituutta ei ole rajoitettu.
<p>
Tätä tekstiä voidaan muokata valitsemalla 'Yleistiedot/Muokkaa…', 
jolloin avautuu tekstin muokkausikkuna. Tämä teksti näytetään myös 'Raportin luominen' 
-ikkunassa, mutta siinä sitä ei voi muokata. 
<yleiset>

• Ensimmäisen rivin on oltava yllä olevassa muodossa, jotta ohjelma tunnistaa tiedoston oletusasetustiedostoksi.
• Voit lisätä kommenttirivejä

  <--        -->

  merkkien väliin. Ohjelma kirjoittaa kommenttirivit 1-7 tallennettaessa Yleistiedot -ikkunassa.
• Raportissa esitettävä tekstiosa kirjoitetaan tunnisterivien

  <yleiset> ja </yleiset>

  väliin. Huomaa, että tähän ei kirjoiteta HTML-tiedostoille tyypillisiä otsikkotietoja ja tiedoston aloitus ja lopetus tunnisteita, koska ohjelma lisää ne raporttia luodessaan. Koska ohjelma sijoittaa tekstin sellaisenaan raportin alkuun, on sen sisällettävä muut HTML-tekstin muotoiluun tarvittavat ohjausmerkit.

<-- sfrm-defaults -->   	
<-- Tämä on käyttäjälle -->	 
<-- 'jkahko' -->
<-- liittyvä oletusasetuksettiedosto -->
<-- 'jkahko.rms' -->
<-- Tekijä: jkahko -->
<-- Päiväys: 23.02.2002 16.17 -->
<sfrm-nuolet>
/usr/bin/sfrm/nuolet
</sfrm-nuolet>
<editori>
/usr/bin/emacs
</editori>
<selain>
/usr/bin/netscape
</selain>
<vm>
<alkunumero>
1
</alkunumero>
<loppunumero>
99
</loppunumero>
</vm>
<rm>
<alkunumero>
251
</alkunumero>
<loppunumero>
499 
</loppunumero>
</rm>
<malli>
<alkunumero>
51
</alkunumero>
<loppunumero>
99
</loppunumero>
</malli>

• Ensimmäisen rivin on oltava yllä olevassa muodossa, jotta ohjelma tunnistaa tiedoston oletusasetustiedostoksi.
• Voit lisätä kommenttirivejä

  <--        -->

  merkkien väliin haluamaasi kohtaan tiedostossa. Ohjelma kirjoittaa kommenttirivit 1-7 tallennettaessa oletuseditoria tai oletusselainta.
• Kirjoita tunnisterivien

  <sfrm-nuolet> ja </sfrm-nuolet>

  väliin nuolikuvioiden down.gif ja side.gif hakemistopolku, jos ne eivät sijaitse käynnistyshakemistossa. Jos nuolet sijaitsevat käynistyshakemistossa, näitä rivejä ei tarvitse kirjoittaa.
• Kirjoita tunnisterivien

  <editori> ja </editori>

  väliin haluamasi oletuseditori hakemistopolkuineen. Voit määrittää sen myös vasta ohjelmassa (ks. 2.4.1), mutta siinä tapauksessa sijoita nyt tunnisteiden väliin yksi tyhjä rivi (laatiessasi tiedostoa ennen vaatimusmäärittelyn aloittamista).
• Kirjoita tunnisterivien

  <selain> ja </selain>

  väliin haluamasi oletusselain hakemistopolkuineen. Voit määrittää sen myös vasta ohjelmassa (ks. 2.4.1 - 2.4.2), mutta siinä tapauksessa sijoita nyt tunnisteiden väliin yksi tyhjä rivi.
• Jokaiselle vaatimusmäärittelylle on annettava tässä oletusasetustiedostossa vaatimusten alku- ja loppunumero. Ohjelma antaa jokaiselle vaatimukselle yksilöllisen ID-tunnisteen, alkaen alkunumerosta (esim. id1). Jokaiselle uudelle vaatimukselle ohjelma kasvattaa tunnusnumeroa. Kun loppunumeroa vastaava vaatimuskin on jo lisätty (esim. id100), antaa ohjelma virheilmoituksen yritettäessä lisätä seuraavaa vaatimusta. Ilmoituksessa kerrotaan, että kaikki vaatimusnumerot on käytetty, eikä uutta vaatimusta enää lisätä. Mikäli vaatimuksia poistetaan, ohjelma käyttää vapautuneet numerot seuravia vaatimuksia lisättäessä. Mikäli ohjelma havaitsee tiedostostoa lukiessaan virheitä, se antaa virheilmoituksen ohjelmaa käynnistettäessä. Jos tässä asetustiedostossa ei anneta alku- tai loppunumeroa, ohjelma antaa siitä ilmoituksen vaatimusmäärittelyä avattaessa. Vaatimuksia ei voi lisätä ennen kuin asetustiedosto on kunnossa ja numerot annettu.

  Mikäli vaatimusmäärittelyä laatii useampi henkilö, on kunkin henkilön omassa oletusasetustiedostossa annettava käyttöön eri numerot (ks. 1.9). Esim 1 – 100, 101 – 200 jne. Numerosarjojen ei tarvitse olla keskenään peräkkäin jatkuvia, mutta ne eivät saa olla päällekkäisiä.

  Kunkin vaatimusmäärittelyn aloitus- ja lopetustunnisteessa käytetään sen nimeä. Aloitusrivi on muotoa <vm>, jossa vm on vaatimusmäärittelystä asetustiedostoissa käytetty nimi (vm.rmg, vm.rmc, vm.rmg). Vastaavasti lopetustunnisterivinä on </vm>. Näiden tunnisteiden väliin sijoitetaan käyttäjän ensimmäinen vaatimusnumero tunnisterivien

  <alkunumero> ja  </alkunumero>

  väliin sekä vastaavasti viimeinen numero tunnisterivien

  <loppunumero> ja </loppunumero>

  väliin.

Ohjelma voidaan asentaa sen tulevasta käytöstä riippuen hieman eri tavoin. Jos käytät ohjelmaa yksin esimerkiksi yksittäisessä työasemassa, voit toimia vaihtoehdon 1 mukaisesti. Jos ohjelmaa käyttää useampi henkilö, voidaan ohjelma asenttaa vaihtoedon 2 mukaisesti.

Vaihtoehto 1
Ohjelmatiedosto sfrm.tcl ja käyttäjän oletusasetustiedosto user.rms (user = oma käyttäjätunnuksesi, esim mmainio.rms) kopioidaan samaan hakemistoon (tässä: ohjelmahakemisto). Ohjelmahakemistoon kopioidaan myös pääikkunassa käytettävät nuolikuviot side.gif ja down.gif. Vaatimusmäärittelykohtaiset (tässä: vm) asetustiedostot (vm.rmh, vm.rmc ja vm.rmg) voit kopioida myös johonkin muuhun hakemistoon (tässä: työhakemisto) kuin edelliset, mutta ne on kopioitava keskenään samaan hakemistoon. Eri vaatimusmäärittelyjen työhakemistot voidaan sijoittaa esimerkiksi ohjelmahakemiston alihakemistoiksi. Tällöin vaatimusmäärittelyä avattaessa halutun vaatimusmäärittelyn valinta on helppoa, koska tiedoston valintaikkunassa on oletuksena avattuna ohjelmahakemisto. Tiedostojen vm.rmh ja vm.rmc on oltava määriteltyinä ja kopioituina työhakemistoon ennen ohjelman varsinaista käyttöä. Yleistietoja sisältävää tiedostoa vm.rmg voidaan muokata myös ohjelmassa tai jos sitä ei ole määritelty aikaisemmin, se voidaan laatia kokonaisuudessaan ohjelmassa. Tallennettaessa ohjelma muodostaa ja nimeää tiedoston sekä tallentaa sen työhakemistoon. Ohjelma tallentaa vaatimusten tallennustiedoston (vm.rmd) työhakemistoon.

Vaihtoehto 2
Vaihtoehtoisessa asennuksessa ohjelmatiedosto, käyttäjän oletusasetustiedosto sekä nuolikuviot voidaan asentaa myös muuhun hakemistoon kuin se, josta ohjelma käynnistetään. Ohjelmatiedosto sfrm.tcl voidaan asentaa esimerkiksi palvelimelle, jolloin jokaisen käyttäjän ei tarvitse kopioida ohjelmaa omiin hakemistoihinsa. Tällöin ohjelmaa käynnistettäessä on annettava myös sen sijaintipolku. Käyttäjän oletusasetustiedosto on sijoitettava joko käynnistyshakemistoon tai samaan hakemistoon kuin ohjelmatiedosto. Ohjelma hakee sitä ensin käynnistyshakemistosta ja sen jälkeen ohjelmatiedoston sijaintihakemistosta. Jos se ei löydy kummastakaan hakemistosta, ohjelma antaa virheilmoituksen. Myös nuolikuviot voidaan asentaa edellisestä vaihtoehdosta poiketen vapaasti valittuun hakemistoon. Tällöin on kuitenkin ehdottoman tärkeää, että niiden sijaintihakemisto määritellään käyttäjän oletusasetustiedostossa user.rms (ks. 3.5). Ohjelmaa käynnistettäessä ohjelma tarkistaa, onko nuolien sijainnille määritelty hakemistoa. Jos hakemistoa ei ole määritetty, ohjelma hakee nuolikuvioita käynnistyshakemistosta. Mikäli nuolikuvioita ei löydy kummastakaan hakemistosta ohjelma antaa virheilmoituksen ja ohjelman käynnistys pysähtyy.

Ohjelman käyttäminen edellyttää, että olet asentanut Tcl/Tk-ohjelmiston koneeseesi. Saat sen automaattisesti useimpien Linux-jakelupakettien mukana. Windows-käyttöjärjestelmiin tarkoitetut versiot voit ladata asennusohjeineen esim. osoitteesta www.scriptics.com/software/.

2.4.2002
jkahko@cs.joensuu.fi