PM: UC: Arengukava lisamine/muutmine

Sisukord

Üldkirjeldus

Kasutajal on võimalik rollis valitud asutusele / ametikohale lisada ja muuta arengukava sisu ning määrata selle periood. Perioodi alusel kuvatakse arengukavas asutuse / ametikoha aktiivsed eesmärgid.

Kui asutusel / ametikohal ei ole veel arengukava, luuakse see automaatselt vaate avamisel. Edaspidi saavad vastavate õigustega kasutajad arengukava sisu pidevalt muuta.

Iga asutuse või isiku konkreetse ametikoha kohta saab olla ainult üks muudetav arengukava.

Kasutaja saab vormil sisestatud andmete põhjal genereerida arengukava versioone kas PDF-dokumendina või jagatava URL-ina.

Arengukava lisamise/muutmise vaade on kättesaadav kasutajale töölaualt.

• Asutuse rollis kasutaja pääseb vaatele ligi, kui tal on planeerimise moodulis arengukava lisamise ja muutmise õigus.
• Ametikoha rollis kasutajale ei ole eraldi privileegi vaja. Õiguse luua või muuta enda ametikohaga seotud arengukava annab talle tema ametikoht. 

Seotud Jira taskid

NSIL-1008 - Getting issue details... STATUS

NSIL-1005 - Getting issue details... STATUS

NSIL-1011 - Getting issue details... STATUS

NSIL-1012 - Getting issue details... STATUS

NSIL-1013 - Getting issue details... STATUS

NSIL-1062 - Getting issue details... STATUS

NSIL-1049 - Getting issue details... STATUS

Kasutajaliides

Jäljerida

Avaleht → Töölaud → Arengukava

Disainid

Arengukava vaade vaikimisi, kui arengukavale pole veel perioodi määratud: https://www.figma.com/design/mPPdrh04luwBeiX856NQPP/NAPO---TWN?node-id=6405-51196&t=CFigLFExylz8EGNp-1
Arengukava muutmine: https://www.figma.com/design/mPPdrh04luwBeiX856NQPP/NAPO---TWN?node-id=6415-65423&t=AiT2LYeEuLJWZMx7-4

Eeltingimused

Kasutaja on sisse loginud ja valinud sobiva rolli:

• Asutus:
  • Asutusel puudub muudetav arengukava või see eksisteerib ning kasutaja on seotud selle asutusega.
    • Puudub või eksisteerib DevelopmentPlan.id, millel:
      • institution.id = kasutaja valitud rolliga seotud asutus,
      • editable = TRUE
  • Kasutajal on arengukava asutuse arengukava lisamise ja muutmise õigus.
    • Õigust reguleerib privileeg: HSILM_PLANNING_DEV_PLAN_MANAGE.
• Ametikoht:
  • Ametikohal puudub muudetav arengukava või see eksisteerib ning kasutaja on selle omanik ja seotud nii arengukava asutuse kui ka ametikohaga.
    • Puudub või eksisteerib DevelopmentPlan.id, millel:
      • personalCode = kasutaja isikukood,
      • institution.id = kasutaja valitud rolliga seotud asutus,
      • jobsite = kasutaja valitud rolliga seotud ametikoht,
      • editable = TRUE 
    • Eraldi privileegi ei ole vaja - õiguse oma ametikoha arengukava muutmiseks annab kasutajale tema ametikoht. 
• Meeskonnaliikme ja arhiivi rollis kasutajatel puudub õigus arengukavasid luua ja muuta - seetõttu puudub neil ligipääs sellele vaatele.

Planeerimise mooduli kasutusrollide ja õiguste kohta saab täpsemalt infot leida lehelt Kasutusõigused ja rollid.

Funktsionaalsus

Selgitused

1. Vaate avamisel:
   1. Kõigepealt teeb kasutajaliides päringu rollis valitud asutuse / ametikoha muudetava arengukava põhiandmete (pealkiri, periood, logo) ja sektsioonide nimekirja saamiseks: PM: API: DevelopmentPlan: GET /planning-api/development-plans.
      1. Päringu sisend sõltub kasutaja rollist:
         1. Kui rolliks on asutus:
            1. developmentPlanScope = "INSTITUTIONAL"
            2. institutionId = kasutaja valitud rolliga seotud asutuse ID
         2. Kui rolliks on ametikoht:
            1. developmentPlanScope = "INDIVIDUAL"
            2. jobsite = kasutaja valitud rolliga seotud ametikoht
            3. institutionId = ametikohaga seotud asutuse ID
   2. Kui päring tagastab arengukava:
      1. Kui arengukaval on logo (logoFileId != NULL), tehakse päring logo allalaadimiseks: PM: API: DevelopmentPlan: GET /planning-api/development-plans/{developmentPlanId}/logos/{logoFileId}/download.
         
         1. Päringu sisend:
            1. developmentPlanId = arengukava ID
               1. PM: API: DevelopmentPlan: GET /planning-api/development-plans.response.id
            2. logoFileId = arengukava logo faili ID
               1. PM: API: DevelopmentPlan: GET /planning-api/development-plans.response.logoFileId
      2. Kasutajale kuvatakse päringuga saadud arengukava põhiandmed (pealkiri, periood, logo) ja sektsioonid.
      3. Kasutajaliides pärib arengukava sektsioonide vormielemente:
         1. Sektsiooni vormielementide saamiseks käivitatakse päring: PM: API: DevelopmentPlan: GET /planning-api/development-plans/{developmentPlanId}/sections/{sectionId}/elements.
            1. Päringu sisend:
               1. sectionId = üks varasema päringuga saadud sektsioonide ID-dest
                  1. PM: API: DevelopmentPlan: GET /planning-api/development-plans.response.sections.id
               2. developmentPlanId = arengukava ID
                  1. PM: API: DevelopmentPlan: GET /planning-api/development-plans.response.id
            2. Iga päringuga saadud vormielemendi kohta, mille tüüp on pilt (inputType = "IMAGE"), laetakse failihoidlast sellega seotud fail päringu abil: PM: API: DevelopmentPlan: GET /planning-api/development-plans/{developmentPlanId}/sections/{sectionId}/elements/{elementId}/files/{fileId}/download.
               1. Päringu sisend:
                  1. fileId = allalaetava faili ID
                     1. PM: API: DevelopmentPlan: GET /planning-api/development-plans/{developmentPlanId}/sections/{sectionId}/elements.response.elements.fail.id
                  2. elementId = vormielemendi ID, millega pilt on seotud
                     1. PM: API: DevelopmentPlan: GET /planning-api/development-plans/{developmentPlanId}/sections/{sectionId}/elements.response.elements.id
                  3. sectionId = sektsiooni ID, kuhu vormielement kuulub
                     1. PM: API: DevelopmentPlan: GET /planning-api/development-plans.response.sections.id
                  4. developmentPlanId = arengukava ID
         2. Kasutajale kuvatakse päringuga saadud sektsiooni vormielemendid.
         3. Seejärel tehakse päring järgmise sektsiooni vormielementide saamiseks. Tegevus kordub kuni kõigi sektsioonide elemendid on kätte saadud.
      4. Kui arengukavale on määratud algus- ja lõpukuupäevad (startDate != NULL ja endDate != NULL):
         1.  Kasutajaliides käivitab päringu, et saada asutuse / ametikoha aktiivseid eesmärke, mis kattuvad määratud perioodiga vähemalt osaliselt: PM: API: DevelopmentPlan: GET /planning-api/development-plan-goals.
            1. Päringu sisend:
               
               1. developmentPlanId = arengukava ID
                  1. PM: API: DevelopmentPlan: GET /planning-api/development-plans.response.id
            2. Selgitus: Päring tagastab ainult aktiivseid eesmärke. Eesmärgi staatused on täpsemalt kirjeldatud lehel PM Eesmärgi staatused tööprotsessis.
         2. Kasutajale kuvatakse päringuga saadud eesmärkide nimekiri.
         3. Seejärel käivitab kasutajaliides arengukavast genereeritud versioonide arvu saamiseks päringu: PM: API: DevelopmentPlan: GET /planning-api/development-plans/{developmentPlanId}/versions
            1. Päringu sisend sõltub kasutaja rollist:
               1. Kui rolliks on asutus:
                  1. developmentPlanScope = "INSTITUTIONAL"
                  2. institutionId = kasutaja valitud rolliga seotud asutuse ID
               2. Kui rolliks on ametikoht:
                  1. developmentPlanScope = "INDIVIDUAL"
                  2. jobsite = kasutaja valitud rolliga seotud ametikoht
                  3. institutionId = ametikohaga seotud asutuse ID
   3. Kui päring tagastab tühja vastuse, tähendab see, et asutusel / ametikohal puudub arengukava. Sellisel juhul loob süsteem arengukava automaatselt.
      1. Süsteem käivitab päringu arengukava loomiseks: PM: API: DevelopmentPlan: POST /planning-api/development-plans.
         1. Päringu sisend sõltub kasutaja rollist:
            1. Kui rolliks on asutus:
               1. developmentPlanScope = "INSTITUTIONAL"
               2. institutionId = kasutaja valitud rolliga seotud asutuse ID
               3. institutionName = asutuse nimetus
               4. institutionType = asutuse liik
            2. Kui rolliks on ametikoht:
               1. developmentPlanScope = "INDIVIDUAL"
               2. jobsite = kasutaja valitud rolliga seotud ametikoht
               3. institutionId = ametikohaga seotud asutuse ID
               4. institutionName = asutuse nimetus
               5. institutionType = asutuse liik
         2. Selgitus:
            1. Loodavasse arengukavasse lisatakse vaikimisi viis sektsiooni kindlas järjekorras: Sissejuhtatus, Missioon, Visioon, Põhiväärtused, Riskid.
            2. Arengukavale ie määrata vaikimisi perioodi, s.t. algus- ja lõpukuupäevasid jäävad tühjaks. 
      2. Kasutajale kuvatakse päringuga saadud arengukava andmed.
2. Arengukava andmete kuvamine:
   1. Arengukava sektsioonid kuvatakse vastavalt neile määratud järjestusele.
      
      1. PM: API: DevelopmentPlan: GET /planning-api/development-plans.response.sections.previousSectionId
      2. PM: API: DevelopmentPlan: POST /planning-api/development-plans.response.sections.previousSectionId
   2. Sektsioonis olevad vormielemendid kuvatakse samuti määratud järjestuses, üksteise all.
      
      1. PM: API: DevelopmentPlan: GET /planning-api/development-plans/{developmentPlanId}/sections/{sectionId}/elements.response.elements.previousElementId
   3. "Eesmärkide" plokk kuvatakse alati, isegi siis, kui ei leita ühtegi eesmärki, mis kattuks arengukava perioodiga.
      
      1. Kui eesmärke ei ole, kuvatakse teade: "Eesmärgid puuduvad".
         1. PM: API: DevelopmentPlan: GET /planning-api/development-plan-goals.response.goals = NULL
      2. Kui eesmärgid on olemas:
         1. Iga eesmärk kuvatakse eraldi akordionina.

         2. Akordioni pealkirji koosneb eesmärgi nimetusest ja järjekorranumbrist.

            1. PM: API: DevelopmentPlan: GET /planning-api/development-plan-goals.response.goals.name
            2. Järjekorranumbrit määratakse eesmärgi positsiooni põhjal goals massiivis.
         3. Vaikimisi on avatud esimese eesmärgi akordion, teised on suletud. 
         4. Iga uue eesmärgi akordioni avamisel ei suleta eelmist — mitmed akordionid võivad olla avatud samaaegselt.
         5. Eesmärgi mõõdikute plokk kuvatakse ainult juhul, kui eesmärgil on vähemalt üks mõõdik:
            
            1. PM: API: DevelopmentPlan: GET /planning-api/development-plan-goals.response.goals.metrics != NULL
            2. Mõõdikud kuvatakse tähestikulises järjekorras kirjelduse alusel. 
               1. PM: API: DevelopmentPlan: GET /planning-api/development-plan-goals.response.goals.metrics.description
            3. Vaikimisi on avatud esimese mõõdiku akordion, ülejäänud on suletud. 
            4. Iga uue eesmärgi akordioni avamisel ei suleta eelmist — mitmed mõõdikute akordionid võivad olla samaaegselt avatud.
            5. Mõõdiku näitajad kuvatakse üksteise all. 
3. Kasutajal on võimalik muuta arengukava andmeid:
   1. Üldised reeglid:
      1. Kvaliteedimooduli vaadetes kehtib üldine reegel:
         1. Muudatused salvestatakse automaatselt, kui kasutaja eemaldab fookuse sisestus- või kuupäevaväljalt.
         2. Iga automaatse salvestuse järel kuvatakse kasutajale teade andmete salvestamise kohta. 
   2. Logo: 
      1. Kasutaja saab lisada, muuta või eemaldada arengukava logo.
      2. Logo lisamine:
         1. Logo pilt laaditakse süsteemi kohe, kui kasutaja kinnitab valiku faili avamise aknas. 
            
            1. Logo lisamiseks vajutab kasutaja vastava nupu, mille peale avaneb arvutist faili üles laadimise aken, kus saab valida maksimaalselt ühe pildi.
            2. Pildifaili valimisel käivitatakse päring: PM: API: DevelopmentPlan: POST /planning-api/development-plans/{developmentPlanId}/logos.
               1. Päringu sisend:
                  1. developmentPlanId = arengukava päringuga saadud arengukava ID
                     • PM: API: DevelopmentPlan: GET /planning-api/development-plans.response.id
                     • PM: API: DevelopmentPlan: POST /planning-api/development-plans.response.id
                  2. file = kasutaja poolt üleslaetav fail
               2. Lubatud vormingud: jpg, jpeg, png, svg, bmp.
               3. Faili maksimaalne suurus võib olla kuni 15 MB.
               4. Faili üleslaadimise käigus kontrollitakse, kas fail sisaldab viirust. 
                  1. Kui fail on viirusega nakatunud katkestatakse üleslaadimine ning kuvatakse vastav veateade.
                  2. Kui fail on turvaline, salvestatakse see faililaidlasse.
         2. Kasutajaliides kuvab kasutajale üleslaetud logo ja teate logo eduka lisamise kohta.
      3. Logo eemaldamine: 
         1. Vajutades vastavat nuppu, kuvatakse kasutajale kustutamise kinnitamise vaate.
         2. Kui kasutaja kinnitab, käivitatakse päring: PM: API: DevelopmentPlan: DELETE /planning-api/development-plans/{developmentPlanId}/logos/{logoFileId}.
            1. Päringu sisend:
               1. developmentPlanId = arengukava päringuga saadud arengukava ID
               2. logoFileId = arengukava olemasoleva logo faili ID
                  1. PM: API: DevelopmentPlan: GET /planning-api/development-plans.response.logoFileId
                  2. PM: API: DevelopmentPlan: POST /planning-api/development-plans.response.logoFileId
                  3. PM: API: DevelopmentPlan: POST /planning-api/development-plans/{developmentPlanId}/logos.response.id
         3. Kasutajaliides eemaldab logo faili arengukava vormilt ning kuvab teade logo eduka kustutamise kohta.
      4. Logo muutmine:
         1. Vajutades vastavat nuppu, avaneb faili üles laadimise aken.
         2. Pildifaili valimisel:
            1. Esmalt käivitatakse olemasoleva logo kustutamise päring: PM: API: DevelopmentPlan: DELETE /planning-api/development-plans/{developmentPlanId}/logos/{logoFileId}.
            2. Kui kustutamine õnnestub, käivitatakse uue logo lisamise päring: PM: API: DevelopmentPlan: POST /planning-api/development-plans/{developmentPlanId}/logos.
            3. Sisendid on samad nagu ülalpool kirjeldatud.
         3. Kasutajaliides asendab olemasoleva logo uue pildiga ja kuvab teate logo eduka muutmise kohta.
   3. Arengukava pealkiri:
      1. Kasutaja saab muuta arengukava pealkirja. 
         1. Vastava ikoonikese vajutamisel kuvatakse modaalaken PM: UC: Arengukava pealkirja muutmine.
      2. Tavalise salvestusteavituse asemel kuvatakse teade pealkirja eduka muutmise kohta kohe pärast modaali sulgemist.
   4. Arengukava periood:
      1. Kasutaja saab muuta arengukava perioodi.
         1. Kui kasutaja lisab või muudab arengukava algus- või lõpukuupäeva, käivitatakse päring: PM: API: DevelopmentPlan: PUT /planning-api/development-plans/{developmentPlanId}.
            1. Päringu sisend:
               1. developmentPlanId = arengukava päringuga saadud arengukava ID
                  • PM: API: DevelopmentPlan: GET /planning-api/development-plans.response.id
                  • PM: API: DevelopmentPlan: POST /planning-api/development-plans.response.id
               2. title = arengukava pealkiri
                  1. PM: API: DevelopmentPlan: GET /planning-api/development-plans.response.title
                  2. PM: API: DevelopmentPlan: POST /planning-api/development-plans.response.title
                  3. PM: API: DevelopmentPlan: PUT /planning-api/development-plans/{developmentPlanId}.response.title
               3. startDate = Kuupäeva välja "Perioodi algus" väärtus (kui on määratud)
               4. endDate = Kuupäeva välja "Perioodi lõpp" väärtus (kui on määratud)
                  1. Vähemalt üks neist kahest atribuudist (startDate või endDate) peab olema määratud. 
         2. Seejärel tehakse uus päring arengukava eesmärkide loetelu uuendamiseks: PM: API: DevelopmentPlan: GET /planning-api/development-plan-goals.
            1. Sisend on kirjeldatud ülalpool. 
   5. Sektsioonid:
      1. Kasutaja saab lisada arengukavale uusi sektsioone, muuta olemasolevate andmeid ja nähtavust ning kustutada sektsioone.
         1. Sektsiooni lisamine / muutmine: 
            1. Vastava nupu vajutamisel avaneb modaalaken PM: UC: Arengukava sektsiooni lisamine/muutmine.
            2. Kui tegevus õnnestub, kuvatakse uus sektsioon või uuendatakse muudetud sektsiooni andmeid.
            3. Tavalise salvestusteavituse asemel kuvatakse teade sektsiooni eduka lisamise/muutmise kohta kohe pärast modaali sulgemist.
         2. Sektsiooni nähtavuse muutmine:
            1. Sektsiooni juures vastava linnukese lisamine või eemaldamine käivitab päringu: PM: API: DevelopmentPlan: PATCH /planning-api/development-plans/{developmentPlanId}/sections/{sectionId}/hide.  

               1. Päringu sisend: 

                  • sectionId = sektsiooni ID, mille päises nähtavuse olekut muudeti
                    • PM: API: DevelopmentPlan: GET /planning-api/development-plans.response.sections.id
                    • PM: API: DevelopmentPlan: POST /planning-api/development-plans.response.sections.id
                    • PM: API: DevelopmentPlan: POST /planning-api/development-plans/{developmentPlanId}/sections.response.id
                  • developmentPlanId = arengukava ID
                  • hidden = true, kui linnuke lisati (soovitakse sektsioon peita); false, kui linnuke eemaldati (soovitakse sektsioon taas nähtavaks teha).
               2. Selgitus: Sektsiooni nähtavuse muudatus rakendub ainult arengukava versioonidele, mis luuakse pärast muudatuse salvestamist. Varem loodud versioonidele see mõju ei avalda.
         3. Sektsiooni kustutamine:
            1. Sektsiooni tegevuste menüüst "Kustuta" valmisel kuvab süsteem kasutajale kustutamise kinnitamise vaate.
            2. Kui kasutaja kinnitab, käivitatakse päring: PM: API: DevelopmentPlan: DELETE /planning-api/development-plans/{developmentPlanId}/sections/{sectionId}.
               1. Päringu sisend:
                  1. sectionId = kustutatava sektsiooni ID
                  2. developmentPlanId = arengukava ID
            3. Kasutajaliides eemaldab kustutatud sektsiooni arengukava vormilt ning kuvatakse teade sektsiooni eduka kustutamise kohta.
   6. Vormielemendid:
      1. Tekstiala: 
         1. Kasutaja saab lisada sektsioonile uusi tekstialasid, sisestada või muuta nende teksti ning neid kustutada.
         2. Uue tekstiala lisamine:
            1. Vastava nupu vajutamisel käivitatakse vormielemendi lisamise päring: PM: API: DevelopmentPlan: POST /planning-api/development-plans/{developmentPlanId}/sections/{sectionId}/elements.
               1. Päringu sisend:
                  1. sectionId = sektsiooni ID, millele lisatakse uus tekstivälja tüüpi vormielement
                  2. developmentPlanId = arengukava ID
                  3. previousElementId = vormielemendi ID, mille alla uus vormielement lisatakse. Kui sektsioonile lisatakse kõige esimene element või uus element lisatakse kuvamiseks esimesena, siis atribuudi väärtuseks määratakse NULL.
                     1. PM: API: DevelopmentPlan: GET /planning-api/development-plans/{developmentPlanId}/sections/{sectionId}/elements.response.elements.id
                     2. PM: API: DevelopmentPlan: POST /planning-api/development-plans/{developmentPlanId}/sections/{sectionId}/elements.response.id
                  4. inputType = "TEXT_AREA" (viide klassifikaatori INPUT_TYPE väärtusele)
            2. Kasutajaliides kuvab kasutajale lisatud tekstiala ja teate eduka lisamise kohta.
         3. Tekstiala teksti muutmine:
            1. Kui kasutaja sisestab või muudab tekstialas vähemalt ühe tähemärgi, käivitatakse päring vormielemendi andmete uuendamiseks: PM: API: DevelopmentPlan: PUT /planning-api/development-plans/{developmentPlanId}/sections/{sectionId}/elements/{elementId}.
               1. Päring käivitatakse hetkel, millal kasutaja eemaldab fookuse sisestusväljalt (ehk sisestamine peatub hetkeks). 
               2. Päringu sisend:
                  1. elementId = vormielemendi ID, mille teksti väärtust muudeti
                     1. PM: API: DevelopmentPlan: GET /planning-api/development-plans/{developmentPlanId}/sections/{sectionId}/elements.response.elements.id
                     2. PM: API: DevelopmentPlan: POST /planning-api/development-plans/{developmentPlanId}/sections/{sectionId}/elements.response.id
                  2. sectionId = sektsiooni ID, kuhu muudetav vormielement kuulub
                     1. PM: API: DevelopmentPlan: GET /planning-api/development-plans.response.sections.id
                     2. PM: API: DevelopmentPlan: POST /planning-api/development-plans.response.sections.id
                     3. PM: API: DevelopmentPlan: POST /planning-api/development-plans/{developmentPlanId}/sections.response.id
                  3. developmentPlanId = arengukava ID
                  4. inputType = "TEXT_AREA" (viide klassifikaatori INPUT_TYPE väärtusele)
                  5. textValue = tekstialasse sisestatud tekst koos lubatud vormindusega (B, I, U, nummerdatud/nummerdamata nimekirjad, link)
         4. Tesktiala kustutamine:
            1. Vastava nupu vajutamisel kuvab süsteem kasutajale kustutamise kinnitamise vaate.
            2. Kui kasutaja kinnitab, käivitatakse päring vormielemendi kustutamiseks: PM: API: DevelopmentPlan: DELETE /planning-api/development-plans/{developmentPlanId}/sections/{sectionId}/elements/{elementId}.
               1. Päringu sisend:
                  1. elementId = eemaldatava vormielemendi ID
                  2. sectionId = sektsiooni ID, kuhu eemaldatav vormielement kuulub
                  3. developmentPlanId = arengukava ID
            3. Kasutajaliides eemaldab tekstiala ja kuvab teade selle kustutamise kohta.
      2. Pilt:
         1. Kasutaja saab sektsioonile lisada pilte, määrata või muuta nende pealkirju ning neid kustutada.
         2. Uue pildi lisamine:
            1. Vormielement luuakse ja pilt laaditakse süsteemi kohe, kui kasutaja kinnitab valiku faili avamise aknas. 
               1. Nupu vajutamisel avatakse failibrauser, kus saab valida maksimaalselt ühe pildi. 
                  1. Lubatud vormingud: jpg, jpeg, png, svg, bmp.
                  2. Faili maksimaalne suurus võib olla kuni 15 MB.
               2. Pildi valiku kinnitamisel:
                  1. Esmalt käivitatakse vormielemendi lisamise päring: PM: API: DevelopmentPlan: POST /planning-api/development-plans/{developmentPlanId}/sections/{sectionId}/elements.

                     1. Päringu sisend:

                        1. sectionId = sektsiooni ID, millele vormielement lisatakse

                        2. developmentPlanId = arengukava ID

                        3. inputType = "IMAGE" (viide klassifikaatori INPUT_TYPE väärtusele)

                        4. previousElementId = vormielemendi ID, mille alla uus vormielement lisatakse. Kui sektsioonile lisatakse kõige esimene element või uus element lisatakse kuvamiseks esimesena, siis atribuudi väärtuseks määratakse NULL. 

                  2. Vormielemendi edukal loomisel käivitatakse faili üleslaadimise päring: PM: API: DevelopmentPlan: POST /planning-api/development-plans/{developmentPlanId}/sections/{sectionId}/elements/{elementId}/files.
                     1. Päringu sisend:
                        1. file = kasutaja poolt valitud fail  
                        2. elementId = eelmise päringuga loodud vormielemendi ID
                           1. PM: API: DevelopmentPlan: POST /planning-api/development-plans/{developmentPlanId}/sections/{sectionId}/elements.response.id
                        3. sectionId = sektsiooni ID, kuhu vormielement kuulub
                           1. PM: API: DevelopmentPlan: POST /planning-api/development-plans/{developmentPlanId}/sections/{sectionId}/elements.response.sectionId
                        4. developmentPlanId = arengukava ID
                     2. Faili üleslaadimise käigus kontrollitakse selle turvalisust.
                        1. Kui fail on viirusega nakatunud, katkestatakse üleslaadimine ja kuvatakse veateade.
                        2. Turvaline fail salvestatakse faililaidlasse.
                  3. Lõpuks käivitatakse vormielemendi andmete uuendamise päring: PM: API: DevelopmentPlan: PUT /planning-api/development-plans/{developmentPlanId}/sections/{sectionId}/elements/{elementId}
                     1. Päringu sisend:
                        1. elementId = esimese päringuga loodud vormielemendi ID
                           1. PM: API: DevelopmentPlan: POST /planning-api/development-plans/{developmentPlanId}/sections/{sectionId}/elements.response.id
                        2. sectionId = sektsiooni ID, kuhu muudetav vormielement kuulub
                           
                           1. PM: API: DevelopmentPlan: POST /planning-api/development-plans/{developmentPlanId}/sections/{sectionId}/elements.response.sectionId
                        3. developmentPlanId = arengukava ID
                        4. inputType = "IMAGE" (viide klassifikaatori INPUT_TYPE väärtusele).
                        5. file.id = just üleslaetud faili Id
                           1. PM: API: DevelopmentPlan: POST /planning-api/development-plans/{developmentPlanId}/sections/{sectionId}/elements/{elementId}/files.response.id
            2. Kasutajaliides kuvab lisatud pilti ja välja pealkirja sisestamiseks ning teate pildi eduka lisamise kohta.
         3. Pildile pealkirja lisamine või muutmine:
            1. Kui kasutaja sisestab või muudab pealkirja väljas vähemalt ühe tähemärgi, käivitatakse vormielemendi andmete uuendamise päring: PM: API: DevelopmentPlan: PUT /planning-api/development-plans/{developmentPlanId}/sections/{sectionId}/elements/{elementId}.
               1. Pealkiri salvestatakse automaatselt, kui fookus väljalt eemaldatakse, st väärtuse sisestamine peatub hetkeks. 
               2. Päringu sisend:
                  1. elementId = vormielemendi ID, mille andmeid uuendatakse
                     1. PM: API: DevelopmentPlan: GET /planning-api/development-plans/{developmentPlanId}/sections/{sectionId}/elements.response.elements.id
                     2. PM: API: DevelopmentPlan: PUT /planning-api/development-plans/{developmentPlanId}/sections/{sectionId}/elements/{elementId}.response.id
                  2. sectionId = sektsiooni ID, kuhu muudetav vormielement kuulub
                     1. PM: API: DevelopmentPlan: GET /planning-api/development-plans/{developmentPlanId}/sections/{sectionId}/elements.response.elements.sectionId
                     2. PM: API: DevelopmentPlan: PUT /planning-api/development-plans/{developmentPlanId}/sections/{sectionId}/elements/{elementId}.response.sectionId
                  3. developmentPlanId = arengukava ID
                  4. inputType = vormielemendi tüüp (viide klassifikaatori INPUT_TYPE väärtusele).
                     1. PM: API: DevelopmentPlan: GET /planning-api/development-plans/{developmentPlanId}/sections/{sectionId}/elements.response.elements.inputType
                     2. PM: API: DevelopmentPlan: PUT /planning-api/development-plans/{developmentPlanId}/sections/{sectionId}/elements/{elementId}.response.inputType
                  5. file.id = vormielemendiga seotud pildifaili ID
                     1. PM: API: DevelopmentPlan: GET /planning-api/development-plans/{developmentPlanId}/sections/{sectionId}/elements.response.elements.file.id
                     2. PM: API: DevelopmentPlan: PUT /planning-api/development-plans/{developmentPlanId}/sections/{sectionId}/elements/{elementId}.response.file.id
                  6. file.title = pildi pealkirja välja väärtus
         4. Pildi kustutamine: 
            1. Vastava nupu vajutamisel kuvab süsteem kustutamise kinnitamise vaate.
            2. Kui kasutaja kinnitab, käivitatakse vormielemendi kustutamise päring: PM: API: DevelopmentPlan: DELETE /planning-api/development-plans/{developmentPlanId}/sections/{sectionId}/elements/{elementId}.
               1. 1. Päringu sisend:
                     1. elementId = vormielemendi ID, millega eemaldatav pilt on seotud
                        1. PM: API: DevelopmentPlan: GET /planning-api/development-plans/{developmentPlanId}/sections/{sectionId}/elements.response.elements.id
                        2. PM: API: DevelopmentPlan: PUT /planning-api/development-plans/{developmentPlanId}/sections/{sectionId}/elements/{elementId}.response.id
                     2. sectionId = sektsiooni ID, kuhu kustutav vormielement kuulub
                        1. PM: API: DevelopmentPlan: GET /planning-api/development-plans.response.sections.id
                        2. PM: API: DevelopmentPlan: POST /planning-api/development-plans.response.sections.id
                     3. developmentPlanId = arengukava ID
            3. Kasutajaliides eemaldab pildi vormilt ja kuvab teade pildi kustutamise kohta.
      3. Näitaja juhtimislaualt:
         1. Kasutaja saab lisada sektsioonile uusi juhtimislaua näitajaid, muuta olemasolevate andmeid ja neid kustutada.
         2. Uue näitaja lisamine:
            
            1. Vastava nupu vajutamisel kuvatakse modaalaken PM: UC: Arengukava sektsiooni näitaja lisamine/muutmine.
               1. Selgitus:
                  1. Ühele näitajale saab lisada ühe või mitu PBI aruannet. Aruannete arvule piirangut ei ole. 
                  2. Tegevuse tulemusel luuakse uus vormielement, kuhu salvestatakse viited valitud PBI aruannetele.
            2. Kasutajaliides kuvab kasutajale lisatud näitaja.
            3. Tavalise salvestusteavituse asemel kuvatakse teade näitaja eduka lisamise kohta kohe pärast modaali sulgemist.
         3. Näitaja andmete muutmine:
            1. Vastava nupu vajutamisel kuvatakse moodalaken PM: UC: Arengukava sektsiooni näitaja lisamine/muutmine.
               1. Selgitus:
                  1. Muutmisvaates saab kasutaja teostada kõiki samu tegevusi nagu lisamisevaates,
                     1. sealhulgas: 
                        1. muuta näitaja kirjeldust
                        2. lisada näitajale PBI aruandeid
                        3. eemaldada olemasolevaid aruandeid.
                     2. Andmete salvestamisel kirjutatakse näitajaga seotud aruannete nimekiri üle. 
            2. Pärast modaali sulgemist uuendab süsteem näitaja andmed ja kuvab teade näitaja eduka muutmise kohta.
         4. Näitaja kustutamine:
            1. Vastava nupu vajutamisel kuvab süsteem kustutamise kinnitamise vaate.
            2. Kui kasutaja kinnitab tegevuse, käivitatakse päring vormielemendi kustutamiseks: PM: API: DevelopmentPlan: DELETE /planning-api/development-plans/{developmentPlanId}/sections/{sectionId}/elements/{elementId}.
               1. Päringu sisend:
                  1. elementId = kustatava vormielemendi ID
                     1. PM: API: DevelopmentPlan: GET /planning-api/development-plans/{developmentPlanId}/sections/{sectionId}/elements.response.elements.id
                     2. PM: API: DevelopmentPlan: PUT /planning-api/development-plans/{developmentPlanId}/sections/{sectionId}/elements/{elementId}.response.id
                  2. sectionId = sektsiooni ID, kuhu kustutav vormielement kuulub
                     1. PM: API: DevelopmentPlan: GET /planning-api/development-plans/{developmentPlanId}/sections/{sectionId}/elements.response.elements.sectionId
                     2. PM: API: DevelopmentPlan: PUT /planning-api/development-plans/{developmentPlanId}/sections/{sectionId}/elements/{elementId}.response.sectionId
                  3. developmentPlanId = arengukava ID
            3. Kasutajaliides eemaldab näitaja vormilt ja kuvab teade näitaja eduka kustutamise kohta.
4. Kasutajal on võimalik genereerida arengukavast jagatav versioon kas URL-i või PDF-failina ning vaadata juba varem loodud jagamisi.
   1. Tegevusi saab teostada ainult juhul, kui arengukavale on määratud periood (st startDate != NULL ja endDate != NULL). 
   2. PDF-failina jagatava versiooni loomine:
      1. Vastav valik kuvatakse tegevuste menüüs ainult siis, kui arengukavast on loodud vähem kui 20 PDF-versiooni.  
         1. Andmeallikana kasutatakse vaate avamisel tehtud päringu tulemusena saadud arengukava versioonide nimekirja: PM: API: DevelopmentPlan: GET /planning-api/development-plans/{developmentPlanId}/versions.response.developmentPlanVersions.id, mille versionType = "PDF".
      2. Tegevuse valimisel käivitatakse PDF-versiooni genereerimine: PM: UC: Arengukava PDF-i genereerimine.
      3. Kui versiooni loomine õnnestub, kuvatakse kasutajale eduteade ning käivitatakse loodud PDF-faili allalaadimine: PM: API: DevelopmentPlan: GET /planning-api/development-plans/{developmentPlanId}/versions/{versionId}/files/{fileId}/download.
         1. Päringu sisend:
            1. developmentPlanId = vaates kuvatava arengukava ID
            2. versionId = just loodud PDF-versiooni ID
               1. PM: API: DevelopmentPlan: POST /planning-api/development-plans/{developmentPlanId}/pdf-versions.response.id
            3. fileId = just loodud PDF-faili ID
               1. PM: API: DevelopmentPlan: POST /planning-api/development-plans/{developmentPlanId}/pdf-versions.response.fileId
   3. URL-ina jagatava versiooni loomine:
      1. Vastav valik kuvatakse tegevuste menüüs ainult siis, kui arengukavast loodud URL-versioonide arv on alla 20.
         1. Andmeallikas: PM: API: DevelopmentPlan: GET /planning-api/development-plans/{developmentPlanId}/versions.response.developmentPlanVersions.id, mille versionType = "URL"
      2. Kui kasutaja valib URL-i kaudu jagatava versiooni loomise, avaneb modaalaken: PM: UC: Arengukava URL-versiooni loomine.
   4. Varasemalt loodud jagamiste vaatamine:
      1. Vastav valik kuvatakse tegevuste menüüs ainult siis, kui on olemas vähemalt üks jagatav versioon (URL või PDF).
         1. PM: API: DevelopmentPlan: GET /planning-api/development-plans/{developmentPlanId}/versions.response.developmentPlanVersions != NULL
      2. Tegevuse valimisel avaneb modaalaken: PM: UC: Arengukava kehtivate jagamiste vaatamine ja kustutamine.

Andmed

Kasutaja tegevused