NSILM

Sisukord

Üldkirjeldus

Kasutajal on võimalus luua arengukava hetkeseisu kajastav PDF-versioon, mis salvestatakse süsteemi ja laaditakse alla kasutaja arvutisse.

Soovi korral saab kasutaja sama PDF-faili uuesti alla laadida vaates PM: UC: Arengukava kehtivate jagamiste vaatamine ja kustutamine.

PDF-i genereerimist saab algatada ja kehtivate jagamiste nimekirja avada vaates PM: UC: Arengukava lisamine/muutmine.

  • Asutusepõhise arengukava puhul peab kasutajal olema vastava asutuse arengukava lisamise ja muutmise õigus.
  • Isikupõhise arengukava puhul annab kasutajale õiguse luua ja alla laadida oma kehtivate ja lõppenud ametikohtadega seotud arengukavade PDF-versioone tema isikukood.

Seotud Jira taskid

NSIL-1068 - Getting issue details... STATUS

NSIL-1062 - Getting issue details... STATUS

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
    • 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 PDF-versioone.

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

Funktsionaalsus

  1. Arengukava PDF-versiooni genereerimiseks kasutatakse päringut: PM: API: DevelopmentPlan: POST /planning-api/development-plans/{developmentPlanId}/pdf-versions.
    1. Päringu sisend:
      1. developmentPlanId = muudetava arengukava ID, mille andmete põhjal uus PDF-versioon genereeritakse
        1. PM: API: DevelopmentPlan: GET /planning-api/development-plans.response.id
        2. PM: API: DevelopmentPlan: POST /planning-api/development-plans.response.id
    2. Selgitused:
      1. PDF-versiooni saab genereerida ainult muudetava (editable = true) arengukava põhjal. 
      2. Päringu tulemusel genereeritakse PDF-fail, mis sisaldab kõiki PM: UC: Arengukava lisamine/muutmine vaates kuvatavaid arengukava andmeid.
      3. Arengukava PDF-faili tiitellehel kuvatakse päritolu ja genereerimise aeg.
        1. nt. 'Haridussilm 18.11.2023 12:20:14'
      4. PDF-i ei lisata neid sektsioone, millele on märgitud "Peida dokumendis".
        1. Samuti ei lisata sektsiooni alla kuuluvaid vormielemente.
      5. Genereeritud PDF-fail salvestatakse failisüsteemi.
      6. Andmebaasis lisatakse uus PDF-versiooni kirje, mis sisaldab:
        1. viide kasutajale, kes genereerimise algatas,
        2. PDF-i loomise aega,
        3. viidet loodud failile.
      7. Andmebaasi eraldi koopiat arengukava andmetest ei salvestata.

Andmed

Arengukava PDF-faili andmed on analoogsed vaatega: PM: UC: Arengukava lisamine/muutmine / PM: UC: Arengukava vaatamine.

Andmeväli PDF-failisAndmebaasi väliSelgitusNäidisväärtus
Tiitelleht-Tiitelleht sisaldab maksimaalselt ühte lehte.-
Tiitellehe päis - Asutuse logo ja nimetus

Objektid#DevelopmentPlan.logoFileId, mille developmentPlanId = arengukava ID, mille kohta arengukava genereeritakse.

Objektid#DevelopmentPlan.institution.name, mille developmentPlanId = arengukava ID

Asutuse logo ja nimetus, kuvatakse keskel.

Logo lisatakse ainult siis, kui see on olemas.

"Miina Härma Gümnaasium"
Tiitellehe sisu - Dokumendi pealkiri

Objektid#DevelopmentPlan.title, mille developmentPlanId = arengukava ID

Objektid#DevelopmentPlan.startDate, mille developmentPlanId = arengukava ID

Objektid#DevelopmentPlan.endDate, mille developmentPlanId = arengukava ID

Arengukava pealkiri ja periood, kuvatakse keskel.

Periood esitatakse kujul [algusaasta]-[lõppaasta].

"Arengukava

2025-2028"

Tiitelehe jalus - Süsteemi nimi ja aegSüsteem nimi ja genereerimise aeg (serveri aeg).

Faili loonud süsteemi nimi ja aeg formaadis dd.mm.yyyy hh:mm:ss, kuvatakse keskel.

Lisatakse PDF-i genereerimise hetkel.

Süsteemi nimeks kuvatakse vaikimisi "Haridussilm". 

"Haridussilm

27.04.2025 12:37:07"

Arengukava sisulehed

-

Arengukava sisulehtedel kuvatakse esmalt eraldi peatükkidena arengukava sektsioonid. Iga sektsiooni kohta on kirjas selle pealkiri, tekstid, pildid ja PBI aruanded. Sektsioonide järel kuvatakse peatükk, kus on esitatud arengukava eesmärgid. Iga eesmärgi kohta on eraldi alampeatükk, kus on esitatud selle pealkiri, kirjeldus, mõõdikud ja tegevused.

-
Arengukava peatükid

-

Iga sektsiooni kohta on eraldi peatükk. Sektsioonide järel kuvatakse arengukava eesmärgide peatükk.

-
Arengukava sektsiooni peatükk

-

Sektsioonid kuvatakse nende lisamise järjekorras. Pärast sektsioone kuvatakse eraldi peatükk, kus on esitatud arengukava eesmärgid.

-
Sektsiooni peatüki pealkiri

Objektid#DevelopmentPlanSection.name, mille developmentPlanId = arengukava ID

Peatüki pealkirjana kuvatakse sektsiooni nimetus. 

"Sissejuhatus"
Sektsiooni peatüki sisu - tekst

Objektid#DevelopmentPlanElement.elementValue, mille developmentPlanSectionId = sektsion ID, mille andmeid peatükis kuvatakse.

Sektsioonile lisatud tekst.

-
Sektsiooni peatüki sisu - pilt

Objektid#File.fileSystemId, mille id = Objektid#DevelopmentPlanElement.elementValue, mille developmentPlanSectionId = sektsion ID, mille andmeid peatükis kuvatakse.

Objektid#File.title, mille id = Objektid#DevelopmentPlanElement.elementValue, mille developmentPlanSectionId = sektsion ID, mille andmeid peatükis kuvatakse.

Sektsioonile lisatud pilt.

Pildi all kuvatakse selle pealkiri. 

-
Sektsiooni peatüki sisu - PBI aruanne

Objektid#DevelopmentPlanElement.report, mille developmentPlanSectionId = sektsion ID, mille andmeid peatükis kuvatakse.

Sektsioonile lisatud PBI aruanne.

-
Arengukava eesmärkide peatükk

-

Arengukava eesmärgid kuvatakse eraldi peatükis, kus iga eesmärgi kohta on üks alampeatükk. Eesmärgid on järjestatud previousGoalId alusel. 

-
Arengukava eesmärkide peatüki pealkiri

-

Pealkirjana kuvatakse tekst  "Eesmärgid".

"Eesmärgid"
Arengukava eesmärkide peatükk - Alampeatüki pealkiri

Objektid#DevelopmentPlanGoal.name, mille id = eesmärgi ID, mille developmentPlanId = arengukava ID

Alampeatüki pealkirjana kuvatakse eesmärgi pealkirja tekst. 

"1. Luua tõhus keskkond"
Alampeatüki sisu - Eesmärgi kirjeldus

Objektid#DevelopmentPlanGoal.description, mille id = eesmärgi ID, mille developmentPlanId = arengukava ID

Kuvatakse eesmärgi kirjelduse tekst. 

"Luua tõhus ja harmooniline meeskonnatöö keskkond, kus iga liige tunneb end kaasatuna, inspireerituna ja motiveerituna, tagades seeläbi parema koostöö tulemuste ning ühise eesmärgi saavutamise."
Alampeatüki sisu - Eesmärgi mõõdikud

Objektid#DevelopmentPlanGoal.metrics.createdAt, mille id = eesmärgi ID, mille developmentPlanId = arengukava ID

Eesmärgi mõõdikud kuvatakse lisamise järjekorras. Iga mõõdiku kohta kuvatakse seda kirjeldav tekst ja PBI aruanded. 

-
Eesmärgi mõõdik - Mõõdiku kirjeldus

Objektid#DevelopmentPlanGoal.metrics.description, mille id = eesmärgi ID, mille developmentPlanId = arengukava ID

Kuvatakse mõõdiku kirjelduse tekst.

-
Eesmärgi mõõdik - Aruanded

Objektid#DevelopmentPlanGoal.metrics.reports.workspaceId, mille id = eesmärgi ID, mille developmentPlanId = arengukava ID

Objektid#DevelopmentPlanGoal.metrics.reports.reportId, mille id = eesmärgi ID, mille developmentPlanId = arengukava ID

Objektid#DevelopmentPlanGoal.metrics.reports.bookmark, mille id = eesmärgi ID, mille developmentPlanId = arengukava ID

Kuvatakse mõõdikule lisatud PBI aruanded lisamise järjekorras. 

-
Eesmärgi mõõdik -Mõõdiku sihttasemed

-

Iga mõõdiku kohta kuvatakse tabeli kujul selle sihttasemed. Iga sihttaseme kohta kuvatakse tabelis üks rida. Sihttasemed on järjestatud lisamise järjekorras.

-
Mõõdiku sihttasemed - Aasta

Objektid#DevelopmentPlanGoal.metrics.targets.year, mille id = eesmärgi ID, mille developmentPlanId = arengukava ID

Tabeli esimeses veerus kuvatakse sihtaseme aasta."2025"
Mõõdiku sihttasemed - Sihttase

Objektid#DevelopmentPlanGoal.metrics.targets.description, mille id = eesmärgi ID, mille developmentPlanId = arengukava ID

Tabeli teises veerus kuvatakse sihttaseme tekst.-

Alampeatüki sisu - Eesmärgi tegevused

-

"Eesmärgid" peatükis kuvatakse eesmärgi mõõdikute järel alapeatükk, kus on esitatud kõik eesmärgi tegevused tabeli kujul. Iga tegevuse kohta kuvatakse tabelis üks rida. 

-
Alapeatüki "Eesmärgi tegevused" pealkiri

-

Alapeatüki pealkirjaks kuvatakse tekst "Tegevused".

"Tegevused"
Eesmärgi tegevuste tabel

-

Tabelis kuvatakse kõik eesmärgiga seotud tegevused. Iga tegevuse kohta kuvatakse tabelis üks rida.


Eesmärgi tegevuste tabel - Esimene veerg - Pealkiri-Veeru pealkirjana kuvatakse "Tegevuse nimetus"."Tegevuse nimetus"
Eesmärgi tegevuste tabel - Esimene veerg - Väärtus

Objektid#DevelopmentPlanGoal.activities.name, mille id = eesmärgi ID, mille developmentPlanId = arengukava ID

Objektid#DevelopmentPlanGoal.activities.startDate, mille id = eesmärgi ID, mille developmentPlanId = arengukava ID

Objektid#DevelopmentPlanGoal.activities.endDate, mille id = eesmärgi ID, mille developmentPlanId = arengukava ID

Tabeli esimeses veerus kuvatakse tegevuse nimetus. Selle all kuvatakse tegevuse periood kujul: [alguskuupäev]-[lõpukuupäev].

"Tegevuse nimetus 1
01.01.2025-31.12.2025"
Eesmärgi tegevuste tabel - Järgnevad veerud - Pealkiri

Objektid#DevelopmentPlan.startDate, mille developmentPlanId = arengukava ID

Objektid#DevelopmentPlan.endDate, mille developmentPlanId = arengukava ID

Tegevuse nimetuse veeru järel kuvatakse veerud, mille pealkirjaks on aastad arengukava perioodist (üks veerg iga aasta kohta), alates arengukava algusaastast kuni lõpuaastani, sammuga 1 aasta.

"2025, "2026", "2027" jne.
Eesmärgi tegevuste tabel - Järgnevad veerud - Väärtus

Objektid#DevelopmentPlanGoal.activities.startDate, mille id = eesmärgi ID, mille developmentPlanId = arengukava ID

Objektid#DevelopmentPlanGoal.activities.endDate, mille id = eesmärgi ID, mille developmentPlanId = arengukava ID

Kui tegevuse periood katab antud aasta, kuvatakse selle tegevuse real vastava aasta veerus linnuke. -