Denne dokumentasjonen er ikke helt komplett ennå. Den fylles med info etter behov

(1) Introduksjon


Denne integrasjonen henter studentdata fra Felles Student System (FS)-databasen og ansattdata fra en API og overfører begge til Alma.
Denne integrasjonen erstatter den eksisterende/gamle synken.
Den vil sørge for at alle studenter/ansatte opprettes og holdes oppdatert i Alma med riktige grupper og bibliotek tilhørighet.


Om GraphQL i Felles Student System (FS) Databasen

Vi benytter GraphQL, et kraftig spørringsspråk for API-er, som lar oss hente all nødvendig data i én enkelt forespørsel.
I motsetning til tradisjonelle REST API-er, som krever flere forespørsler til ulike endepunkter, gjør GraphQL det mulig å hente akkurat den dataen vi trenger.
Dette reduserer unødvendig dataoverføring og forbedrer effektiviteten.

Denne tilnærmingen øker ytelsen betydelig ved å minimere nettverksbelastningen og sikre raskere responstider.
Med GraphQL kan vår integrasjon håndtere komplekse spørringer sømløst, hente relaterte data på en strukturert måte og gi en mer strømlinjeformet opplevelse for våre kunder.
Dette resulterer i en mer fleksibel og optimalisert dataoverføringsprosess, noe som gjør systemet vårt mer responsivt og skalerbart.

Integrasjonen støtter to typer dataoverføring:

  1. Full overføring – Overfører alle tilgjengelige studenter og ansatte fra FS/SFTP-filer til Alma.

  2. Endringer overføring – Oppdaterer og synkroniserer endringer i studentprofiler og ansattprofiler.

Hvis en profil ikke allerede finnes i Alma, oppretter integrasjonen den. Ellers oppdateres og synkroniseres profilen for å sikre konsistens.

Ved første overføring migreres alle studenter og ansatte til Alma.
Deretter holder integrasjonen profilene oppdatert, med FS som kilde for oppdateringer.
Kun profiler med endringer overføres, og institusjoner kan velge hvilke typer modifikasjoner som skal spores.

En GUI lar institusjoner konfigurere og administrere tilgjengelige alternativer i integrasjonen.
GUI-en er utviklet av MuleSoft-teamet.
En institusjon kan bestille en full overføring av alle studenter og ansatte samt sette opp sine alternativer gjennom GUI-en.

NB!

Hvis en brukerprofil endres manuelt og direkte i Alma, oppdaterer integrasjonen den ikke lenger og behandler den som en ekstern profil.
Hvis du ønsker å fortsette oppdateringer på en slik profil, anbefales det at profilen slettes manuelt i Alma.
Neste gang, hvis noen oppdateringer er tilgjengelige i FS for denne profilen, finner integrasjonen den ikke i Alma.
Dermed oppretter en brukerprofil og oppdaterer den fra det tidspunktet når oppdateringer er tilgjengelige i FS.

(2) Hvordan GUI’en kan brukes

Konfigurasjon av brukerprofiler i GUI

Den grafiske brukergrensesnittet (GUI) er en plattform for konfigurasjon av brukerprofiler, og sikrer fleksibilitet i valg av data og tilpasning av innholdet.
I GUI-en kan brukere definere hvilke felt som skal inkluderes ved opprettelse eller oppdatering av brukerprofiler i systemet.

En av de viktigste tilpasningsmulighetene er valget av adresse som skal knyttes til profiler.
Institusjoner kan velge mellom:

På samme måte kan institusjonen bestemme hvilke kontaktopplysninger som skal inkluderes i profiler.
GUI-en gir muligheten til å:

I tillegg lar GUI-en institusjonen spesifisere foretrukket språk som standard språk på profiler.
De tilgjengelige språkvalgene inkluderer:

Ved å tilby disse tilpasningsmulighetene sikrer GUI-en at brukerprofiler kan skreddersys etter institusjon preferanser.
Dette bidrar til både økt datanøyaktighet og bedre brukeropplevelse, slik at organisasjoner kan opprettholde godt strukturerte og tilpassede profiler for sine studenter og ansatte.

NB!
"Foretrukket" betyr at de valgte elementene vil være det første forsøket av integrasjonen.
Hvis det første forsøket ikke eksisterer, vil de andre elementene bli tatt.
("Foretrukket" betyr ikke at hvis ett element er valgt, vil de andre elementene bli ignorert)

Screenshot 2025-03-06 at 12.29.11.png

Definere "Brukergruppe" i Alma Ifølge av "Studienivå"

For å sikre riktig kategorisering og tilgangsstyring i Alma, er det viktig å definere "Brukergruppe" (brukergrupper) basert på "Studienivå" (studienivå).
Denne prosessen hjelper med å strukturere klassifiseringer på en effektiv måte, slik at studenter og ansatte blir plassert i riktige grupper i systemet.

Steg for å definere en "Brukergruppe"

For å opprette en ny Brukergruppe, følg disse trinnene:

  1. Klikk på "Legg til ny brukergruppe" i Alma-GUI’en.

  2. Tildel en "Brukergruppekode" til den nye gruppen.
    Denne koden identifiserer brukergruppen unikt i systemet.

  3. Definer intervallet for "Studienivå" som er knyttet til "Brukergruppekode".
    Dette bestemmer hvilke studenter som tilhører brukergruppen basert på deres akademiske nivå.

Det er viktig å merke seg at GUI’en automatisk forhindrer overlappende intervaller når du definerer brukergrupper.
Dette betyr at to forskjellige "Brukergruppekode"-oppføringer ikke kan dekke samme "Studienivå"er.
Systemet sikrer at hvert studienivå kun tildeles én brukergruppe om gangen for å unngå konflikter i kategoriseringen.

Forstå "Studienivå"-verdier

Hvert "Studienivå" er representert av en unik numerisk verdi, som varierer fra 30 til 990.
Disse tallene tilsvarer ulike studienivåer, som for eksempel bachelor, master og doktorgradsprogrammer.
Når du tildeler et "Studienivå"-intervall til en "Brukergruppekode", må du sørge for å velge riktig tallområde som gjenspeiler den ønskede studentklassifiseringen.

Ved å definere Brukergruppe riktig i Alma, kan institusjoner effektivisere brukerhåndteringen og sikre at studenter og ansatte blir korrekt klassifisert basert på deres akademiske nivå.

Screenshot 2025-03-06 at 12.34.23.png

Mapping mellom "bibliotekskoder" fra FS og Alma

For å sikre en sømløs integrasjon mellom FS og Alma, tilbyr integrasjonen et grensesnitt for mapping av "bibliotekskoder" (bibliotekskoder).
Denne mapping-prosessen lar institusjoner koble sammen bibliotekskodene som brukes i FS med de tilsvarende kodene i Alma, slik at dataoverføringer og oppdateringer fungerer korrekt.

Det grafiske brukergrensesnittet (GUI) er utviklet for å forenkle denne prosessen.
Det henter og viser automatisk alle tilgjengelige bibliotekskoder fra FS på venstre side og de tilsvarende kodene fra Alma på høyre side.
Dette gir institusjoner en tydelig oversikt over kodene i begge systemene, noe som gjør det enkelt å opprette riktige koblinger.

For å knytte en FS-bibliotekskode til en tilsvarende kode i Alma, kan institusjoner bruke en nedtrekksmeny plassert ved siden av hver FS-kode.
Nedtrekksmenyen inneholder en liste over alle tilgjengelige Alma-koder, slik at institusjoner kan velge riktig tilordning.
Dette gir fleksibilitet, spesielt i tilfeller der navngivningen i de to systemene er forskjellig, og lar institusjoner manuelt definere hvordan FS-koder skal oversettes til Alma sitt system.

Dersom en institusjon ikke finner en direkte samsvarende kode i Alma for en spesifikk FS-kode, kan de enten la den være umappet eller be om at nødvendige endringer gjøres i Alma.

Ved å tilby et brukervennlig og effektivt mapping-grensesnitt sikrer systemet at bibliotekdata overføres og synkroniseres korrekt mellom FS og Alma, noe som reduserer manuelle feil og forbedrer den daglige driften.

Lagre innstillingene for å bruke dem i fremtidige dataoverføringer

Når du har valgt og konfigurert alle tilgjengelige alternativer i det grafiske brukergrensesnittet (GUI), er det viktig å fullføre valgene ved å klikke på "Lagre"-knappen.
Denne handlingen lagrer alle de valgte innstillingene og preferansene sikkert i vår database, slik at konfigurasjonen bevares for fremtidig bruk.

Ved å lagre preferansene sørger institusjonen for at systemet automatisk bruker disse innstillingene hver gang student- og ansattdata overføres.
Enten integrasjonen kjører en full overføring (som migrerer alle student- og ansattoppføringer) eller en inkrementell oppdatering (som bare synkroniserer endringer og modifikasjoner), vil systemet referere til de lagrede preferansene for å avgjøre hvordan dataene skal behandles.

Dette sikrer konsistens i alle dataoverføringer, ettersom integrasjonen følger de spesifikke modifikasjonstemaene, filtreringsreglene og tilpassede innstillingene institusjonen har valgt.
I tillegg reduserer denne tilnærmingen behovet for manuelle justeringer i fremtidige overføringer, noe som effektiviserer hele synkroniseringsprosessen.

Dersom institusjonen trenger å oppdatere eller endre preferansene på et senere tidspunkt, kan institusjonen enkelt gå tilbake til GUI-en, justere innstillingene og lagre dem på nytt ved å klikke "Lagre".
Disse nye konfigurasjonene vil da tre i kraft ved neste dataoverføring, slik at integrasjonen alltid er tilpasset nyeste krav.

Screenshot 2025-03-06 at 15.16.42.png


Hvor skal jeg åpne og jobbe med GUI?

GUI’en finner du i lenken under:
https://fs2alma-brukerimport-app-sandbox.de-c1.eu1.cloudhub.io/

Hvordan får jeg innlogging?

For å få innlogging til GUI’en bør man sende melding til utviklingsteamet.

(3) Tekniske oversikt om hvordan integrasjonen fungere i backend

Endringstyper i FS som triggerer integrasjonen

ENDRET_POSTADRESSE

ENDRET_NAVN

SLUTTET_PA_STUDIEPROGRAM

ENDRET_FOLKEREGISTRERT_ADRESSE

ENDRET_LANETAKER_ID

STUDENTKORT_UTSTEDT

ENDRET_MOBILNUMMER

ENDRET_BIBLIOTEK

STUDENTKORT_UTGATT

ENDRET_EPOSTADRESSE

ENDRET_FEIDE_BRUKER

STUDENTKORT_UGYLDIGGJORT

ENDRET_STUDENTNUMMER

STARTET_PA_STUDIEPROGRAM

STUDENTKORT_GYLDIGGJORT

STUDENTKORT_FORLENGET

VURDERINGSMELDT

VURDERINGSMELDING_SLETTET

STUDIERETT_FORLENGET

SEMESTERREGISTRERT

ENDRET_MALFORM

DODSFALL

DODSFALL_ANNULLERT

Gyldige studienivåer

FAGSKOLE

BACHELOR

MASTER

PHD

Filtering bort profiler

Integrasjonen bestemmer først en utløpsdato for studentprogrammer basert på dataene mottatt fra FS.
Integrasjonen skaper en estimert utløpsdato til de studentene som mangler en sluttdato og beholder kun det siste studieprogrammet for hver student.
(år-08-31 dersom gjeldende måneden er før august og [år+1]-01-31 dersom gjeldende måneden er etter august)
Deretter henter den konfigurasjonsdataene satt opp av institusjonen gjennom GUI’en, og filtrerer deretter ut profiler basert på preferansene.

Dessuten filtrerer den ut profiler som allerede har sluttdato og sikrer at kun studenter med gyldige studieprogram er inkludert i den endelige produksjonen.

Bibliotek Kode

Vi lager en ordnet prioritetsliste laget av seks prioritetselementer hentet fra FS og setter den høyeste ikke-null-prioriteten som bibliotekkoden.
Deretter matcher vi den bestemte bibliotekkoden med kartleggingen levert av institusjonen gjennom GUI’en.

Dataene som benyttes for å opprette en student profil i Alma

First Name

Last Name

Birth Date

Account Expiry Date

Campus Code

Preferred Language

User Identifier [University ID] ::
feideBruker

User Identifier [Barcode] :: lanetakerId

Library Affiliation ::
rs_library

User Group (User Category)

Primary ID ::
orgFSID + personlopenummer

Account Type ::
External

Contact Info [Address]

Contact Info [Email]

Contact Info [Phone]

NB!

(4) Hvordan en overføring/synk kan bekreftes


Loggoversikt

For å sikre en sømløs og transparent overvåking av brukerimportintegrasjon, har vi utviklet et loggoversikt Overvåkningssystem.
Dette systemet gjør det enkelt for institusjoner å sjekke statusen til brukere profiler etter hvert som de går gjennom integrasjonsprosessen.
Enten en profil blir opprettet, oppdatert eller synkronisert, blir prossesen logget i Loggoversikt, slik at det er enkelt å overvåke og identifisere eventuelle problemer.

Når en profil er behandlet vellykket, viser Loggoversikt en grønn statusindikator, som bekrefter at integrasjonen er fullført uten problemer.
Dersom prosessen derimot mislykkes eller feiler av en eller annen grunn, blir den berørte profilen automatisk plassert i en ny forsøk-kø (redo queue).
Dette sikrer at systemet prøver å overføre profilen på nytt med forhåndsdefinerte intervaller, slik at midlertidige feil kan løses automatisk.

Hvis profilen fortsatt ikke kan overføres etter flere prøver, sender Loggoversikt en varsling til utviklingsteamet.
På dette stadiet blir feilen eskalert for videre undersøkelse.
Utviklingsteamet analyserer problemet nøye, identifiserer årsaken og implementerer en løsning for å sikre at profilen blir behandlet i neste forsøk.

Ved å bruke Loggoversikt får instiusjoner et sanntids, pålitelig og automatisert overvåkningssystem som minimerer forstyrrelser og sikrer en smidig synkronisering av brukerprofiler i integrasjonen.

Eksempel på skjermbilde

Under er et bilde fra loggoversiktssystemet.
Du kan registrere deg slik at når det oppstår en feil, sender systemet en varslingsmelding.

Loggoversiktssystemet viser om overføringen har vært vellykket eller mislyktes med grønne eller røde etiketter sammen med årsaken.

Alma_fig1.png

Hvor skal jeg åpne og jobbe med Loggoversiktssystemet?

Loggoversiktssystemet i produksjonsmiljøet finner du i lenken under:
https://dbapp.de-c1.eu1.cloudhub.io/?app=dbapp_prod

og i testsmiljøet kan finnes i:
https://dbapp-sandbox.de-c1.eu1.cloudhub.io/?app=dbapp_test

Hvordan får jeg innlogging?

For å få innlogging til loggoversiktssystemet bør man sende melding til utviklingsteamet.

(5) Hvordan tilgang til FS data kan bestiles

Forutsetning for å komme i gang

Sørge for at integrasjonsbrukeren i FS har nødvendige API-tilganger.
integrasjonsbrukeren for hver institusjon er av formen:
mule_<institusjonens forkortelse>
F.eks. mule_oslomet
Søknad om tilgang fylles her : https://nettskjema.no/a/324543
Den må fylles på denne måten

image-20250219-150340.png

Følgende roller må da velges:

STUDENTDATA_LES1
STUDENTDATA_HENDELSER_LES1
STUDENT_INNREISENDE_UTVEKSLING_LES1
STUDENT_STUDIERETT_LES1
STUDENT_STUDIERETT_HENDELSER_LES1
STUDENT_SEMESTERREGISTRERING_LES1
STUDENT_SEMESTERREGISTRERING_HENDELSER_LES1
STUDENT_VURDERING_LES1
STUDENT_VURDERING_HENDELSER_LES1
STUDENT_STUDENTKORT_LES1
STUDENT_STUDENTKORT_HENDELSER_LES1
STUDIEELEMENTER_LES2