Opprett WISEflow klageflow

Owned by babak.tavassoli
Last updated: Nov 20, 2024
5 min read

Innledning

Denne integrasjonen sørger for å opprette klage-flows for hver flow, der det kommer en klage på. Egentlig skal den opprette en klage-flow når den første klage-forespørselen kommer. Men i praksis, oppretter den klage-flowen (utfører kall til WF) for hver eneste klage som kommer. API’et til Wiseflow oppretter uansett bare 1 klage-flow og overser alle andre.

 

Nøkkel info

Initiering av flyt

Pulling utført av klage-beg-dispatcher

Merk at klage-beg-dispatcher-app puller FS og sender klage-forespørslene som meldinger til wiseflog-klage

Flyt møsnter

Asynkron

Den delen som leser fra FS er

Bruk av meldingskø

Ja;

MeldingQ (Sikt egen melding-kø system basert på MongoDb, i.e. DocumentDb)

  • I klage-beg-dispatcher-app poller klage-forespørsler fra FS som skal komponeres og videresendes mot eksamensystemer. De sendes via meldingQ

  • WISEflow-klage plukker opp meldingene og utfører jobben mot Wiseflow

Open API

Nei

 

IntArk

Ikke brukt

 

Bakgrunn

Det er Wiseflow som oppdaterer en klage-flow med kandidater og kommisjoner osv. Men en klage-flow må opprettes når den første klage-forespørselen kommer inn. Det er den jobben denne integrasjonen tar seg av.

Interessenter

Dette er en leveranse til Digital-eksamen.

Brukerhistorie

  • Student ber om klage i studenweb (eller hvor det måtte være). En klage-flow opprettes i Wiseflow hvis den ikke er allerede opprettet.

Systemer/tjenester

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

 

Det er 2 applikasjoner som er innvolvert.
Klage-beg-dispatcher-app

Wiseflow-klage-app

System

Data

Brukt API (endepunkter)

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 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=...&

DigEks-tjenester

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}

DigEks-tjenester

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

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 en liste (combinedMainFlowId, purpose, combinedSubFlowIds, variant, state, creationDate, type og flowId) over flyter som samsvarer med spørringsparameteren (sisCode, env og orgShortName).

GET: /license/sis/flows/{sisCode}

WISEflow API documentation

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}

WISEflow API documentation

WISEflow

Returnerer grunnleggende informasjon (submissionId, assessorIds, groupId, id, assessorGroupIds og user) om alle deltakere som er tildelt en gitt flowId.

GET: ​/flow​/{flowId}​/participants

WISEflow API documentation

WISEflow

Oppretter en revurderingsflyt til en allerede opprettet flyten (av gitt orgShortName, env og flowId). Hvis en revurderingsflyt allerede eksisterer (queuedForSynchronization er False), vil flowId bli returnert og flyten vil ikke bli satt i kø for synkronisering.

NB: Dette endepunktet krever revurderingsmodulen på lisensen.

POST: /flow/{flowId}/reassessment

WISEflow API documentation

Tilgangsstyring og logging

  • Integrasjonen loger til Humio med detaljert logging av prosessen.

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

    • env

    • errorMessage (String)

    • errorCode (Number)

    • examSys

    • flowId

    • hash

    • inputTopic

    • kandidatNr

    • orgId

    • personlopeNr

    • reassessmentFlowId

    • submodule

    • success (boolsk)

    • vurdId (decodedVurdId)

  • Integrasjonen har ikke noe behov for tilgangstyring

Forretningsregler

Hoved flyt i integrasjonen:

  • For hver klage-forespørsel fra FS

    • Finn alle aktive flow i Wiseflow.

      • Hvis studenten (som har klaget) finnes i flowen og er aktiv, opprett klage-flow for aktuell flow

Andre egenskaper og prosesser i integrasjonen

klage-beg-dispatcher kjører annen hver time og henter klager for 2 dager tilbake i tid. Den sender da klage-forespørselen over BARE hvis den ikke er sendt allerede de siste 2 dagene.
Merk ! Det vil si om en klage endres noe på innen 2 dager, vil den ikke sendes videre. Det betyr om institusjonen ønsker å sende en klage på nytt (noe de gjør ved å endre noe fiktiv på klagen i FS, slik at den plukkes opp igjen), vil den ikke sendes på nytt allikevel, hvis endringen skjer innen 2 dager fra opprinnelig melding sendt.

Feilede overføringer vil forsøkes re-sendt opp til 5 ganger.

Behandlingstid/responstid og volum

  • Behandlingstid/responstid: ca. 2s

  • Frekvens: Den nye meldingssystemet (meldingQ) kjører uten forsinkelse på meldingskøen – lytteren til køen tar meldinger én etter én og starter behandlingen umiddelbart fra klage-beg-dispatcher. Hver melding hentes direkte fra databasen, prosesseres, og status oppdateres deretter til enten ‘processed’ eller ‘failed’ i samme database-kolleksjon.

  • Volum (målt: Nov 19, 2024): gj.sn. ca. 2k hits (i.e. “correlationId“) 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 (https://dbapp.de-c1.eu1.cloudhub.io/). Det er også utarbeidet mulighet for at enkelt personer ved institusjonen kan melde seg på for mottak av feilmeldinger på epost daglig (“Jeg vil ha e-post varsling”-knappe). Videre har vi overvåkning av loggene via Humio for å fange opp feil-situasjoner utenfor institusjonens virkeområde.

  • Opprettelse av feil klage-flow for feil flow.

    • Bare en feil koding kunne føre til noe slikt. Tester sørger for at dette ikke skjer.

  • Ikke overføring og dermed opprettelse av klage-flow

    • Resending av feilede feilede overføringer pluss antall ganger hver klage forsøkes lest og overført, gjør sannsynligheten for denne feilen minimalt.

  • Hva skjer ved overload i kø?

    • Det skjer ikke da-køene kun har én parallell forbruker ('queue-listener');

  • Hva skjer med ufullstendige meldinger?

    • Meldinger med status ‘failed’ (opptil 5 ganger) eller ‘processing’ (med 10 minutters forsinkelse for å sikre at meldingen ikke allerede behandles) blir hentet fra kolleksjonen igjen i grupper på opptil 100, og behandlet i samme flyt.

    • Meldingssystemet bruker ‘manual’ protokoll for håndtering av bekreftelse, som betyr at prosessen fullføres med en endelig status ‘failed’ eller ‘processed’ for hver melding etter fullført behandling. Ingen meldinger skal ha status ‘processing’ eller ‘enqueued’ lengre enn forventet behandlingstid.

  • Inneholder meldingene sensitive personopplysninger?

    • ifølge definisjonen på sensitive personopplysninger hos Sikt (Sikt Personvernhåndbok) kan vi konstatere at det ikke forekommer behandling eller overføring av slike data i MuleSoft-plattformen.

Kommentarer