...
Här samlar vi teknisk information om adaptern som kan vara bra för lärosätet att känna till.
| Table of Contents |
|---|
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ändelse | Orsak till händelse | Vad 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ändelse | Orsak till händelse | Vad 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. |
| KurstillfalleTillStatus | Inträ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. |
| KursUppdaterad | Inträffar när en kurs uppdateras. | Uppdaterar canvaskursen med de uppgifter som härrör från kurs i Ladok , tex namn och kurskod. |
| KurstillfalleUppdaterat | Inträ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. |
| UtbildningstillfalleInstallt | Inträ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ändelse | Orsak till händelse | Vad 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. |
| Omregistrering | Inträffar när en student omregistreras på ett kurstillfälle i Ladok. | Studenten läggs in Canvaskursen. |
| Registrering | Inträffar när studenten registrerar sig på ett kurstillfälle. | Studenten läggs in Canvaskursen. |
| ForvantatDeltagandeSkapad | Inträ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. |
| ForvantatDeltagandeBorttaget | Inträffar när en antagning tas bort i Ladok. | Studenten tas bort från Canvaskursen. |
| Avbrott | Inträffar när en student gör avbrott på ett kurstillfälle eller program. | Studenten tas bort från Canvaskursen. |
| AvbrottBorttaget | Inträffar när ett avbrott tas bort på ett kurstillfälle eller program. | Studenten läggs tillbaka in på Canvaskursen. |
| Aterbud | Inträffar när studenten gör återbud på sin antagning på kurstillfället. | Studenten tas bort från Canvaskursen. |
| Uppehall | Inträffar när en student gör uppehåll på ett program. | Inget händer i Canvas, studenten ligger kvar i canvaskursen. |
| UppehallBorttaget | Inträffar när ett uppehåll på ett program upphör. | Om studenten inte finns i canvaskursen läggs studenten tillbaka. |
| PaborjatUtbildningstillfalle | Inträ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:
- En kurs i Canvas får inställningen ”tidig åtkomst”
- En antagning överförs från Ladok
- Adaptern läser in antagningshändelsen och lägger in studenten som antagen
- En registrering överförs från Ladok
- Adaptern läser in registreringshändelsen och lägger in studenten som registrerad
Exempel B – Kursen konfigureras vid för sen tidpunkt
- En antagning överförs från Ladok (men passerar adaptern eftersom den inte är inställd att ta hand om det)
- En kurs i Canvas får inställningen ”tidig åtkomst”
- En registrering överförs från Ladok
- 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.
...
| Namn | Möjliga värden | Fö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. |
| UpdateEmailFromLadok | True/false | Om email för studenter ska uppdateras med information från Ladok, Om true false så skapas studenter utan email. |
| UpdateNameFromLadok | True/false | Om namn på studenter ska uppdateras med information från Ladok |
| UpdateSsnFromLadok | True/false | Om personnummer för studenter ska uppdateras med information från Ladok |
| UseSubaccountsForProgramAndCourses | True/false | Om 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. |
| SubAccountNewOrganisations | Canvas id | Sub-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. |
| CourseNameFormat | 1, 2, 3, 4 | Format på Canvaskursens namn. 1 = Namn, 2 = Namn + Termin, 3 = Namn + Kurskod + Termin, 4 = Namn + Kurskod + Kurstillfälleskod + Termin |
| UseAdmitted | True/false | Detta är “Tidig åtkomst” (early |
| RoleIdRegistered | Canvas id | Canvas 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. |
| RoleIdAdmitted | Canvas id | Canvas 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. |
| UpdateCourseFromLadok | True/false | Om 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. |
| EarlyAccessOnCreateCourse | True/false | Om 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. |
| EarlyAccessDisablePurge | True/false | Om UseAdmitted är påslagen och om man inte vill att studenter ska tas bort per automatik. |
| UseRestrictions | True/false | Om avstängning av student ska vara påslaget. |
| RestrictionsSendMessageToTeachers | True/false | Om meddelande till samtliga lärare på aktiva kurser ska få meddelande om avstängningen. |