Üldkirjeldus

Teenus võimaldab lisada arengukava sektsioonile uue vormielemendi.

Seotud andmeobjektid:

Seotud Jira taskid

NSIL-1000 - Getting issue details... STATUS

Eeltingimused ja kasutusõigused

Kui tegemist on asutusepõhise arengukavaga (DevelopmentPlan.developmentPlanScope = INSTITUTIONAL):
- Kasutajal on seos arengukava asutusega ning sama asutuse arengukava lisamise ja muutmise õigus.
  - DevelopmentPlan.institution.id = Kasutaja poolt valitud rolliga seotud asutus
  - Õigust reguleerib privileeg: HSILM_PLANNING_DEV_PLAN_MANAGE.
Kui tegemist on isikupõhise arengukavaga (DevelopmentPlan.developmentPlanScope = INDIVIDUAL):
- Kasutaja on arengukava omanik ja tal on seos nii arengukava asutuse kui ka ametikohaga.
  - DevelopmentPlan.personalCode = Kasutaja isikukood
  - DevelopmentPlan.institution.id = Kasutaja poolt valitud rolliga seotud asutus
  - DevelopmentPlan.jobsite = Kasutaja poolt valitud rolliga seotud ametikoht
- Eraldi privileegi ei ole vaja.
Arhiivi ja meeskonnaliikme rollis kasutajatel puudub õigus arengukava muuta.

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

Sisendid

Atribuut	Kohustuslikkus, mitmesus	Tüüp	Vaikeväärtus, valideerimine	Kirjeldus, täiendav info
sectionId	1	String	Peab eksisteerima ja olema seotud arengukavaga. sectionId = DevelopmentPlanSection.id, mille developmentPlanId = developmentPlanId	Viide arengukava sektsioonile, millele vormielement lisatakse.
developmentPlanId	1	String	Peab eksisteerima ja olema muudetav. developmentPlanId = DevelopmentPlan.id, mille editable = true	Viide arengukavale, kuhu sektsioon kuulub.
previousElementId	1	String	Kui on määratud, peab see eksisteerima ja kuuluma samasse sektsiooni. previousElementId = DevelopmentPlanElement.id, mille developmentPlanSectionId = sectionId	Viide vormielemendile, millele uus vormielement hakkab järgnema vormielementide järjekorras. Kui väärtus on NULL, kuvatakse sektsioon esimesena.
inputType	1	String	Väärtus peab vastama klassifikaatorile INPUT_TYPE. On lubatud ainult väärtused: TEXT_AREA IMAGE REPORT	Vormielemendi tüüp: tekst, pilt või aruanne.

Väljundid

Atribuut	Kohustuslikkus, mitmesus	Tüüp	Kirjeldus, täiendav info
id	1	String	Vormielemendi unikaalne identifikaator.
sectionId	1	String	Viide arengukava sektsioonile, kuhu vormielement kuulub.
developmentPlanId	1	String	Viide arengukavale, kuhu sektsioon kuulub.
previousElementId	1	String	Viide vormielemendile, mis eelneb käesolevale elemendile sektsiooni vormielementide järjekorras. Kui väärtus on NULL, kuvatakse sektsioon esimesena.
inputType	1	String	Vormielemendi tüüp. Väärtusena klassifikaatori INPUT_TYPE elemendi viide.
textValue	0..1	String	Teksti tüüpi vormielemendile määratud väärtus: tekstiala puhul sisestatud tekst koos lubatud vormindusega (B, I, U, nummerdatud /nummerdamata nimekirjad, link)
file	0..1	Object	Pildi tüüpi vormielemendiga seotud faili andmed. Kasutatakse ainult siis, kui inputType = IMAGE.
file.id	1	String	Viide seotud faili objektile (Objektid#File.id).
file.fileName	1	String	Faili nimetus koos faililaiendiga. Näiteks "minu pilt.png".
file.mimeType	1	String	Faili mime tüüp. Näiteks "image/x-png".
file.size	1	Integer	Faili suurus baitides.
file.title	0..1	String	Failile lisatud pealkiri.
report	0..1	Object	Vormielemendina lisatud näitaja andmed. Kasutatakse ainult siis, kui inputType = REPORT.
report.description	1	String	Näitaja kirjeldus.
report.selectedReports	1..*	Array	Nimekiri lisatud juhtimislaua aruannetest.
report.selectedReports.workspaceId	1	String	PBI aruande tööruumi identifikaator.
report.selectedReports.reportId	1	String	PBI aruande identifikaator.
report.selectedReports.bookmark	0..1	String	PBI aruandele rakendatud filtrite snapshot (base64 formaadis).

Tegevused

Süsteem kontrollib, kas kasutajal on õigust päringut teostada.
1. Kui kasutajal ei ole õigust, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
Süsteem kontrollib, kas sisendandmed vastavad nõuetele.
1. Kui andmed ei vasta nõuetele, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
Süsteem kontrollib, kas sisendis esitatud sektsioon (sectionId) eksisteerib ning on seotud muudetava arengukavaga:
1. Otsitakse Objektid#DevelopmentPlanSection objekti, mille:
  1. id = sisendis esitatud sectionId väärtus
  2. developmentPlanId = sisendis esitatud developmentPlanId väärtus
2. Kui vastavat sektsiooni ei leita, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
3. Otsitakse Objektid#DevelopmentPlan objekti, mille:
  1. id = sisendis esitatud developmentPlanId väärtus
  2. editable = true
4. Kui tingimustele vastavat arengukava ei leita, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
Süsteem lisab arengukava sektsioonile uue vormielemendi:
1. Luuakse uus Objektid#DevelopmentPlanElement objekt järgmiste väärtustega:
  1. id = UUID
  2. developmentPlanSectionId = sisendis esitatud sectionId väärtus
  3. previousElementId = sisendis esitatud previousElementId väärtus
  4. inputType= sisendis esitatud inputType väärtus
  5. textValue = NULL
  6. file = NULL
  7. report = NULL
Süsteem uuendab sektsiooni vormielementide järjekorda:
1. Otsitakse vormielement, mis hetkeseisuga järgneb sisendis esitatud previousElementId väärtusega elemendile:
  1. Otsitakse Objektid#DevelopmentPlanElement objekti, mille:
    1. id != just loodud vormielemendi ID (Objektid#DevelopmentPlanElement.id)
    2. developmentPlanSectionId = sisendis esitatud sectionId väärtus
    3. previousElementId = sisendis esitatud previousElementId väärtus.
  2. Kui sobivat elementi ei leita, logitakse viga.
2. Kui sobiv vormielement leitakse, uuendatakse see järgmiselt:
  1. previousElementId = just loodud vormielemendi ID (Objektid#DevelopmentPlanElement.id)
Süsteem tagastab arengukava sektsioonile lisatud vormielemendi andmed.