PM: UC: Arengukava URL-versiooni loomine

Sisukord

Üldkirjeldus

Kasutaja saab luua asutuse/ametikoha muudetava arengukava põhjal URL-ina jagatava versiooni ja saada vastava lingi. Soovi korral võib kasutaja määrata lingile ka alias'e. 

Arengukava URL-versiooni loomise modaalaken avaneb vaates PM: UC: Arengukava lisamine/muutmine.

• Asutusepõhise arengukava puhul peab kasutajal olema vastava asutuse arengukava lisamise ja muutmise õigus.
• Isikupõhise arengukava puhul peab kasutajal olema seos arengukava ametikohaga, s.t. tegemist peab olema kasutaja kehtiva ametikohaga.

Loodud lingi kaudu saab kasutaja vaadata URL-versiooni vaates PM: UC: Arengukava vaatamine.

Seotud Jira taskid

NSIL-1013 - Getting issue details... STATUS

Kasutajaliides

Disainid

Eeltingimused

Kasutaja on sisse loginud ja valinud sobiva rolli:

• Kui tegemist on asutusepõhise arengukavaga (DevelopmentPlan.developmentPlanScope = "INSTITUTIONAL"):
  • Arengukava peab olema muudetav ja sellele peab olema määratud periood.
    • DevelopmentPlan.editable = TRUE,
    • DevelopmentPlan.startDate != NULL,
    • DevelopmentPlan.endDate != NULL.
  • Kasutajal peab olema seos arengukava asutusega ning selle asutuse arengukava lisamise ja muutmise õigus. 
    • DevelopmentPlan.institution.id = kasutaja valitud rolliga seotud asutus,
    • Õigust reguleerib privileeg: HSILM_PLANNING_DEV_PLAN_MANAGE.
• Kui tegemist on isikupõhise arengukavaga (DevelopmentPlan.developmentPlanScope = "INDIVIDUAL"):
  
  • Arengukava peab olema muudetav ja sellele peab olema määratud periood.
    • DevelopmentPlan.editable = TRUE,
    • DevelopmentPlan.startDate != NULL,
    • DevelopmentPlan.endDate != NULL.
  • Kasutaja peab olema arengukava omanik.
    • DevelopmentPlan.personalCode = kasutaja isikukood
  • Tal peab olema ka seos nii arengukava asutuse ning ka ametikohaga, st arengukava peab olema loodud tema kehtiva ametikoha kohta. 
    • DevelopmentPlan.institution.id = kasutaja valitud rolliga seotud asutus,
    • DevelopmentPlan.jobsite = kasutaja valitud rolliga seotud ametikoht.
  • Eraldi privileegi ei ole vaja - õiguse annab kasutaja kehtiv ametikoht. 
• Planeerimise meeskonnaliikme ja arhiivi rolli kasutajatel puudub ligipääs - nende kasutajatel ei ole õigust luua arengukavadest URL-versioone.

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

Funktsionaalsus

Selgitused

1. Kasutajale kuvatakse arengukava URL-versiooni loomise vaade, kus on võimalik: 
   1. genereerida arengukavast URL-ina jagatav versioon koos lingiga;
   2. märkida soov avaliku lingi loomiseks;
   3. sisestada alias, et muuta link lühemaks ja loetavamaks.
      
      1. Alias'e määramisel kehtib reegel, et sama alias saab sama asutuse/ametikoha piires korraga olla ainult ühel kehtival jagamise versioonil.
2. Kui kasutaja valib avaliku lingi loomise: 
   1. Kasutajaliides käivitab päringu rollis valitud asutuse/ametikoha olemasolevate URL-versioonide alias'te saamiseks: PM: API: DevelopmentPlan: GET /planning-api/development-plans/{developmentPlanId}/versions. 
      1. Päringu sisend:
         1. developmentPlanId = muudetava arengukava ID, mille vaates URL-versiooni loomine algatati
            1. PM: API: DevelopmentPlan: GET /planning-api/development-plans.response.id
            2. PM: API: DevelopmentPlan: POST /planning-api/development-plans.response.id
         2. versionType = "URL"
   2. Kasutajaliides kuvab tekstivälja, kuhu saab sisestada alias'e.
3. Kui kasutaja vajutab nuppu "Genereeri link":
   1. Kui kasutaja valis avaliku lingi loomise:
      1. Kui alias'e tekst pole sisestatud, kuvatakse veateade.
      2. Kui alias'e tekst on sisestatud, kontrollib kasutajaliides, kas see alias ei ole juba kasutusel:
         1. Kontrolli toimub eelnevalt tehtud arengukava versioonide päringu andmetel. 
            1. Kontrollitakse, et ükski päringuga saadud versiooni publicUrlAlias ei kattuks kasutaja poolt sisestatud alias'ega. 
            2. PM: API: DevelopmentPlan: GET /planning-api/development-plans/{developmentPlanId}/versions.response.developmentPlanVersions.publicUrlAlias != kasutaja väljale "Jagatava URL-i alias" sisestatud väärtus
         2. Kui kattuvus tuvastatakse, kuvatakse kasutajale veateade.  
   2. Kui alias on saadaval või link ei ole avalik, saadetakse päring uue URL-versiooni loomiseks: PM: API: DevelopmentPlan: POST /planning-api/development-plans/{developmentPlanId}/url-versions.
      
      1. Päringu sisend:
         1. developmentPlanId = muudetava arengukava ID, mille andmete põhjal uus URL-versioon luuakse
         2. urlPublic = true, kui kasutaja on märkinud avaliku lingi loomise soovi; muul juhul - false.
         3. publicUrlAlias = kasutaja sisestatud alias (ainult kui urlPublic = true)
   3. Kui päring õnnestub, genereerib kasutajaliides lingi just loodud versiooni andmete põhjal.
      1. NB! Arengukava versioonide lingid ei salvestu andmebaasis. 
      2. Lingi struktuur sõltub sellest, kas tegemist on avaliku või mitteavaliku lingiga: 
         1. Avalik link:
            1. Koosneb kasutaja määratud lingi alias'est ning:
               1. asutusepõhise arengukava puhul - arengukavaga seotud asutuse registrikoodist; 
                  •  .../arengukava-versioon/{regCode}/{alias}
                    • Näide: .../arengukava-versioon/{regCode}/{alias}. Näiteks ..../arengukava-versioon/1234556/arengukava-2025-2028
               2. isikupõhise arengukava puhul - isiku isikukoodist ja ametikoha tunnusest;
                  • .../arengukava-versioon/{personalCode}/{alias}
                    • Näide: .../arengukava-versioon/{personalCode/{alias}. Näiteks ..../arengukava-versioon/51107121760/minu-arengukava
                  • Kas kasutaja peaks saama kasutada sama alias’t erinevate ametikohtade arengukavade versioonide puhul?
            2. Andmeallikad:
               • Avalik URL: PM: API: DevelopmentPlan: POST /planning-api/development-plans/{developmentPlanId}/url-versions.response.urlPublic = true
               • regCode = PM: API: DevelopmentPlan: POST /planning-api/development-plans/{developmentPlanId}/url-versions.response.institution.regCode
               • personalCode = PM: API: DevelopmentPlan: POST /planning-api/development-plans/{developmentPlanId}/url-versions.response.personalCode
               • ametikoha tunnus?
               • alias = PM: API: DevelopmentPlan: POST /planning-api/development-plans/{developmentPlanId}/url-versions.response.publicUrlAlias
         2. Mitteavalik link:
            1. Koosneb ainult versooni identifikaatorist.
               1. .../arengukava-versioon/{id}/
                  1. Näide: .../arengukava-versioon/{id}/. Näiteks .../arengukava-versioon/6758a48d7f520f05d967d39a/
            2. Andmeallikad:
               1. Mitteavalik URL: PM: API: DevelopmentPlan: POST /planning-api/development-plans/{developmentPlanId}/url-versions.response.urlPublic = false
               2. id = PM: API: DevelopmentPlan: POST /planning-api/development-plans/{developmentPlanId}/url-versions.response.id
   4. Kui link on edukalt genereeritud:
      1. Kuvatakse eduteade ning genereeritud link koos täisdomeeniga.
      2. Lingi juures on nupp, mille abil saab selle kopeerida arvuti lõikepuhvrisse. 
      3. Nupp "Genereeri link" muutub mitteaktiivseks. Modaalaken jääb avatuks.
         1. Mitteaktiivse nupu peale hiirega liikumisel kuvatakse tooltip-tekst, mis selgitab, miks tegevus pole hetkel võimalik.
            1. nt. "Sisetage uus alias või muutke lingi avalikkuse seadeid, et genereerida uus versioon."
         2. Kui kasutaja muudab välja "Avalikult jagatav URL" või "Jagatav URL-i alias" väärtust, muutub nupp "Genereeri link" taas aktiivseks ja kasutaja saab genereerida uue lingi. 
         3. Uut URL-versiooni nuppu uuesti vajutades ei genereerita – luuakse ainult uus link.

Andmed

Kasutaja tegevused