Drawio | |
---|---|
zoom | 1 |
simple | 0 |
inComment | 0 |
pageId | 2303328290 |
custContentId | 2417950827 |
lbox | 1 |
diagramDisplayName | Digitaleksamen.drawio |
contentVer | 1 |
revision | 1 |
baseUrl | https://unit.atlassian.net/wiki |
diagramName | Digitaleksamen.drawio |
pCenter | 0 |
width | 1153.3333333333333 | links | tbstyle |
height | 817 |
Table of Contents | ||||||
---|---|---|---|---|---|---|
|
Innledning
Dette er en integrasjon for arkivering av Master oppgaver fra Wiseflow og Inspera. Integrasjonen bygger videre på arbeidet allerede gjort i forbindelse med Brage-integrasjonen. Da Brage-integrasjonen allerede henter inn master-oppgaver med tilhørende meta-data fra eksamen-systemene, benyttes den delen videre i denne integrasjonen.
Til arkivering, benyttes
Veiledning til integrasjonen og løsningsbeskrivelse :
Nøkkel info
...
Initiering av flyt
...
Inspera : Push (inspera-webhooks)
WISEflow : Poll-request
...
Flyt møsnter
...
Halveis synkron
...
Den delen som leser inn fra Inspera/Wiseflow er en egen prosess og er fra-koblet fra resten. Men den delen som arkiverer går synkront til arkiv-tjenesten
...
Bruk av meldingskø
...
Ja, Kafka
...
I klage-beg-dispatcher-app trigger den meldinger fra FS som skal komponeres og videresendes mot eksamensystemer. Den mottar data nedenfor:
contextObjectId
,contextObjectType
,associatedObjectId
,associatedObjectType
,triggeringUserId
,triggeringUserName
,timestamp
,org
,instance
,env
ogexamSystem
, og sender over begrunnelser (vurdId
,klage
,examSys
,orgId
ogenv
) til Inspera/WISEflow.ّInspera-webhook produserer webhook-meldinger (
timestamp
,org
,instance
,env
ogexamSystem
) mot begge eksamenssystemene (Inspera/WISEflow);Inspera-klage og wiseflow-klage forbruker
vurdId
,examSys
,orgId
,env
og klage meldinger (personlopenr, kandidatnr
,brukernavn
,fornavn
,etternavn
,klagestatus
,sensurfrist
,kommisjonsidOppr
ogkommisjonsidNy
) sendes fra FS, og klage-vedtak meldinger fra Inspera (contextObjectId
,contextObjectType
,associatedObjectId
,associatedObjectType
,triggeringUserId
,triggeringUserName
,timestamp
,org
,instance
,env
,eventName
,examSystem
) eller svar fra wiseflow (flowId
,explanationRequestId
,participantId
,assessorId
,callTime
,sequenceNumber
,timestamp
,org
,env
ogexamSystem
).Inspera-begrunnelse og wiseflow-begrunnelse forbruker
vurdId
,examSys
,orgId
,env
og begrunnelse-forespørsler (personlopenr, kandidatnr
,brukernavn
,kommisjonsId
,datoKlageMottat
ogdatoVedtakFormidlet
) sendes fra FS, og begrunnelse-svar meldinger fra Inspera (contextObjectId
,contextObjectType
,associatedObjectId
,associatedObjectType
,triggeringUserId
,triggeringUserName
,timestamp
,org
,instance
,env
,eventName
,examSystem
).
...
Open API
...
Nei
...
IntArk
...
Ikke brukt
Bakgrunn
Arkivering av masteroppgaver er et krav som alle institusjoner skal oppfylle.
Interessenter
Dette er en leveranse til både Arkiv og Digital-eksamen. Kostandene deles derfor mellom disse 2.
Arkiv har produsert og bestemt den såkalte mappinsdokument som definerer hvordan oppgavene skal arkiveres i arkiv-systemet.
Brukerhistorie
Student A leverer masteroppgave i Inspera/Wiseflow. Oppgaven skal automatisk arkiveres i institusjonens arkivsystem etter at div. klage/begrunnelse frister er gått ut.
Systemer/tjenester
Detaljert liste av alle innvolverte systemer/tjenester Hva utveksler data? Fra hvor / Til hvor?
...
System
...
Data
...
Brukt API (endepunkter)
...
Config-databasen
...
Finner orgShortName
i databasen til en gitt orgId
...
configDB.orgs
...
Config-databasen
...
Hvis prosessen var mislykket (success
er False), henter den en 'blacklist' for tjenesten for å bestemme om det skal registreres som en Slack-feilmelding i kanalen.
NB: Modulen hjelper utviklere og testere av systemet; sluttbrukeren vil ikke legge merke til det.
...
configDB.slack-blacklists
...
FS-Digex
Henter ut en liste (en json-liste) over begrunnelsesforespørsler som har blitt opprettet eller endret siden oppgitt tidspunkt basert på examSystem
, institutionNr
(Nummeret for institusjonen som du skal hente fra) og changedSince
(tidspunkt for sist sjekk).
GET: /eksamen/begrunnelse/{examSystem}
URL for test: https://fs-test.uio.no/eksamen/begrunnelse/<examSystem>?institusjonsnr=...&siden=...&
URL for prod: https://fsws.usit.no/eksamen/begrunnelse/<examSystem>?institusjonsnr=...&siden=...&
...
FS-Digex
...
Henter ut en json-liste basert på institutionNr
, siden
og examSystem
over klager som har blitt opprettet eller endret siden oppgitt tidspunkt.
GET: /eksamen/klager/{examSystem}/
URL for test: https://fs-test.uio.no/eksamen/klager/<examSystem>?institusjonsnr=...&siden=...&
URL for prod: https://fsws.usit.no/eksamen/klager/<examSystem>?institusjonsnr=...&siden=...&
...
FS-Digex
...
Henter begrunnelser for en gitt eksamen basert på examSystem
og examId
.
GET: /eksamen/begrunnelser/{examSystem}/{examId}
URL for test: https://fs-test.uio.no/eksamen/begrunnelser/{examSystem}/{examId}
URL for prod: https://fsws.usit.no/eksamen/begrunnelser/{examSystem}/{examId}
https://www.fellesstudentsystem.no/brukersider/teknisk/fsws-dok/rest/digitaleksamen.html
...
FS-Digex
...
Henter klager for en gitt eksamen basert på examSystem
og examId
.
...
GET: /eksamen/klager/{examSystem}/{examId}
URL for test: https://fs-test.uio.no/eksamen/klager/{examSystem}/{examId}
URL for prod: https://fsws.usit.no/eksamen/klager/{examSystem}/{examId}
https://www.fellesstudentsystem.no/brukersider/teknisk/fsws-dok/rest/digitaleksamen.html
...
Inspera
...
Henter assessmentRunId
og result
(generalInfo
, assessmentInfo
, externalTestInfo
, options
, committees
, candidates
, contributors
, organizationalUnits
osv) for testen gitt av instance
og testId
. Dette vil også inkludere alle relevante kandidatmetadata (userId
, candidateId
, attendanceStatus
, deliveryMode
, committeeId
, committeeName
, committeeGradingStatus
, groupId
, groupName
, submissionDeletedOn
, automaticQuestionScore
, roomId
, roomName
, building
, candidateExtraTime
, incidentTime
, finalGrade
, gradedDate
, startTime
, endTime
, restrictedUntilDate
, deliveryDeadline
, externalIds
, lastDeviceName
og assetsDownloadInfo
).
GET: /test/{testId}
...
Inspera
...
Lar en søke etter tester basert på enkle kriterier (tittel
, instance
og eksternId
/vurdId
).
...
GET: /test/search
https://api.inspera.no/apidoc/#/test/search
...
Inspera
...
Henter alle relevante metadata for testen gitt av testId
og instance
. Dette vil også inkludere alle relevante kandidatmetadata under ‘result’ (generalInfo
, externalTestInfo
, options
, committees
, candidates
, contributors
og organizationalUnits
).
...
GET: /test/{testId}
https://api.inspera.no/apidoc/#/test/getTestMetadata
...
Inspera
...
Henter opp user, for å mappe user-id
til feide-id
GET: /users/
...
Inspera
...
Henter kandidatens innsendings-id som tilsvarer test-id
og user-id
GET: /candidates/submission/
...
LaaS
...
Registrerer en indeks org
, instance
, env
, event-name
, remote-adr
og request-uri
i Humio (for å innta og beholde strømmedata)
...
do Index
...
Mongo-databasen
...
Finner alle dokumenter i databasen (orgId
, examSys
, insperaClientCode
, fsEnv
, instance
, active
, begrunnelse
, klage
, autoEpost
og XklageFilter
) som samsvarer med aktiv status og aktiv-verdi for Klage- eller Begrunnelse-felt.
...
Find documents i oai.KlageBegrunnelseEnvs kolleksjonen
...
Oai-databasen
...
legger auditInfoMap log til databasen
...
oai-addAuditLog
...
Oai-databasen
...
Henter aktive institusjoner med aktiv klage- og begrunnelse-status som tilsvarer examSystem
, org
og instance
...
oai.KlageBegrunnelseEnvs
...
Oai-databasen
...
Hvis prosessen var mislykket (success
er False), fjerner Kafka melding fra databasen basert på hash
verdi
...
‘Delete Kafka Message By Hash’ i oai.Records
...
Oai-databasen
...
Henter intance
som tilsvarer orgId
og klage/begrunnelse env
fra databasen
...
‘Get Instance By Org And Env’ i oai.KlageBegrunnelseEnvs
...
Oai-databasen
...
Legger klagen eller begrunnelsen (hvis den ikke er i databasen) til i databasen (vurdId
, klage
, examSys
, orgId
og env
).
...
oai.Records
...
Slack
...
Sender feilmeldinger (inkludert også data på module-id
og submodul
, organisasjons shortName
og orgId
, examSystem
, examSysInstance
, vurdId
, fetchFsListDates
, decodedFsTestId
og filesToArchive
). Det stemmer overens med Config-databasen (configDB.slack-blacklists).
...
Slack-kanalen (mule-prod)
...
WISEflow
...
Henter opp grunnleggende informasjon for en gitt flyt som navn, type, start- og sluttdato som kan brukes til å identifisere flyten (basert på contextObjectId
(Flow id), org
(orgShortName) og env
).
...
Drawio | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Table of Contents | ||||||
---|---|---|---|---|---|---|
|
...
Innledning
Dette er en integrasjon for arkivering av Master oppgaver fra Wiseflow og Inspera. Integrasjonen bygger videre på arbeidet allerede gjort i forbindelse med Brage-integrasjonen. Da Brage-integrasjonen allerede henter inn master-oppgaver med tilhørende meta-data fra eksamen-systemene, benyttes den delen videre i denne integrasjonen.
Til arkivering, benyttes
Veiledning til integrasjonen og løsningsbeskrivelse :
Nøkkel info
Initiering av flyt | Inspera : Push (inspera-webhooks) | |
---|---|---|
Flyt møsnter | Halveis synkron | Den delen som leser inn fra Inspera/Wiseflow er en egen prosess og er fra-koblet fra resten. Men den delen som arkiverer går synkront til arkiv-tjenesten |
Bruk av meldingskø | Ja, Kafka |
|
Open API | Nei | |
IntArk | Ikke brukt |
Bakgrunn
Arkivering av masteroppgaver er et krav som alle institusjoner skal oppfylle.
Interessenter
Dette er en leveranse til både Arkiv og Digital-eksamen. Kostandene deles derfor mellom disse 2.
Arkiv har produsert og bestemt den såkalte mappinsdokument som definerer hvordan oppgavene skal arkiveres i arkiv-systemet.
Brukerhistorie
Student A leverer masteroppgave i Inspera/Wiseflow. Oppgaven skal automatisk arkiveres i institusjonens arkivsystem etter at div. klage/begrunnelse frister er gått ut.
Systemer/tjenester
Detaljert liste av alle innvolverte systemer/tjenester Hva utveksler data? Fra hvor / Til hvor?
System | Data | Brukt API (endepunkter) |
---|---|---|
Config-databasen (& WB ) | Finner | configDB.orgs |
Config-databasen (ALL) | Hvis prosessen var mislykket ( NB: Modulen hjelper utviklere og testere av systemet; sluttbrukeren vil ikke legge merke til det. | configDB.slack-blacklists |
FS-Digex ( & WB) | Henter ut en liste (en json-liste) over begrunnelsesforespørsler som har blitt opprettet eller endret siden oppgitt tidspunkt basert på | GET: /eksamen/begrunnelse/{examSystem} URL for test: https://fs-test.uio.no/eksamen/begrunnelse/<examSystem>?institusjonsnr=...&siden=...& https://www.fellesstudentsystem.no/brukersider/teknisk/fsws-dok/rest/digitaleksamen.html |
FS-Digex | Henter ut en json-liste basert på | GET: /eksamen/klager/{examSystem}/ URL for test: https://fs-test.uio.no/eksamen/klager/<examSystem>?institusjonsnr=...&siden=...& https://www.fellesstudentsystem.no/brukersider/teknisk/fsws-dok/rest/digitaleksamen.html |
FS-Digex | Henter begrunnelser for en gitt eksamen basert på | GET: /eksamen/begrunnelser/{examSystem}/{examId} URL for test: https://fs-test.uio.no/eksamen/begrunnelser/{examSystem}/{examId} https://www.fellesstudentsystem.no/brukersider/teknisk/fsws-dok/rest/digitaleksamen.html |
FS-Digex | Henter klager for en gitt eksamen basert på | GET: /eksamen/klager/{examSystem}/{examId} URL for test: https://fs-test.uio.no/eksamen/klager/{examSystem}/{examId} https://www.fellesstudentsystem.no/brukersider/teknisk/fsws-dok/rest/digitaleksamen.html |
FS-Digex (InB & WB) | Registrerer | POST: /eksamen/begrunnelser/{examSystem} URL for test: https://fs-test.uio.no/eksamen/begrunnelser/<examSystem> |
Inspera (InK & InB) | Henter alle relevante metadata | GET: /test/{testId} |
Inspera (InK & InB) | Lar en søke etter tester basert på enkle kriterier ( | GET: /test/search |
Inspera (InB) | Henter alle begrunnelser og begrunnelse forespørsler for en gitt | GET: /test/{testId}/explanations |
Inspera (InK) | Når | POST: /test/{testId}/appeals/withdraw |
Inspera (InK) | Når | POST: /test/{testId}/appeals |
Inspera (InB) | Aktiver/oppdater alternativer for test | POST: /test/{testId}/options |
Inspera (InB) | Poster NB: Når de er publisert, er begrunnelse endelige, og det vil ikke være mulig å be om dem igjen. | POST: /test/{testId}/explanations https://api.inspera.no/apidoc/#/test/requestTestExplanations |
LaaS (ALL) | Registrerer en indeks | do Index |
Mongo-databasen | Finner alle dokumenter i databasen ( | Find documents i oai.KlageBegrunnelseEnvs kolleksjonen |
Oai-databasen (ALL) | legger auditInfoMap log til databasen | oai-addAuditLog |
Oai-databasen (InK & InB) | Henter aktive institusjoner med aktiv klage- og begrunnelse-status som tilsvarer | oai.KlageBegrunnelseEnvs |
Oai-databasen (InK & InB & WK) | Hvis prosessen var mislykket ( | ‘Delete Kafka Message By Hash’ i oai.Records |
Oai-databasen (InK & InB) | Henter | ‘Get Instance By Org And Env’ i oai.KlageBegrunnelseEnvs |
Oai-databasen (InK & InB) | Legger klagen eller begrunnelsen (hvis den ikke er i databasen) til i databasen ( | oai.Records |
Oai-databasen (WB) | Henter dokumenter som ikke ble behandlet ( | oai.LastAudit |
Slack (ALL) | Sender feilmeldinger (inkludert også data på | Slack-kanalen (mule-prod) |
WISEflow (B) | Returnerer informasjon om karakterbegrunnelsen (av gitt | GET: /flow/{flowId}/explanation/request/{explanationRequestId} |
WISEflow (B) | Oppdater synligheten til en karakterbegrunnelse (av gitt | PATCH: /flow/{flowId}/explanation/request/{explanationRequestId} |
WISEflow (B &K) | Returnerer en liste ( | GET: /license/sis/flows/{sisCode} |
WISEflow ( & B ) | Henter opp grunnleggende informasjon for en gitt flyt som navn, type, start- og sluttdato som kan brukes til å identifisere flyten (basert på | GET: /flow/{flowId} |
WISEflow (B & K) | Returnerer grunnleggende informasjon ( | GET: /flow/{flowId}/participants |
WISEflow (B ) | Hvis den er aktivert på flyten (av gitt | POST: /flow/{flowId}/explanation/request |
WISEflow (K) | Oppretter en revurderingsflyt til en allerede opprettet flyten (av gitt NB: Dette endepunktet krever revurderingsmodulen på lisensen. | POST: /flow/{flowId}/reassessment |
Tilgangsstyring og logging
Integrasjonen loger til Humio med detaljert logging av prosessen.
Integrasjonen er knyttet logg-oversikten som vil logge følgende data:
orgId
oppgaveIdentifier
testId
userOrGroupId
examSystem
studentRefs
success (true/false)
errorMessage (hvis aktuelt)
Integrasjonen har ikke noe behov for tilgangstyring
Forretningsregler
Behandlingstid/responstid og volum
Integrasjonen ikke tatt til bruker nå; ingen data!
Feilhåndtering, konsekvenser av feil og overordnet risikoanalyse
...