| Inc 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 :
et proxy-api som i hovedsak gjenspeiler DigEks API’et fra FS.
https://www.fellesstudentsystem.no/brukersider/teknisk/fsws-dok/rest/digitaleksamen.html#digeks_liste
Hoved funksjonen er er at den bygger en Authentiisering og authorisasjonslag på toppen av den eksisterende API’et fra FS.
Brukeren av dette API’et er eksamensystemer.
Nøkkel info
Initiering av flyt | HTTPS Listener svarer på en HTTPS-URL (/v1/*, /vt1/* eller /console/*) for å initiere flytene i appen. | ||
|---|---|---|---|
Flyt mønster |
|
| Tar imot HTTP forespørsler fra eksamen-systemer og videresender dem til FS DigEks |
Bruk av meldingskø | Nei | ||
Open API | Nei | Men brukes av eksterne systemer | |
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
...
JA | Bruker Gravitee. Mule-endepunktet ligger bak Gravitee. |
Bakgrunn
Da FS DigEks i sin tid ble opprettet, hadde den ikke noe passende mekanisme for tilgangskontroll. Den var heller ikke egnet for å stå som en ekstern endepunkt mot et ukjent antall eksamen-systemer. Et API ble derfor opprettet via Mule som samtidig sørget for et mer uniformt API.
Interessenter
Brukeren av API’et er eksamensystemer som trenger data fra FS.
Brukerhistorie
Eksamensystem X skal kunne utføre en av disse operasjoner:
Hent liste av eksamener
Hent info for en eksamen
Registrere sensur for en eksamen
Testregistrere sensur for en eksamen
Registrere oppmøte for en eksamen
Hent begrunnelser for eksamen
Registrere begrunnelse gitt til en kandidat for en eksamen
Hent klager for eksamen
Registrere et vedtak for klagesensur (Registrere et vedtak for eksamen)
Registrere gruppeid for kandidater
Hent eksamener filtrert på hjelpemiddel
Hent klager endret siden tidspunkt
Hent begrunnelsesforespørsler endret siden tidspunkt
Systemer/tjenester
Detaljert liste av alle innvolverte systemer/tjenester Hva utveksler data? Fra hvor / Til hvor?
System | Data | Brukt API (endepunkter) |
|---|---|---|
Config-databasen | Finner | configDB.orgs (fsIdToOrgShortName) |
Config-databasen | Finner dokument i databasen til en | configDB.orgs (getSingleOrg) |
Auth | Autentiserer brukeren med | authenticateWithApikey (gravitee) |
Auth | Autentiserer brukeren med | authenticate |
Auth | Autentiserer brukeren med | autheiticate directly with apikey |
LaaS | Registrerer en indeks | do Index |
Tilgangsstyring og logging
Integrasjonen loger til Humio med detaljert logging av prosessen.
Integrasjonen er knyttet logg-oversikten som vil logge følgende data:
errorMessage (tekst)
host
httpStatus
institusjonsId
method
orgId
orginal_user
remote_address
request_uri_inn
success (boolsk)
tjeneste
user
vurdId (examID)
Integrasjonen har ikke noe behov for tilgangstyringTilgangstyringen (autentisering via API-keys) skjer via Gravitee. Authorisasjonen håndteres via Auth-modulen vår.
Forretningsregler
Behandlingstid/responstid og volum
Behandlingstid/responstid: ca. 1ms
Frekvens: HTTPS-‘listener’ repeterbar fillagerstrøm for datastrømmestrategi
Volum (målt: ): gj.sn. ca. 66k hits daglig
Feilhåndtering, konsekvenser av feil og overordnet risikoanalyse
Generelt vil status og dermed eventuelle feil være synlig og tilgjengelig for institusjonen via logg-oversikten. Det er også utarbeidet mulighet for at enkelt personer ved institusjonen kan melde seg på for mottak av feilmeldinger på epost daglig.
Videre har vi overvåkning av loggene via Humio for å fange opp feil-situasjoner utenfor institusjonens virkeområde, som f.eks. utilgjengelige API endepunkter og bugs i koden.
...
Hva skjer ved overload i kø?
Det skjer ikke. Men om vi skulle på grunn av noe feil ikke motta meldingene fra eksamensystemene, vil : Inspera vite om det og sende dem på nytt. Wiseflow: er basert på polling, så vi kan alltid polle igjen
...
Hva skjer med ufullstendige meldinger?
De vil feile og det vil vi oppdage i loggene og kan ta aksjon basert på det.
...
Inneholder meldingene personopplysninger?
Merk at det utveksles mange “meldinger” mellom ulike systemer i løpet av en integrasjon. Melinger fra eksamensystem inneholder ikke noe persondata, men data vi henter fra FS basert på de meldingene gjør det. Filene vi arkiverer (som kommer fra eksamensystemene) kan også potensielt inneholde personopplysninger.
Noe om viktige feil/situasjoner som må passes ekstra på (som kan ha stor konsekvens) :
...
Oppgavene ikke arkiveres (miste meldinger)
...
Oppgaver arkiveres med feil info. (feiltolking eller feil logikk)
...
XXXX