Mustrite kirjeldamine

Leheküljel toodud selgituste eesmärk on abistada olemasolevate mustrite lugemist ja uute mustrite lisamist.

Uue mustri lisamiseks tuleb täita Mustri kirjeldamise mall ja saata see aadressile help@ria.ee. Kirja pealkirjas lisada "Mustrikataloogi muster".

Mustri nimetus

Mustri nimetus koosneb mustri koodist ja nimest, mis on omavahel eraldatud kooloniga

  • Mustri kood - Mustri kood koosneb mustri eesmärki iseloomustavast koodist ja mustri nummerdusest selle koodi piires. Kui mustril on alammustreid, siis nende nummerdus eraldatakse punktiga (näiteks FM5.1 on mustri FM5 alammuster).
    Hetkel on kasutuses neli koodi:
    • PM - Primitiiv
    • FM - Funktsionaalne muster
    • KM - Teenuste kasutuse muster (kuulub gruppi Töötlemise mustrid)
    • TM - Teenuste tarbimise muster (kuulub gruppi Töötlemise mustrid)
  • Mustri nimi - Mustri nimi peaks andma edasi mustri eesmärki ja selgitama mille poolest antud muster erineb teistest mustritest.
Mustri märgendid

Iga mustri kirjelduse alguses tuuakse mustri nimetus ja täiendavad märgendid. Hetkel on kasutuses neli täiendavat märgendit.

  • Peamine kasutaja - Näitab, kelle tegevuse toetamiseks on muster kõige sobivam.
    • Inimene - Muster on sobilik toetama inimese poolt juhitavaid protsesse.
    • Automatiseeritud süsteem - Muster on sobilik toetama automatiseeritud süsteemide poolt juhitavaid protsesse.
  • Eesmärk - Üldine eesmärk, mille lahendamiseks antud muster sobib.
    • Andmete pärimine
    • Andmete saatmine
    • Andmete haldus
    • Teenuste tarbimine
    • Sõnumitöötlus
  • Allikas - Näitab, millele tuginedes on muster kirjeldatud.
    • Teadaolev praktika
    • Logikaeve
    • Eksperthinnang
  • Teenuste arv - Mustri realiseerimiseks vajalike teenuste arv.
Mustri kirjeldamine

Mustri kirjeldus jälgib üldjuhul Mustri kirjeldamise mallis toodud struktuuri. Olenevalt mustrist võib mõned mallis toodud alamosad ära jätta või asendada.

  • Abstract ja Lühikirjeldus - Mustri kirjeldus algab sissejuhatusega, mis tutvustab mustri eesmärki. Sissejuhatus kirjutatakse inglise- ja eestikeeles.
  • Probleemipüstitus - Iga mustri juures esitatakse lühike probleemipüstitus. Probleemipüstituse eesmärk on selgitada, miks antud muster on loodud ja millises olukorras tuleks antud mustrit kasutada. Probleemipüstitus võib sisaldada viiteid teistele mustritele koos põhjendustega, miks need mustrid ei ole antud olukorras kasutatavad.
  • Lahendus - Kirjeldus, kuidas antud muster lahendab eelnevalt püstitatud probleemi.
    • Teenuste kirjeldus - Probleemi lahenduseks kasutatavate X-tee teenuste kirjeldus. Teenuste kirjeldus võib olla osaline, aga peab sisaldama mustri seisukohast olulisi detaile. Iga teenuse kohta tuleks esitada nii tekstiline, kui ka WSDL kirjeldus.
    • Mustri käitumine - Selgitab, kuidas probleemi lahendamiseks loodud teenuseid tarbitakse. Mustri käitumise kirjeldamiseks sobib näiteks järgnevusskeem, üldisem sõnumivahetuse skeem või talitusprotsessi skeem.
  • Lisakaalutlused - Täiendav info, mis ei ole mustri kirjelduse seisukohast otseselt oluline. Näiteks käideldavus, eraldi pääsuõiguste kihi loomise vajadus, millistel juhtudel muster sobib/ei sobi jms. Vajadusel viidata teistele mustritele, mis võivad mõnel juhul olla sobivamad, või rakendusjuhise välistele materjalidele, mis on antud mustri rakendamisel kasulikud.
  • Näited - Üks või mitu näidet kus antud muster on kasutuses. Näide peab sisaldama näites olevate X-tee teenuste nimesid ja lühikirjeldust. Vajadusel tuleks tuua teenuste täpsemad kirjeldused, andmevahetuse skeem vms.



Viimati muudetud: pühapäev, 23. oktoober 2016, 16.30