Üldkirjeldus

Teenus võimaldab luua hindamise kokkuvõtte andmeid.

Seotud andmeobjektid:

NSIL-717 - Getting issue details... STATUS NSIL-747 - Getting issue details... STATUS NSIL-960 - Getting issue details... STATUS NSIL-961 - Getting issue details... STATUS NSIL-1101 - Getting issue details... STATUS NSIL-1367 - Getting issue details... STATUS

Eeltingimused ja kasutusõigused

Kui tegemist on asutusepõhise hindamisega (assessmentScope = INSTITUTIONAL):
- Kasutajal peab olema hindamise valdkonnaga seotud hindamise kokkuvõtte haldamise õigus hindamisega seotud asutuses.
  - Classifier.classifierItemCode = Assessment.domain
  - Classifier.classifierAttributeDefinitionCode = ASSESSMENT_SHARE_MANAGE_PRIVILEGE
  - Classifier.attributeValue = Kasutaja poolt valitud rolli privileegide hulgas olev privileeg.
  - Assessment.institution.id = Kasutaja poolt valitud rolliga seotud asutus.
Kui tegemist on isikupõhise hindamisega (assessmentScope =INDIVIDUAL) ja mittehierarhilise hindamisega või hierarhilise hindamise peamise hindamisega (assessmentHierarchyType = null või MAIN_ASSESSMENT (!= SUB_ASSESSMENT)):
- Päringu käivitanud kasutaja on isik, kelle suhtes hindamist läbi viiakse.
  - Assessment.presonalCode = Päringu käivitanud isiku isikukood.
Kui kasutaja on hindamise meeskonna liige (Kehtib asutusepõhistel ja isikupõhistel hindamistel).
- Kasutajal peab olema hindamise valdkonnaga seotud hindamise kokkuvõtte haldamise õigus töödeldava hindamisega seoses ja kasutaja peab olema seotud hindamisega.
  - AssessmentTeamMember.personalCode = Päringu käivitanud isiku isikukood.
  - AssessmentTeamMember.objectStatus = CURRENT
  - Classifier.classifierItemCode = Assessment.domain
  - Classifier.classifierAttributeDefinitionCode = ASSESSMENT_SHARE_MANAGE_PRIVILEGE
  - Classifier.attributeValue = Kasutaja poolt valitud rolli privileegide hulgas olev privileeg.
Kui tegemist on isikupõhise hierarhilise hindamise alamhindamisega (assessmentHierarchyType = SUB_ASSESSMENT), siis objekti andmeid hallata ei saa.

Sisendid

Atribuut	Kohustuslikkus, mitmesus	Tüüp	Vaikeväärtus, valideerimine	Kirjeldus, täiendav info
assessmentId	1	String	Hindamine ei tohi olla kustutatud. Assessment.id = assessmentId	Hindamise id.
assessmentSummaryType	1	Enum	Lubatud väärtused: PDF PDF tüüpi on lubatud kasutada, kui hindamine ei ole lõpetatud (Assessment.endDate = null) URL	Määrab, mis liiki kokkuvõte on.
phaseTypes	1..*	EHIS Classifier list	Lubatud Klassifikaatorid#KlassifikaatorASSESSMENT_PHASE väärtused, mis on hindamisele lisatud. Assessment.phaseTypes = phaseTypes Kui hindamise planeerimise etapp või enesehindamise etapp on hindamisele lisatud, siis neid etappe saab alati kokkuvõttele lisada. Assessment.phaseTypes = PLANNING ja SELF_ASSESSMENT Kui välishindamise etapp on hindamisele lisatud, siis seda saab kokkuvõttele lisada, kui enesehindamise etapp on kinnitatud. Assessment.phaseTypes hulgas on EXTERNAL_ASSESSMENT väärtus AssessmentPhase.confirmationTime != null, mille phaseType = SELF_ASSESSMENT ja assessmentId = Sisendis esitatud assessmentId väärtus. Kui hindamise tulemuste etapp on hindamisele lisatud ja hindamisele on välishindamise etapp lisatud, siis saab hindamise tulemuste etappi kokkuvõttele lisada kui välishindamise etapp on kinnitatud. Assessment.phaseTypes hulgas on EXTERNAL_ASSESSMENT ja NEEDS_FOR_IMPROVEMENT väärtused. AssessmentPhase.confirmationTime != null, mille phaseType = EXTERNAL_ASSESSMENT ja assessmentId = Sisendis esitatud assessmentId väärtus. Kui hindamise tulemuste etapp on hindamisele lisatud ja hindamisele ei ole välishindamise etappi lisatud, siis saab hindamise tulemuste etappi kokkuvõttele lisada kui enesehindamise etapp on kinnitatud. Assessment.phaseTypes hulgas on NEEDS_FOR_IMPROVEMENT väärtus ja puudub EXTERNAL_ASSESSMENT väärtus. AssessmentPhase.confirmationTime != null, mille phaseType =SELF_ASSESSMENT ja assessmentId = Sisendis esitatud assessmentId väärtus.	Nimekiri etappidest, mille kohta kokkuvõte genereeritakse. Väärtusena klassifikaatori ASSESSMENT_PHASE elemendi viide.
urlPublic	0..*	Boolean	Lubatud kasutada ja kohustuslik, kui assessmentSummaryType = URL. Lubatud väärtused: true - Link on avalik false - Link ei ole avalik	Määrab, kas jagatav link on avalik või mitte. Kasutatakse, kui kokkuvõte on URL tüüpi. true - Link on avalik false - Link ei ole avalik
publicUrlAlias	0..1	String	Lubatud kasutada ja kohustuslik, kui urlPublic = true. Peab vastama URI path reeglitele. Peab olema 3-250 tähemärki. Peab olema asutuse kõikide kokkuvõtete objektide üleselt unikaalsed. Kui Assessment.institution.regCode != null, siis ei tohi eksisteerida ühtegi AssessmentSummary.publicUrlAlias väärtust, mille AssessmentSummary.publicUrlAlias = sisendis esitatud publicUrlAlias väärtus ja AssessmentSummary.institution.regCode = Assessment.institution.regCode Kui Assessment.institution.regCode = null, siis ei tohi eksisteerida ühtegi AssessmentSummary.publicUrlAlias väärtust, mille AssessmentSummary.publicUrlAlias = sisendis esitatud publicUrlAlias väärtus ja AssessmentSummary.institution.ehakCode = Assessment.institution.ehakCode Kui Kui Assessment.institution.regCode = null ja Assessment.institution.ehakCode = null, siis ei tohi eksisteerida ühtegi AssessmentSummary.publicUrlAlias väärtust, mille AssessmentSummary.publicUrlAlias = sisendis esitatud publicUrlAlias väärtus ja AssessmentSummary.institution.regCode = Assessment.personalCode FE jaoks tuleb tagastada äriline veakood ALIAS_IS_ALREADY_IN_USE.	Avalikule lingile määratud aliase väärtus.

Väljundid

Atribuut	Kohustuslikkus, mitmesus	Tüüp	Kirjeldus, täiendav info
id	1	UUID	Objekti id (UUID).
assessmentId	1	FK	Viide hindamisele, millega jagamise andmed seotud on. Viitab Assessment.id väärtusele.
institution.regCode	0..1	String	Asutuse registrikood või selle puudumisel isiku isikukood.
institution.type	1	EHIS Classifier	Asutuste liik. (KOV, õppeasutus)
institution.ehakCode	0..1	String	Asutuse (KOVi) EHAK kood.
assessmentSummaryType	1	Enum	Määrab, mis liiki kokkuvõte on. PDF URL
phaseTypes	1..*	EHIS Classifier list	Nimekiri etappidest, mille kohta kokkuvõte genereeritakse. Väärtusena klassifikaatori ASSESSMENT_PHASE elemendi viide.
urlPublic	0..1	Boolean	Määrab, kas jagatav link on avalik või mitte. Kasutatakse, kui kokkuvõte on URL tüüpi. true - Link on avalik false - Link ei ole avalik
publicUrlAlias	0..1	String	Avalikule lingile määratud aliase väärtus.
files	0..*	Array	Nimekiri failidest. Kasutatakse, kui kokkuvõte on PDF tüüpi.
files.fileId	1	FK	Viide faili metaandmetele. Viitab File.id väärtusele.
generator.firstName	1	String	Kokkuvõtte loonud kasutaja eesnimi.
generator.lastName	1	String	Kokkuvõtte loonud kasutaja perekonnanimi.
generator.profileColor	1	String	Kokkuvõtte loonud kasutaja profiili värvikood.
generatedAt	1	Date and time	Kokkuvõtte loomise aeg.
objectStatus	1	String	Objekti staatus. CURRENT - Kehtiv DELETED - Kustutatud

Tegevused

Süsteem kontrollib, kas kasutajal on õigust päringut teostada.
1. Kui kasutajal ei ole õigust päringut teostada, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
Süsteem kontrollib, kas andmed vastavad nõuetele.
1. Kui andmed ei vasta nõuetele, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
Süsteem loob hindamise kokkuvõtte andmed.
- Süsteem loob Objektid#AssessmentSummary objekti:
  - id = UUID
  - assessmentId = Sisendis esitatud assessmentId väärtus.
  - institution.regCode = Assessment.institution.regCode
    - Kui Assessment.institution.regCode = null, siis institution.regCode = Assessment.personalCode
  - institution.ehakCode = Assessment.institution.ehakCode
  - assessmentSummaryType = Sisendis esitatud assessmentSummaryType väärtus.
  - phaseTypes = Sisendis esitatud phaseTypes väärtused.
  - urlPublic = Sisendis esitatud urlPublic väärtus.
  - publicUrlAlias = Sisendis esitatud publicUrlAlias väärtus.
  - files.fileId = null
  - generator.firstName = Objekti loonud kasutaja eesnimi.
  - generator.lastName = Objekti loonud kasutaja perekonnanimi.
  - generator.profileColor =
    - Kui samal isikul on sama hindamise raames olemas värvikood, siis kasutatakse sama värvikoodi.
      - Kui eksisteerib Objektid#AssessmentSummary objekt, mille assessmentId ja generator.firstName ja lastName väärtused on samad, mis loodaval AssessmentSummary objektil, siis profileColor = leitud generator.profileColor
    - Muudel juhtudel valitakse värv HS visualiseerimise põhimõtete primaarse värvipaletti värvide hulgast. Värvid määratakse meeskonna liikmele selliselt, et esmalt valitakse kokkuvõtte loonud kasutajale värv, mida ühelegi teisele kokkuvõtte loonud kasutajale sama hindamise raames määratud ei ole. Kui kõik unikaalsed värvid on hindamise raames kasutusel, siis valitakse kokkuvõtte loonud kasutajale värv, mida on kõige vähem kokkuvõtte loonud kasutajatele, sama hindamise raames määratud.
      - Kasutatavad värvid:
        #14AAAD - teal
        #468CDF - sinine
        #9467BD - lilla
        #E377C2 - roosa
        #FF7F0E - oranž
        #E6BC05 - kollane
        #2CA02C - roheline
        #7F7F7F - hall
        #8C564B - pruun
        #D62728 - punane
        #B44FB0 - soe lilla
        #1F77B4 - soe sinine
        #BCBD22 - soe roheline
        #D17805 - ooker
  - generatedAt = Päringu käivitamise aeg.
  - audit (loomine) = audit (loomine)
Kui kokkuvõtte tüüp on PDF fail (AssessmentSummary.assessmentSummaryType = PDF) ja hindamine ei ole lõpetatud (Assessment.endDate = null), siis:
1. Süsteem loob PDF faili, mis sisaldab sisendis esitatud etappide andmeid.
  - https://www.figma.com/design/mPPdrh04luwBeiX856NQPP/NAPO---TWN?node-id=10332-29144&node-type=section&t=eZA6Ri7wk01NqgSP-0
2. Süsteem salvestab genereeritud faili failisüsteemi.
3. Süsteem salvestab faili metaandmed.
  - Süsteem loob Objektid#File objekti:
    - id = UUID
    - Faili asukoha andmestik failisüsteemis
    - fileName = Asutuse nimi + faili genereerimise aeg sekundi täpsusega.
    - mimeType = Faili mime tüüp.
    - size = Faili suurus baitides.
    - objectStatus = CURRENT
    - audit (loomine) = audit (loomine)
4. Süsteem seob faili kokkuvõtte objektiga.
  - Süsteem uuendab loodud Objektid#AssessmentSummary objekti:
    - files.fileId = Loodud File.id
Süsteem tagastab loodud andmed.

GS: AssessmentSummary: API: POST /quality-api/assessments/{assessmentId}/assessment-summaries

Üldkirjeldus

Eeltingimused ja kasutusõigused

Sisendid

Väljundid

Tegevused