Funktion och konfiguration


Här samlar vi information om hur adaptern fungerar och hur den kan konfigureras.

Händelser

Canvasadaptern är händelsestyrd och lyssnar på händelser som kommer i form av LIS meddelanden från Ladok. Det finns ingen inbyggd fördröjning eller schemalagd hämtning i systemet mellan adaptern och Ladok men däremot kan meddelanden köas upp om det är många händelser som inträffar samtidigt. Normalt verkställs en händelse i Canvas från Ladok inom 5 minuter men under antagningsperioder kan det ta längre tid, upp till några timmar. Adaptern sparar i sig själv inga händelser men däremot så sparas tillstånd som har med samläsning, tidig åtkomst och avstängning att göra, dessa sparas i en databas som ägs av adaptern

Adaptern lyssnar på följande händelser:

Studentinformation

HändelseOrsak till händelseVad gör adaptern i Canvas
LokalStudent

Inträffar när en ny student antas till lärosätet.

Skapar upp ett nytt studentkonto i Canvas om inte kontot finns sedan tidigare.
Kontaktuppgifter

Inträffar om studentens uppgifter i Ladok uppdateras.

Skapar upp ett nytt studentkonto i Canvas om inte kontot finns sedan tidigare annars sker en uppdatering av studentens uppgifter, vilka uppgifter som uppdateras är beroende på hur adaptern är konfigurerad.
Avstängning

Inträffar när en student blir avstängd.

Tillsammans med händelsen kommer ett tidsspann när avstängningen skall vara aktiv. När denna tidpunkt inträffar sätts studenten som inaktiv på samtliga kurser i Canvas. Efter denna tidpunkt så inaktiveras även eventuella nya studiedeltaganden. När tidpunkten för avslutandet av avstängningen inträffar återaktiveras studenten i samtliga kurser. Om en kurs har status avslutad i Canvas ligger studenten kvar som aktiv på kursen, kursen är då i läsläge.

Utbildningsinformation

HändelseOrsak till händelseVad gör adaptern i Canvas
KurspaketeringstillfalleTillStatus

Inträffar när ett nytt program sätts till status påbörjad eller komplett. 

Skapar en ny canvaskurs eller uppdaterar om den redan existerar. 
KurspaketeringstillfalleUppdaterat

Inträffar när ett programtillfälle uppdateras. 

Uppdaterar canvaskursen med uppgifter om programtillfället, i praktiken är det start och slutdatum som kan ändras och överföras till Canvas. Om canvaskursen saknas skapas den. 
KurspaketeringUppdaterad

Inträffar när ett program uppdateras.

Ej implementerad i dagsläget, skulle medföra att namnändringar på programtillfällen kan överföras från Ladok utan att programtillfället behöver uppdateras. 
KurstillfalleTillStatusInträffar när status för en kurs sätts till påbörjad eller komplett. Skapar en ny canvaskurs eller uppdaterar om den redan existerar.
KursUppdateradInträffar när en kurs uppdateras. Uppdaterar canvaskursen med de uppgifter som härrör från kurs i Ladok , tex namn och kurskod. 
KurstillfalleUppdateratInträffar när ett kurstillfälle uppdateras. Uppdaterar canvaskursen med uppgifter om kurstillfället, i praktiken är det start och slutdatum samt kurstillfälleskod som kan ändras och överföras till Canvas. Om canvaskursen saknas skapas den. 
UtbildningstillfalleInstalltInträffar när ett kurstillfälle blir inställt. Uppdaterar namnet på canvaskursen med prefixet [INSTÄLLT]. 

Studiedeltagande

Samtliga händelser för studiedeltagande kontrollerar om canvaskursen och studenten existerar i Canvas, om någon av dessa saknas skapas de upp innan studiedeltagandet behandlas. 

HändelseOrsak till händelseVad gör adaptern i Canvas
StudentTillLarosate

Inträffar när en ny student antas till lärosätet. 

Skapar upp ett nytt studentkonto i Canvas om inte kontot finns sedan tidigare 
AterkalladOmregistrering

Inträffar när en omregistrering tas bort i Ladok. 

Studenten tas bort från Canvaskursen. 
Aterkalladregistrering

Inträffar när en registrering tas bort i Ladok. 

Studenten tas bort från Canvaskursen. 
OmregistreringInträffar när en student omregistreras på ett kurstillfälle i Ladok. Studenten läggs in Canvaskursen. 
RegistreringInträffar när studenten registrerar sig på ett kurstillfälle. Studenten läggs in Canvaskursen. 
ForvantatDeltagandeSkapadInträffar när en ny student antas till lärosätet och när Ladok överför antagningshändelsen. Studenten läggs in på Canvaskursen som tidig åtkomst (antagen) på canvaskursen. 
ForvantatDeltagandeBorttagetInträffar när en antagning tas bort i Ladok. Studenten tas bort från Canvaskursen. 
AvbrottInträffar när en student gör avbrott på ett kurstillfälle eller program. Studenten tas bort från Canvaskursen. 
AvbrottBorttagetInträffar när ett avbrott tas bort på ett kurstillfälle eller program. Studenten läggs tillbaka in på Canvaskursen. 
AterbudInträffar när studenten gör återbud på sin antagning på kurstillfället. Studenten tas bort från Canvaskursen. 
UppehallInträffar när en student gör uppehåll på ett program. Inget händer i Canvas, studenten ligger kvar i canvaskursen. 
UppehallBorttagetInträffar när ett uppehåll på ett program upphör. Om studenten inte finns i canvaskursen läggs studenten tillbaka.  
PaborjatUtbildningstillfalleInträffar när en student registrerar sig på ett kurstillfälle inom ett program. Studenten läggs in i Canvaskursen för programtillfället som registrerad. 
AterkallatPaborjatUtbildningstillfalle Inträffar när en student gör avbrott. Studenten tas bort från Canvaskursen för programtillfället. 


Flödet av händelser

Adaptern sparar själv inga händelser utan dessa skickas bara vidare till Canvas, för att samläsning och tidig åtkomst skall fungera som tänkt är det därför viktigt att canvaskursen konfigureras enligt önskemål innan antagningar och registreringar börjar strömma in till adaptern.

Här är ett par exempel på konsekvenser av detta.

Exempel A – Kursen konfigureras i en korrekt tidig tidpunkt innan antagningshändelser kommer från Ladok:

  1. En kurs i Canvas får inställningen ”tidig åtkomst”
  2. En antagning överförs från Ladok
  3. Adaptern läser in antagningshändelsen och lägger in studenten som antagen
  4. En registrering överförs från Ladok
  5. Adaptern läser in registreringshändelsen och lägger in studenten som registrerad

Exempel B – Kursen konfigureras vid för sen tidpunkt

  1. En antagning överförs från Ladok (men passerar adaptern eftersom den inte är inställd att ta hand om det)
  2. En kurs i Canvas får inställningen ”tidig åtkomst”
  3. En registrering överförs från Ladok
  4. Adaptern läser in registreringshändelsen och lägger in studenten som registrerad

I exempel B kommer studenten aldrig att läggas in som antagen på kursen eftersom händelsen redan hade passerat adaptern när kursen fick inställningen ”tidig åtkomst”.

Kursadministrationsverktyget

För att konfigurera canvaskurser med tidig åtkomst eller eventuell samläsning finns en LTI applikation "Kursadministration" som lärosätet kan installera. I Kursadministration kan man slå på eller stänga av tidig åtkomst samt konfigurera samläsning genom att koppla ihop ett eller flera kurstillfällen till en canvaskurs.

Studenter

Studenter skapas av adaptern med följande data: sis_user_id=ladok uid, name = för och efternamn,
email sätts om konfigurationsparametern UpdateEmailFromLadok är true, login_id sätts till antingen
persnr eller ladok uid beroende på konfigurationsparametern UseAsLoginId.

Terminer

Terminer skapas automatiskt av adaptern om dom inte redan finns. Namn tas då från Ladok och det
namnet sätts som både namn och sis id för den nya terminen. Namnet på en termin kan sedan
ändras i Canvas då terminen fortsättningsvis identifieras med sis id. Vid migration kan en befintlig
termin kompletteras med sis id som då matchas med terminsnamnet från Ladok. Lämpligtvis testas
detta i testmiljön. Adaptern sätter inga datum för terminen.

Organisationer

Organisationer hanteras som Canvas underkonton (subaccounts) och dessa skapas av adaptern om
de inte redan finns. De identifieras av en Ladok uid som sätts på underkontots sis id. Namnet på
underkontot kan ändras, underkontot kan också flyttas, om man flyttar kontot bör även underkonto
för kurs och program följa med (gäller om UseSubaccountsForProgramAndCourses är satt).
Underkonton flyttas med sis import eller via Rest API. Vid migrering ser man till att komplettera
eventuella befintliga underkonton med korrekta sis id. Detta testas lämpligen i testmiljön.

Canvaskurser

När en kurs skapas i Canvas av adaptern sätts namn, kurskod (short_name), startdatum, slutdatum
och sis id. Kurskoden sätts till kurskod + kurstillfälleskod. Start och slutdatum sätts med data från
Ladok men kursen ges inga inställningar som påverkas av dessa datum. Sis id för kursen sätts till
Ladok uid för kurstillfället (eller programtillfället/programinriktningstillfället). Radering av kurser i
Canvas bör vara avstängt i gränssnittet eftersom det annars kan bli problem med krockar i sis id.

Sektioner

Sektioner skapas när kursen skapas och namnsätts med kurskod:kurstillfälleskod:termin och sis id
sätts till ladok uid för kurstillfället. Radering av sektioner skapade av adaptern bör undvikas för att
inte få problem med krockar i sis id.

Enrollments

Adaptern hanterar studenter på Canvaskurser genom enrollments på sektioner, de läggs in med
enroll och tas bort med unenroll. Adaptern använder inte begreppen aktiv/inaktiv.
Om UseAdmitted används och Ladokhändelsen ForvantatDeltagandeSkapad inträffar så läggs
studenten in som antagen och om ForvantatDeltagandeBorttaget inträffar tas studenten bort.
Om någon av följande Ladok händelser inträffar för en student Registrering, Omregistrering,
AvbrottBorttaget, UppehallBorttaget eller PaborjatUtbildningstillfalle läggs studenten in som
registrerad. Om någon av följande händelser inträffar för en student AterkalladRegistrering,
Aterbud, AterkalladOmregistrering, Avbrott, AterkallatPaborjatUtbildningstillfalle tas studenten bort
från kursen.

Vid Ladok händelse Uppehåll tas inte studenten bort utan ligger kvar på kursen.

Tidig åtkomst

Tidig åtkomst (early access) innebär att studenter får åtkomst till Canvaskursen när de antas till
kurstillfället istället för när de registrerar sig. Eftersom antagningen sker tidigare än registreringen
kan detta användas till kurser där man måste få ut information i ett tidigt skede. Om lärosätet vill
använda sig av tidig åtkomst konfigureras detta och lärosätet kan då välja att antingen styra detta
per kurs genom att det slås på manuellt via administrationsapplikationen eller att alla kurser skapas
med tidig åtkomst. När en kurs får tidig åtkomst sätts ett datum som innebär att vid detta datum så
tas studenten bort automatiskt om denne inte ännu har registrerat sig, detta kan också stängas av i
lärosätets konfiguration.

Samläsning

I den gamla adaptern kunde man använda den i Canvas inbyggda funktionaliteten cross-listing för att
flytta en sektion till en annan Canvaskurs och på så sätt låta två kurstillfällen samlas i en Canvaskurs.
Den nya adaptern är bakåtkompatibel med detta men den har också en ny samläsningsfunktionalitet
där man istället för att flytta sektioner kopierar dessa. Ett kurstillfälle kan då få tillgång till flera
Canvaskurser samtidigt, till exempel om man vill dela upp ett kurstillfälle på flera Canvaskurser.
Den nya samläsningen styr man i administrationsapplikationen genom att söka upp och välja vilka
sektioner som ska samläsa i den Canvaskurs där man startat administrationsapplikationen.

Konfiguration

Varje lärosäte har sin egen konfiguration av adaptern, följande konfigurationsparametrar finns och
dessa sätts för hela lärosätet, det går inte att använda olika konfigurationer för vissa organisationer
(underkonton) för lärosätet.


NamnMöjliga värdenFörklaring
UseAsLoginId ”ssn”/"ladokuid" Väljer vad som ska användas för
LoginId på personens konto i
Canvas. Skall personnummer
användes väljer man här ssn och
ska Ladok uid användas skriver
man in ladokiud.
UpdateEmailFromLadokTrue/falseOm email för studenter ska
uppdateras med information från
Ladok, Om false så skapas
studenter utan email.
UpdateNameFromLadokTrue/falseOm namn på studenter ska
uppdateras med information från
Ladok
UpdateSsnFromLadokTrue/falseOm personnummer för studenter
ska uppdateras med information
från Ladok
UseSubaccountsForProgramAndCoursesTrue/falseOm underkonton på organisation
ska användas. Denna sätts till True
om man vill att det skall skapas upp
ytterligare en nivå med två
underkonton (kurs och program)
under organisationen i samband
med att kursen skapas. Finns redan
dessa konton läggs alla nya
kurser/program i dessa.
SubAccountNewOrganisationsCanvas idSub-account där ev nya
organisationer skapas. Här skriver
man in det Canvas id som
identierar det konto där man vill
att nya organisationer ska skapas.
Har man inget speciellt konto för
detta kan 1 användas, då skapas
dessa direkt under lärosätets
huvudkonto.
CourseNameFormat1, 2, 3, 4Format på Canvaskursens namn. 1
= Namn, 2 = Namn + Termin, 3 =
Namn + Kurskod + Termin, 4 =
Namn + Kurskod + Kurstillfälleskod
+ Termin
UseAdmittedTrue/false

Detta är “Tidig åtkomst” (early
access). Om en student som blivit
antagen men ännu inte registrerad
ska läggas till på Canvaskursen.
Sätts till False om endast
registrerade studenter ska läggas in
på Canvaskursen, studenter
kommer då att läggas in med
standardrollen student på kursen.
Om denna sätts till True kommer
två nya roller att behöva skapas i
Canvas baserade på rollen student.
Studenten då att läggas till med
någon av dessa baserat på vilken
händelse som inträffat (antagen
eller registrerad) en student kan ha
båda rollerna samtidigt.

RoleIdRegisteredCanvas idCanvas id på roll (behövs om
UseAdmitted är påslagen) Rollen
kan ha samma behörigheter som
standardrollen för student men
behövs för att kunna särskiljas på
namn. Denna kan också vara
standardrollen för student men då
kan inte namnet ändras utan den
måste heta Student.
RoleIdAdmittedCanvas idCanvas id på roll (behövs om
UseAdmitted är påslagen) Rollen
kan ha samma behörigheter som
standardrollen för student men
behövs för att kunna särskiljas på
namn.
UpdateCourseFromLadokTrue/falseOm uppdateringar från Ladok skall
skriva över kursen i Canvas, dvs
namn, kurskod, datum. Om lärare
tillåts ändra denna information i
Canvas rekommenderas att denna
sätts till False, annars kan adaptern
skriva över de ändringar som
läraren gjort på kursen.
EarlyAccessOnCreateCourseTrue/falseOm UseAdmitted är påslagen och
om man vill att Tidig åtkomst
automatiskt ska sättas när kurserna
skapas. Detta gäller då alla kurser
för lärosätet.
EarlyAccessDisablePurgeTrue/falseOm UseAdmitted är påslagen och
om man inte vill att studenter ska
tas bort per automatik.
UseRestrictionsTrue/falseOm avstängning av student ska vara påslaget.
RestrictionsSendMessageToTeachersTrue/falseOm meddelande till samtliga lärare på aktiva kurser ska få meddelande om avstängningen.
  • No labels