Üldkirjeldus

Teenus salvestab hindamismudeli komponentide hulka vormielementide andmed.

Seotud andmeobjektid:

NSIL-388 - Getting issue details... STATUS NSIL-605 - Getting issue details... STATUS NSIL-1286 - Getting issue details... STATUS

Eeltingimused ja kasutusõigused

Kasutaja poolt valitud rollil peab olema hindamisega seotud valdkonna haldamise õigus.
- AssessmentModel.domainType = Klassifikaatorid#KlassifikaatorDOMAIN, mis on seotud ASSESSMENT_MODEL_MANAGE_PRIVILEGE (attributeDefinitionCode) privileegiga, mis on kasutaja poolt valitud rollile lisatud.

Sisendid

Atribuut	Kohustuslikkus, mitmesus	Tüüp	Vaikeväärtus, valideerimine	Kirjeldus, täiendav info
assessmentModelId	1	UUID	Hindamismudel ei tohi olla kustutatud. AssessmentModel.objectStatus = CURRENT Hindamismudeli äriline staatus peab olema "Mustand" või "Kinnitatud". Mustand: AssessmentModel.isConfirmed = false Kinnitatud: AssessmentModel.isConfirmed = true, validFrom > päringu teostamise aeg. Hindamismudelile peab olema lisatud enesehindamise ja/või välishindamise etapp. AssessmentModel.phases hulgas peab olema etapp "Enesehindamine" ja/või "Välishindamine".	Hindamismudeli id (UUID).
sectionId	1	UUID	Sektsioon ei tohi olla kustutatud. AssessmentModelComponentSection.objectStatus = CURRENT	Hindamise komponendi sektsiooni id (UUID).
previousComponent.id	0..1	String	Kui määratud, siis sektsioon või vormielement ei tohi olla kustutatud. Sektsioon: AssessmentModelComponentSection.objectStatus = CURRENT, mille AssessmentModelComponentSection.id = previousComponent.id Element: AssessmentModelComponentSectionElement.objectStatus = CURRENT, mille AssessmentModelComponentSectionElement.id = previousComponent.id Kohustuslik, kui previousComponent.type on määratud. Peab olema sisendis esitatud sectionId alamkomponent.	Hindamise komponendi sektsiooni seadistuse objektile eelneva hindamise komponendi (sektsiooni, vormielemendi) id.
previousComponent.type	0..1		Lubatud väärtused: SECTION ELEMENT Kohustuslik, kui previousComponent.id on määratud.	Hindamise komponendi sektsiooni seadistuse objektile eelneva hindamise komponendi (sektsiooni, vormielemendi) tüüp.
contentType	1	EHIS Classifier	Peab olema CONTENT_TYPE hulgas kehtiv kirje.	Määrab elemendi tüübi.
label	1	String	3 - 250 tähemärki.	Vormielemendi silt
labelDisplayedOnAssessment	1	Boolean	Lubatud väärtused: true false	Määrab, kas vormielemendi silti kuvatakse hindamise vormil või mitte. true (Vaikimisi) - Silti kuvatakse hindamise vormil false - Silti ei kuvata hindamise vormil.
helpText	0..1	String	Lubatud kuni 2500 tähemärki.	Vormielemendi selgitus/abitekst.
pbiMetadata	0..1	Object	Kohustuslik, kui elemendi tüüp on mudeli haldaja sisend (contentType = ADMIN_INPUT) ja elemendi sisendi tüüp on PBI raport (inputType = REPORT). Muudel juhtudel ei tohi kasutada.	PBI aruande andmed. Kasutatakse kui elemendi sisendi tüüp on PBI aruanne (REPORT).
pbiMetadata.workspaceId	1	String	Peab olema 3 - 250 tähemärki.	PBI aruande tööruumi identifikaator.
pbiMetadata.reportId	1	String	Peab olema 3 - 250 tähemärki.	PBI aruande identifikaator.
phaseTypes	0..*	EHIS Classifier list	Lubatud kasutada kui elemendi sisendi tüüp on kasutaja sisend (contentType = USER_INPUT). Muudel juhtudel ei tohi kasutada. Peab olema ASSESSMENT_PHASE hulgas kehtiv kirje. Etapp peab olema lisatud hindamismudelile (AssessmentModel.phaseTypes = phaseTypes). Kohustuslik vähemalt üks etapp, kui elemendi tüüp on kasutaja sisend.	Nimekiri etappidest, kus elementi kasutatakse.
inputType	1	EHIS Classifier	Peab olema INPUT_TYPE hulgas kehtiv kirje, mille ADMIN_CONTEXT (attributeDefinitionCode) = ASSESSMENT (attributeDefinitionValue). Kohustuslik, kui elemendi tüüp on kasutaja sisend. inputType peab olema lubatud määratud contentType juures. Kui contentType = USER_INPUT, siis klassifikaatori atribuut CONTENT_TYPE (attributeDefinitionCode) = USER_INPUT (attributeDefinitionValue). Kui contentType = ADMIN_INPUT, siis klassifikaatori atribuut CONTENT_TYPE (attributeDefinitionCode) = ADMIN_INPUT (attributeDefinitionValue).	Vormielemendi sisendi formaat.
mandatory	0..1	Boolean	Lubatud kasutada kui elemendi tüüp on kasutaja sisend (contentType = USER_INPUT). Muudel juhtudel ei tohi kasutada. Kohustuslik, kui elemendi tüüp on kasutaja sisend. Lubatud väärtused: true false	Märge, mis näitab kas vormielemendi täitmine on kohustuslik või mitte.
synchronizedToDwh	0..1	Boolean	Lubatud kasutada kui elemendi tüüp on kasutaja sisend (contentType = USER_INPUT). Muudel juhtudel ei tohi kasutada. Kohustuslik, kui elemendi tüüp on kasutaja sisend. Lubatud väärtused: true false Vaikeväärtus, kui elemendi sisendi tüüp on PBI raport: false	Määrab, kas andmed sünkroniseeritakse hindamise juurest andmelattu või mitte.
optionTexts	0..*	Array	Lubatud kasutada kui elemendi tüüp on kasutaja sisend (contentType = USER_INPUT) ja vormielemendi tüüp on MULTIPLE_CHOICE (Mitmikvalik) või SINGLE_CHOICE (üksikvalik). Muudel juhtudel ei tohi kasutada. Nimekirjas peab olema vähemalt üks element. Variandi tekst peab olema 3 - 250 tähemärki.	Vormielemendi vastusevariandid.
percentageTargetLevel	0..1	Integer	Lubatud kasutada kui elemendi tüüp on kasutaja sisend (contentType = USER_INPUT) ja vormielemendi tüüp on osakaal (PERCENTAGE). Muudel juhtudel ei tohi kasutada. Ei ole kohustuslik. Lubatud väärtused 0 - 100.	Osakaalu sihttase.
scale	0..1	Object	Kohustuslik kasutada, kui elemendi tüüp on kasutaja sisend (contentType = USER_INPUT) ja vormielemendi tüüp on skaala (SCALE). Muudel juhtudel ei tohi kasutada.	Skaala objekt Kasutatakse juhul kui sisendi formaat väärtuseks on "skaala" (SCALE).
scale.valuesFrom	1	Integer	Lubatud väärtused 0 - 10. valuesFrom <= valuesUntil	Skaala väärtuste algus.
scale.valuesUntil	1	Integer	Lubatud väärtused 0 - 10. valuesFrom <= valuesUntil	Skaala väärtuste lõpp.
scale.values	1..*	Array	Kõik skaala väärtused peavad olema esitatud. Skaala vahemiku algus ja lõpp on väärtuste hulka kaasaarvatud.	Skaala väärtuste selgitused.
scale.values.value	1	Integer	scale.valuesFrom <= scale.values.value <= scale.valuesUntil Kõik väärtused võivad olla esitatud ühe korra. Kõik skaala väärtused peavad olema sisendis esitatud.	Skaala väärtus. Peab jääma ValuesFrom ja ValuesUntil vahele. Mõlemad on kaasaarvatud.
scale.values.valueText	0..1	String	Lubatud kuni 250 tähemärki.	Skaala väärtuse selgitus.
hyperlinks	0..*	Array	Lubatud kasutada kui elemendi tüüp on mudeli haldaja sisend (contentType = ADMIN_INPUT) ja vormielemendi sisendi tüüp on veebilehe link (inputType = HYPERLINK). Muudel juhtudel ei tohi kasutada. Vähemalt üks veebilehe link peab olema lisatud, kui elemendi tüüp on mudeli haldaja sisend (contentType = ADMIN_INPUT) ja vormielemendi sisendi tüüp on veebilehe link (inputType = HYPERLINK).	Nimekiri veebilehe linkidest. Kasutatakse kui elemendi tüüp on mudeli haldaja sisend (contentType = ADMIN_INPUT) ja sisendi formaat on veebilehe link (inputType = HYPERLINK).
hyperlinks.name	1	String	Peab olema 3-250 tähemärki pikk.	Lingi nimetus.
hyperlinks.url	1	String	Peab vastama veebilehe lingi nõuetele.	Veebilehe link.
textAreaValue	0..1	String	Lubatud kasutada kui elemendi tüüp on mudeli haldaja sisend (contentType = ADMIN_INPUT) ja vormielemendi sisendi tüüp on tekstiala (inputType = TEXT_AREA). Muudel juhtudel ei tohi kasutada. Kohustuslik esitada kolm tähemärki, kui elemendi tüüp on mudeli haldaja sisend (contentType = ADMIN_INPUT) ja vormielemendi sisendi tüüp on tekstiala (inputType = TEXT_AREA). Maksimaalne pikkus kuni 2500 tähemärki.	Elemendi väärtus, kui vormielement on tekstiala (TEXT_AREA). Kasutatakse kui elemendi tüüp on mudeli haldaja sisend (contentType = ADMIN_INPUT) ja sisendi formaat on tekstiala (inputType = TEXT_AREA).
columns	0..*	Object Array	Kohustuslik esitada vähemalt üks veeru objekt, kui elemendi tüüp on kasutaja sisend (contentType = USER_INPUT) ja vormielemendi tüüp on tabel (TABLE). Muudel juhtudel ei tohi kasutada. Maksimaalselt tohib esitada kuni 7 veeru objekti.	Nimekiri tabeli komponentide veergudest. Igale veeru objektile määratakse nimetus ja kas on kohustuslik või mitte.
columns.title	1	String	Lubatud kuni 250 tähemärki.	Veeru pealkiri.
columns.mandatory	1	Boolean	Lubatud väärtused: true - veeru täitmine on hindamises kohustuslik. false - veeru täitmine ei ole hindamises kohustuslik.	Määrab, kas veeru täitmine on kohustuslik või mitte.

Väljundid

Atribuut	Kohustuslikkus, mitmesus	Tüüp	Kirjeldus, täiendav info
id	1	String	Hindamise komponendi vormielemendi id (UUID).
assessmentModelId	1	FK	Viide hindamismudelile, millega hindamise komponendi vormielemendi seadistus on seotud. Viitab AssessmentModel.id väärtusele.
contentType	1	EHIS Classifier	Määrab elemendi tüübi. Väärtusena klassifikaatori CONTENT_TYPE elemendi viide.
label	1	String	Vormielemendi silt
labelDisplayedOnAssessment	1	Boolean	Määrab, kas vormielemendi silti kuvatakse hindamise vormil või mitte. true (Vaikimisi) - Silti kuvatakse hindamise vormil false - Silti ei kuvata hindamise vormil.
helpText	0..1	String	Vormielemendi selgitus/abitekst.
pbiMetadata	0..1	Object	PBI aruande andmed. Kasutatakse kui elemendi tüüp on PBI aruanne (REPORT).
pbiMetadata.workspaceId	1	String	PBI aruande tööruumi identifikaator.
pbiMetadata.reportId	1	String	PBI aruande identifikaator.
phaseTypes	0..*	EHIS Classifier list	Nimekiri etappidest, kus elementi kasutatakse. Väärtusena klassifikaatori ASSESSMENT_PHASE elemendi viide.
inputType	0..1	EHIS Classifier	Vormielemendi sisendi formaat Väärtusena klassifikaatori INPUT_TYPE elemendi viide. Kohustuslik kui elemendi tüüp on kasutaja sisend (USER_INPUT).
mandatory	0..1	Boolean	Märge, mis näitab kas vormielemendi täitmine on kohustuslik või mitte.
synchronizedToDwh	1	Boolean	Määrab, kas andmed sünkroniseeritakse hindamise juurest andmelattu või mitte. true - andmed sünkroniseeritakse andmelattu. false - andmeid ei sünkroniseerita andmelattu.
optionTexts	0..*	Array	Vormielemendi vastusevariandid. Kasutatakse kui vormielemendi tüüp on MULTIPLE_CHOICE (Mitmikvalik) või SINGLE_CHOICE (üksikvalik).
percentageTargetLevel	0..1	Integer	Osakaalu sihttase. Kasutatakse juhul kui sisendi formaat väärtuseks on "osakaal" (PERCENTAGE).
scale	0..1	Object	Skaala objekt Kasutatakse juhul kui sisendi formaat väärtuseks on "skaala" (SCALE).
scale.valuesFrom	0..1	Integer	Skaala väärtuste algus.
scale.valuesUntil	0..1	Integer	Skaala väärtuste lõpp.
scale.values	0..*	Array	Skaala väärtuste selgitused.
scale.values.value	1	Integer	Skaala väärtus. Peab jääma ValuesFrom ja ValuesUntil vahele. Mõlemad on kaasaarvatud.
scale.values.valueText	0..1	String	Skaala väärtuse selgitus.
files	0..*	Array	Nimekiri failidest. Kasutatakse kui elemendi tüüp on mudeli haldaja sisend (contentType = ADMIN_INPUT) ja sisendi formaat on pilt või fail (inputType = IMAGE või FILE).
file.id	1	UUID	Faili objekti id.
files.fileId	1	FK	Viide faili metaandmetele. Viitab File.id väärtusele.
files.title	0..1	String	Failile lisatud pealkiri.
files.fileName	1	String	Faili nimetus koos faililaiendiga. Näiteks "minu pilt.png".
files.mimeType	1	String	Faili mime tüüp. Näiteks "image/x-png".
files.size	1	Integer	Faili suurus baitides.
files.fileModifiedAt	0..1	Date and time	Faili viimane muutmise aeg. Loetakse faili enda metaandmetest.
hyperlinks	0..*	Array	Nimekiri veebilehe linkidest. Kasutatakse kui elemendi tüüp on mudeli haldaja sisend (contentType = ADMIN_INPUT) ja sisendi formaat on veebilehe link (inputType = HYPERLINK).
hyperlinks.name	1	String	Lingi nimetus.
hyperlinks.url	1	String	Veebilehe link.
textAreaValue	0..1	String	Elemendi väärtus, kui vormielement on tekstiala (TEXT_AREA). Kasutatakse kui elemendi tüüp on mudeli haldaja sisend (contentType = ADMIN_INPUT) ja sisendi formaat on tekstiala (inputType = TEXT_AREA).
columns	0..*	Object Array	Nimekiri tabeli komponentide veergudest. Igale veeru objektile määratakse nimetus ja kas on kohustuslik või mitte. Kasutatakse kui elemendi tüüp on mudeli haldaja sisend (contentType = USER_INPUT) ja sisendi formaat on tabel (inputType = TABLE).
columns.title	1	String	Veeru pealkiri.
columns.mandatory	1	Boolean	Määrab, kas veeru täitmine on kohustuslik või mitte. true - veeru täitmine on hindamises kohustuslik. false - veeru täitmine ei ole hindamises kohustuslik.
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 valideerib sisendi.
1. Kui sisend on ebakorrektne, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
Süsteem lisab hindamise komponentide hulka uue elemendi andmed.
- Süsteem loob Objektid#AssessmentModelComponentElement objekti:
  - id = UUID
  - assessmentModelId = Sisendis esitatud assessmentModelId väärtus.
  - contentType = Sisendis esitatud contentType väärtus.
  - label = Sisendis esitatud label väärtus.
  - labelDisplayedOnAssessment = Sisendis esitatud labelDisplayedOnAssessment väärtus.
  - helpText = Sisendis esitatud helpText väärtus.
  - pbi.workspaceId = Sisendis esitatud pbi.workspaceId väärtus.
  - pbi.reportId = Sisendis esitatud pbi.reportId väärtus.
  - phaseTypes
    - Kui contentType = ADMIN_INPUT, siis phaseTypes = Enesehindamine.
    - Kui contentType != ADMIN_INPUT, siis phaseTypes = Sisendis esitatud phaseTypes väärtused.
    - Kui inputType = REPORT (contentType = USER_INPUT või ADMIN_INPUT), siis phaseTypes = Enesehindamine.
  - inputType = Sisendis esitatud inputType väärtus.
  - mandatory = Sisendis esitatud mandatory väärtus.
  - synchronizedToDwh = Sisendis esitatud synchronizedToDwh väärtus.
  - optionTexts = Sisendis esitatud optionTexts väärtus.
  - percentageTargetLevel = Sisendis esitatud percentageTargetLevel väärtus.
  - scale.valuesFrom = Sisendis esitatud scale.valuesFrom väärtus.
  - scale.valuesUntil = Sisendis esitatud scale.valuesUntil väärtus.
  - scale.values = Sisendis esitatud scale.values väärtus.
  - scale.values.value = Sisendis esitatud scale.values.value väärtus.
  - scale.values.valueText = Sisendis esitatud scale.values.valueText väärtus.
  - textAreaValue = Sisendis esitatud textAreaValue väärtus.
  - hyperlinks = Sisendis esitatud hyperlinks väärtused.
  - columns = Sisendis esitatud columns väärtused.
  - objectStatus = CURRENT
  - audit (loomine) = audit (loomine)
Süsteem lisab loodud elemendi hindamise komponentide järjekorras õigesse asukohta.
- sectionId väärtus määrab vormielemendi ülemtaseme hindamise komponendi, mille alla vormielement lisatakse.
- Kui previousComponent väärtus ei ole määratud, siis lisatakse vormielement vastava taseme hindamise komponentide järjekorras esimeseks.
- Kui previousComponent väärtus on määratud, siis lisatakse loodud vormielement vastava taseme hindamise komponentide järjekorras määratud hindamise komponendi järele.
- Andmed salvestatakse Objektid#AssessmentModelComponentOrder objekti.
Süsteem tagastab loodud andmed.

GS: AssessmentModel: API: POST /quality-api/assessment-models/{assessmentModelId}/assessment-component/elements

Üldkirjeldus

Eeltingimused ja kasutusõigused

Sisendid

Väljundid

Tegevused