PM: UC: Arengukava vaatamine

Sisukord

Üldkirjeldus

Kasutajal on võimalik vaadata rollis valitud asutuse arengukava koos selle perioodile vastavate aktiivsete eesmärkide andmetega.

Arengukava vaatamise vaatesse saab liikuda kas:

1. töölaua kaudu või
2. kasutajale jagatud URL-i kaudu.

Kui kasutaja on valinud asutuse rolli, pääseb ta töölaualt arengukava vaatamise vaatesse juhul, kui:

• asutuse jaoks on juba loodud muudetav arengukava (protsess on täpsemalt kirjeldatud siin), ning
• kasutajal on arengukava vaatamise õigus, kuid puudub selle lisamise ja muutmise õigus.

URL-i kaudu vaate kasutamiseks peab vastav jagatud URL versioon olema eelnevalt loodud.

Ametikoha rollis kasutaja seda vaadet ei kasuta, sest tal on õigus hallata oma ametikoha arengukava. Seetõttu suunatakse ta töölaual lingile "Arengukava" vajutamisel alati vaatesse: PM: UC: Arengukava lisamine/muutmine.

Seotud Jira task

NSIL-1051 - Getting issue details... STATUS

Kasutajaliides

Jäljerida

Avaleht → Töölaud → Arengukava

Disainid

Eeltingimused

Kui vaade avatakse URL-i kaudu, siis autentimine ei ole vajalik.

Kui vaade avatakse töölaua kaudu, peab:

• kasutaja olema sisse loginud ja valinud asutuse rolli;
• arengukava olema asutusepõhine ja muudetav:
  • DevelopmentPlan.developmentPlanScope = "INSTITUTIONAL"
  • DevelopmentPlan.editable = true
• kasutajal olema seos arengukava asutusega ning selle asutuse arengukava vaatamise õigus. 
  • DevelopmentPlan.institution.id = kasutaja valitud rolliga seotud asutus,
  • Õigust reguleerib privileeg: HSILM_PLANNING_DEV_PLAN_VIEW.
• Ametikoha rollis kasutaja seda vaadet ei kasuta, sest tal on õigus hallata oma ametikoha arengukava.
• Planeerimise meeskonnaliikme rolli kasutajatel puudub ligipääs arengukavadele ja nende versioonidele.

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

Funktsionaalsus

Selgitused

1. Vaate avamisel:
   1. Erinevus töölaua ja URL-i kaudu avamise vahel:

      1. Töölaua kaudu avamisel kuvatakse kasutajale rollis valitud asutuse muudetava arengukava andmed.

      2. URL-i kaudu avamisel kuvatakse kasutajale URL-is viidatud arengukava versiooni andmed. 

   2. Kasutajaliides käivitab päringu arengukava põhiandmete saamiseks.
      1. Kui kasutaja jõudis vaatesse töölaua kaudu:
         1. Käivitatakse päring rollis valitud asutuse muudetava arengukava saamiseks: PM: API: DevelopmentPlan: GET /planning-api/development-plans.
            1. Päringu sisend:
               1. developmentPlanScope = "INSTITUTIONAL"
               2. institutionId = kasutaja valitud rolliga seotud asutuse ID
      2. Kui kasutaja avas vaate URL-i kaudu:
         1. Käivitatakse päring URL-is viidatud arengukava versiooni andmete saamiseks: PM: API: DevelopmentPlan: GET /planning-api/public/development-plan-versions.
            1. Päringu sisend sõltub sellest, kas tegemist on avaliku või mitteavaliku lingiga: 
               1. Mitteavalik link - kui URL-is sisaldub versiooni ID (nt .../arengukava-versioon/{id}): 
                  1. Käivitatava päringu sisend:
                     1. versionId = URL-is sisalduv arengukava versiooni ID
                     2. Näide: .../arengukava-versioon/6758a48d7f520f05d967d39a/
               2. Avalik link - kui URL-is sisaldub alias (nt .../arengukava-versioon/{regCode}/{alias} või .../arengukava-versioon/{personalCode}/{alias}
                  
                  1. Käivitatava päringu sisendid: 
                     1. publicUrlAlias = URL-is sisalduv alias väärtus
                     2. institutionRegCode = URL-is sisalduv asutuse registrikood (kui eksisteerib)
                     3. personalCode = URL-is sisalduv isikukood (kui eksisteerib) 
                     4. jobsite???
                  2. Näited:
                     1. Asutuse arengukava: .../arengukava-versioon/1234556/arengukava-2025-2028
                        1. → institutionRegCode = 1234556, publicUrlAlias = arengukava-2025-2028. 
                     2. Isiklik arengukava: .../arengukava-versioon/51107121760/minu-arengukava
                        1. → personalCode = 51107121760, publicUrlAlias = minu-arengukava
      3. Kui arengukava andmetes sisaldub viide logole (logoFileId != NULL), tehakse logo allalaadimise päring: 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. PM: API: DevelopmentPlan: GET /planning-api/public/development-plan-versions.response.id
            2. logoFileId = arengukava logo faili metaandmete ID
               1. PM: API: DevelopmentPlan: GET /planning-api/development-plans.response.logoFileId
               2. PM: API: DevelopmentPlan: GET /planning-api/public/development-plan-versions.response.logoFileId
   3. Kasutajaliides kuvab kõik seni päringutega saadud andmed.
   4. Kasutajaliides käivitab päringud arengukava sektsioonide vormielementide saamiseks:
      1. Iga sektsiooni kohta tehakse 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. PM: API: DevelopmentPlan: GET /planning-api/public/development-plan-versions.response.sections.id
            2. developmentPlanId = arengukava ID
               1. PM: API: DevelopmentPlan: GET /planning-api/development-plans.response.id
               2. PM: API: DevelopmentPlan: GET /planning-api/public/development-plan-versions.response.id
         2. Kui mõni päringuga saadud vormielement on pilt (inputType = "IMAGE"), laaditakse sellega seotud fail failihoidlast: 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/{developmentPlanId}/sections/{sectionId}/elements.response.elements.sectionId
               4. developmentPlanId = arengukava ID
                  1. PM: API: DevelopmentPlan: GET /planning-api/development-plans/{developmentPlanId}/sections/{sectionId}/elements.response.elements.developmentPlanId
      2. Kasutajale kuvatakse saadud sektsiooni vormielemendid.
      3. Seejärel tehakse päring järgmise sektsiooni vormielementide saamiseks. Protsess kordub seni, kuni kõigi sektsioonide elemendid on kätte saadud.
   5. Kui arengukavale on määratud algus- ja lõpukuupäevad:
      1. PM: API: DevelopmentPlan: GET /planning-api/development-plans.response.startDate != NULL ja endDate != NULL
      2. PM: API: DevelopmentPlan: GET /planning-api/public/development-plan-versions.response.startDate != NULL ja endDate != NULL
      3. Siis käivitatakse päring eesmärkide saamiseks: PM: API: DevelopmentPlan: GET /planning-api/development-plan-goals.
         1. 1. Päringu sisend:
               
               1. developmentPlanId = arengukava ID
                  1. PM: API: DevelopmentPlan: GET /planning-api/development-plans.response.id
                  2. PM: API: DevelopmentPlan: GET /planning-api/public/development-plan-versions.response.id
            2. Päringu tulem sõltub sellest, kas tegemist on muudetava arengukavaga või URL kaudu jagatud versiooniga:
               1. Kui tegemist on muudetava arengukavaga (editable = true), siis tagastatakse arengukava asutuse aktiivsed eesmärgid, mis kattuvad arengukava perioodiga vähemalt osaliselt.
               2. Kui tegemist on URL kaudu jagatud arengukava mittemuudatava versiooniga (editable = false), siis tagastatakse kõik selle versiooni külge salvestatud eesmärgid, s.t. eesmärgid, mis:
                  • eksisteerisid verisooni genereerimise hetkel,
                  • olid aktiivses staatuses,
                  • ja kattusid versiooni perioodiga vähemalt osaliselt.
            3. Eesmärgi staatused on täpsemalt kirjeldatud lehel PM Eesmärgi staatused tööprotsessis.
   6. Kasutajale kuvatakse arengukava eesmärkide nimekiri.
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: GET /planning-api/public/development-plan-versions.response.sections.previousSectionId
   2. Sektsioonis olevad vormielemendid kuvatakse samuti vastavalt määratud järjestusele.
      
      1. PM: API: DevelopmentPlan: GET /planning-api/development-plans/{developmentPlanId}/sections/{sectionId}/elements.response.elements.previousElementId
   3. "Eesmärkide" plokk kuvatakse alati, ka juhul, kui päring ei tagasta ühtegi eesmärki.
      
      1. Kui eesmärke ei ole, kuvatakse tekst: "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 pealkiri sisaldab eesmärgi järjekorranumbrit ja nimetust.

            1. PM: API: DevelopmentPlan: GET /planning-api/development-plan-goals.response.goals.name
            2. Järjekorranumber määratakse eesmärgi positsiooni põhjal tagastatud goals[] massiivis.
         3. Vaikimisi on avatud esimese eesmärgi akordion, teised on suletud. 
         4. 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 nende kirjelduse alusel. 
               1. PM: API: DevelopmentPlan: GET /planning-api/development-plan-goals.response.goals.metrics.description
            3. Vaikimisi on avatud esimese mõõdiku akordion, teised on suletud. 
            4. Mõõdiku akordioni sees kuvatakse kõik näitajad üksteise all. 
   4. Akordionite jaoks kehtib üldine reegel: iga uue akordioni avamisel ei suleta eelmist, st et mitu akordionit võivad olla samaaegselt avatud.

Andmed

Kasutaja tegevused