Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

Innledning

Denne integrasjonen sørger for å ektrahere oppgavetittel for Master og Bachelor oppgavene og registrere dem. Tidligere har studenten selv måtte sørge for å registrere oppgavetittel direkte via studweb noe som kunne føre til dårlig og uriktig data kvalitet.

Veiledning til integrasjonen og løsningsbeskrivelse :

Nøkkel info

Initiering av flyt

Poll-request

 

Flyt møsnter

Halveis synkron

 

Bruk av meldingskø

Ja, Kafka

  • Inspera-webhook produserer webhook-meldinger (timestamp, org, instance, env og examSystem) mot begge eksamenssystemene (Inspera/WISEflow);

  • Brage også forbruker event, contextObjectId, contextObjectType, associatedObjectId, associatedObjectType, triggeringUserId, triggeringUserName, inputTopic, id, action, licenseId, flowId, userId, submissionId, participantId, isHandedIn, callTime, eventVersion, sequenceNumber, timestamp, org, instance, env, eventName og examSystem fra eksamensystemer

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

setter orgCoverSheet til en gitt orgId

configDB.getSingleOrg

FS-Digex

Henter status (et JSON-objekt) på bachelor/master oppgave ifm overføring til Brage (basert på examSystem og taskId)

GET:/eksamen/ferdigstatus/{examSystem}/{taskId}

URL for test: https://fs-test.uio.no/eksamen/ferdigstatus/<ID>?fnr=<nr>&.....
URL for prod: https://fsws.usit.no/eksamen/ferdigstatus/<ID>?fnr=<nr>&.......

https://www.fellesstudentsystem.no/brukersider/teknisk/fsws-dok/rest/digitaleksamen.html

Inspera

planlegger og laster ned innlevering av en enkelt kandidat eller gruppe på en test

GET: /candidates/submission/{testId}/{userId} (depreciated)

POST: /fileExport/order (resourceType 'CandidateSubmission')

https://api.inspera.no/apidoc/#/fileExport/orderExports

Inspera

Henter resultatkandidatinformasjonen (title, startTime, endTime, assessmentRunId, externalId, candidateId) for en gitt bruker på en gitt test (instance, org, assessmentRunId og userOrGroupId)

GET: /candidates/listTests/{userId}

https://api.inspera.no/apidoc/#/candidates/getCandidateResult

Inspera

Henter alle relevante metadata 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}

https://api.inspera.no/apidoc/#/test/getTestMetadata

LaaS

Registrerer en indeks org, instance, env, event-name, remote-adr og request-uri i Humio (for å innta og beholde strømmedata)

do Index

Oai-databasen

Henter en record med identifier query

oai-getRecord

Oai-databasen

Henter 'record’er med identifier query

oai-getRecords

Oai-databasen

Legger til et nytt dokument i databasen

oai-addRecord

Oai-databasen

Oppdaterer et dokument i databasen

oai-updateRecord

Oai-databasen

Legger auditInfoMap log til databasen

oai-addAuditLog

Oai-databasen

Hente dokumenter fra et visst antall dager tilbake (fs-check-days-back)

oai-getPassedExpectedRecords

Oai-databasen

Legger filer (mainDoc og attachments) til i databasen (BrageFil)

oai-upsertBrageFile

Oai-databasen

Henter filer klare for opplasting (ready) til S3 fra databasen

oai-getBrageFiles

Oai-databasen

Henter en rekke 'repo’er for systemet (wiseflow)

oai-getRepositoriesForSystem

Oai-databasen

Henter en repo etter org og system (eksamensystem)

oai-getRepository

Oai-databasen

Oppdaterer en record med DELIVERED_DATE (identifier)

oai-updateDeliveredDate

Oai-databasen

Lister ‘record’er (med untilDate, fromDate, eventuelle attributes, org og ready_date eller delayed_date)

oai-oaiListRecords

Amazon S3

Overfører arkiverte filer (localFileName og fileName) til S3 bucket

upload file:

https://docs.safespring.com/storage/generalinfo/

Slack

Sender feilmeldinger (inkludert også data på module-idog 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

Returnerer informasjon om en innlevering (submissionId) levert av en student på en bestemt flowIdsom samsvarer med spørringsparameteren (submissionId, flowId, env og orgShortName).

GET: /flow/{flowId}/submission/{submissionId}

https://europe-apidocs.wiseflow.net/

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).

GET: /flow/{flowId}

https://europe-apidocs.wiseflow.net/

Tilgangsstyring og logging

  • Integrasjonen loger til Humio med detaljert logging av prosessen.

  • Integrasjonen er knyttet logg-oversikten som vil logge følgende data:

    • action, callTime, candidateIds, event, eventName, eventVersion, env, errorMessage, examSys (examSystem), flowId, id (identifier), identifier, inputTopic, isHandedIn, key, licenseId, moduleId, modified_date, orgId (org), participantId, sequenceNumber, submissionId, submodule, success (boolsk), testId, timestamp, triggeringCandidateId, vurdId (decodedVurdId) og userId

  • Integrasjonen har ikke noe behov for tilgangstyring

Forretningsregler

Behandlingstid/responstid og volum

  • Behandlingstid/responstid: ca. 2s

  • Frekvens: HTTPS-‘listener’ repeterbar fillagerstrøm for datastrømmestrategi (Inspera-webhook, brage-app og oai-pmh) og 5-minutter poll timeout for Apache-Kafka forbruk for eksamensystemer (Brage-app)

  • Volum (målt: ): gj.sn. ca. 23k 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)

    • Oppgaver arkiveres med feil tilganger (slik at oppgaver som ikke skal være offentlige, arkiveres slik at de blir offentlig synlige) 

Kommentarer

  • No labels