Page Comparison

...

...

...

...

...

...

...

...

• Innledning

• Nøkkel info

• Bakgrunn

• Interessenter

• Brukerhistorie

• Systemer/tjenester

• Tilgangsstyring og logging

• Forretningsregler

• Behandlingstid/responstid og volum

• Feilhåndtering, konsekvenser av feil og overordnet risikoanalyse

• Kommentarer

Innledning

Dette er 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

Dokumentasjonen til dette API’et er å finne her : https://api-sikt.intark.uh-it.no/catalog/api/81ecdc41-73ed-48c4-acdc-4173ed88c4e9?q=digex

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

...

Synkron

...

...

Innledning

Denne i integrasjonen, er en del av “innholdsinformasjon-integrasjonen”. Denne sørger for å hente ut bok-data om norske utgivelser og sende dem til en intern API/forsystem til Alma, bibliotek-systemet.

Det overføres 2 type informasjon.

1. descriptions : Tekstlig beskrivelse av innholdet i ei bok.

2. objects : Dette består av eventuelle bilder eller lyd-objekter om en enkel bok.

Dokumentasjonen om bokdatabasen er å finne her : https://bokbasen.jira.com/wiki/spaces/api/pages/119572243/API+for+Digital+Lending+Platforms

Nøkkel info

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 disse operasjonene:

  • 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

Bakgrunn

Bibliotek-systemet trenger å bli oppdatert med info om nye bøker og eller oppdatering av info på eksisterende. Dette skjer via eksterne tjenester, i dette tilfellet, bokbasen.

Brukerhistorie

• Beskrivelse eller bilde/lyd info om nye bøker skal automatisk hentes og oppdatere innholdet i bibliotek-systemet.

• Oppdaterte beskrivelse eller bilde/lyd info om eksisterende bøker skal automatisk hentes og oppdatere innholdet i bibliotek-systemet.

Systemer/tjenester

• Detaljert liste av alle innvolverte systemer/tjenester Hva utveksler data? Fra hvor / Til hvor?

/eksamen/liste
/eksamen/<system>/<ID>
/eksamen/sensur/<system>/registrer
/eksamen/sensur/<system>/valider
/eksamen/oppmote/<system>/registrer
/eksamen/begrunnelser/<SYSTEM>/<ID>
/eksamen/begrunnelser/<SYSTEM>
/eksamen/klager/<SYSTEM>/<ID>
/eksamen/vedtak/<SYSTEM>
/eksamen/gruppeid/<SYSTEM>/registrer
/eksamen/hjelpemiddel
/eksamen/klager/<SYSTEM>
/eksamen/begrunnelse/<SYSTEM>

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)

• Tilgangstyringen (autentisering via API-keys) skjer via Gravitee. Authorisasjonen håndteres via Auth-modulen vår.

...

• Ingen tilgangstyring er nødvendig.

Forretningsregler

Hver natt hentes en liste over alle nye beskrivelser og objekter. For hver beskrivelse/object kalles API-endepunktet som oppdaterer informasjonen i bibliotek-systemet.

Behandlingstid/responstid og volum

• Behandlingstid/responstid: gj. snitt ca. 1ms2s (avhengig av antall objekter/beskrivelser)

• Frekvens: HTTPS-‘listener’ repeterbar fillagerstrøm for datastrømmestrategiScheduler : 1 runde hver dag, med fire ganger for hvert “object” og “description”. Hver runde består av flere kall, da det er en grense på ca 1000. Det vil si hvis en dag det er flere enn 4000 oppdateringer, blir de ikke alle med den dagen.

• Volum (målt: 27 Jul 30 Aug 2022): gj.sn. ca. 66k hits 1000 “descriptions” og 300 “objects” daglig

Feilhåndtering, konsekvenser av feil og overordnet risikoanalyse

• Hva skjer ved overload i kø?

  • Det finnes ikke noe kø her, men en overload av kall fra eksamensystemer er mulig og vil føre til feilede kall.

• Hva skjer med ufullstendige meldinger?

  Det finnes ikke noe meldinger, men ufullstendige eller invalide kall vil føre til feilmeldinger. Enten fra Mule eller fra FS-API’et.

  Ved feil i post til AWS-tjenesten eller feil i data-format mottatt fra bokbasen.

  • Feil logges i humio.

• Inneholder meldingene personopplysninger?

  • Ja i form av navn, e-postadresse eller brukernavnNei, ingen personopplysninger er involvert.

• Noe om viktige feil/situasjoner som må passes ekstra på (som kan ha stor konsekvens) :

  • Det mest sannsynlige er at tjenesten faller bort. Dette kan skje ved flere nivåer. Enten Gravitee i front, Mule tjenesten selv eller feil i FS. En slik utfall kan i verste fall ødelegge for eksamengjennomføring. Ingen av kallene/operasjonene i dette API'et er nødvendig for selve gjennomføringen av eksamen, men for oppsett. Det er alltid noen “last-minute” endringer som vil bli rammet om denne integrasjonen ikke fungerer.

  • Feil i data levert fra FS kan rote til opprettelse av prøver i eksamensystemene.

  • Da dette API’et brukes også til å sette sensur, feil som f.eks. sette på feil karakter til en student, vil ha store omdømme konsekvenserFeil bok oppdateres med info om en annen bok

  • Vi går glipp av oppdateringer.