Sunet LMS
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ändelse | Orsak till händelse | Vad gör adaptern i Canvas |
|---|---|---|
| LokalStudent | Inträffar när en ny student antas till lärosätet. |
|
| Kontaktuppgifter | Inträffar om studentens uppgifter i Ladok uppdateras. | Uppdaterar ett studentkonto i Canvas, 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. | |
| 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.
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.
Studiedeltagande (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.
Om inställningen UseConcluded används kommer studenten att få status avslutad (concluded) i Canvas när resultat på hel kurs attesteras. Det medför att studenten inte kan utföra inlämningar mm i det aktuella kursrummet för kurstillfället.
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.
| 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 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. OBS kan endast vara true om UseAsLoginId = ssn. |
| 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. |
| EducationTypeIgnoreList | 1,2,3,n | Lista av utbildningstyper som adaptern ska ignorera och då inte skapa kursrum eller lägga till studenter till. Till exempel kan ett lärosäte exkludera alla programhändelser om man inte vill använda kursrum för programtillfällen. |
| UseConcluded | True/false | Om UseConcluded är påslagen lyssnar canvasadaptern på händelserna “Attestering av resultat på hel kurs” och "Avklarad på kurspaketering" och vid någon av dessa händelser så ändrar canvasadaptern status till avslutad på studentens enrollment i de kursrum där den kursen/programtillfället ges. |
| EnrollmentsOtherSections | True/false | Om EnrollmentsOtherSections söker adaptern efter studenten i samtliga sektioner (även manuellt skapade) i kursrummet vid avslutande eller vid bortplockning och hantera då även dessa. |
Utbildningstyper
3 Modul utan omfattning - 2007MUO
4 Modul - 2007MOD
22 Kurs, grundnivå - 2007GKURS
24 Kurs, avancerad nivå - 2007AKURS
52 Kurstillfälle - 2007KTF
78 Program - 2007PRG
94 Programtillfälle - 2007PRGTF
101270 Inriktning - 2007INR
101290 Inriktningstillfälle - 2007INRTF
101291 Kurspaket - 2007KP
101292 Kurspakettillfälle - 2007KPTF
101370 Kurs, grundutbildning - 1993GKURS
101371 Modul - 1993MOD
101372 Program - 1993PRG
101373 Programtillfälle - 1993PRGTF
101374 Kurstillfälle, grundutbildning - 1993GKTF
101375 Utbytesavtal - 2007UA
101376 Utbytestillfälle, inresande - 2007UTFI
101377 Utbytestillfälle, utresande - 2007UTFU
101378 Kurs - FUPKURS
101379 Modul - FUPMOD
101380 Individuell kurs, grundnivå, inresande - 2007IKURS
101381 Individuellt kurstillfälle - 2007IKTF
101382 Kurstillfälle - FUPKTF
101730 Utbytesåtagande, utresande - 2007UAT
101731 Individuellt tillfälle för utbytesåtagande, utresande - 2007UATTF
101950 Individuellt åtagande, forskarnivå - 2007FAT
101951 Tillfälle för individuellt åtagande, forskarnivå - 2007FATTF
101952 Forskningsarbete - 2007VF
101953 Tillfälle för forskningsarbete - 2007VFTF
101954 Kurs, forskarnivå - 2007FKURS
101955 Kurstillfälle, forskarnivå - 2007FKTF
101956 Ämne, forskarnivå - 2007FA
101957 Ämnestillfälle, forskarnivå - 2007FATF
101958 Individuellt utbytesåtagande, forskarnivå, utresande - 2007FUAT
101959 Individuellt tillfälle för utbytesåtagande, forskarnivå, utresande - 2007FUATF
101960 Inriktning - 1993INR
101961 Inriktningstillfälle - 1993INRTF
101962 Individuell kurs, inresande - 1993IKURS
101963 Individuellt kurstillfälle, inresande - 1993IKTF
101964 Utbytesavtal - 1993UA
101965 Utbytestillfälle, utresande - 1993UTFU
101966 Utbytestillfälle, inresande - 1993UTFI
101967 Kurs, forskarutbildning - 1993FKURS
101968 Kurstillfälle, forskarutbildning - 1993FKTF
101969 Ämne, forskarutbildning - 1993FA
101970 Ämnestillfälle, forskarutbildning - 1993FATF
101971 Program - FUPPRG
101972 Programtillfälle - FUPPRGTF
101973 Inriktning - FUPINR
101974 Inriktningstillfälle - FUPINRTF
101975 Modul - YHMOD
101976 Modul utan omfattning - FUPMUO
101990 Modul utan omfattning - UPHPMUO
101991 Modul - UPHPMOD
101992 Kurs, grundnivå - UPHPGKURS
101993 Kurs, avancerad nivå - UPHPAKURS
101994 Kurstillfälle - UPHPKTF
101995 Inriktning - UPHPINR
101996 Inriktningstillfälle - UPHPINRTF
101998 Program - UPHPPRG
101999 Programtillfälle - UPHPPRGTF
102000 Kurs - UPTKURS
102001 Modul - UPTMOD
102002 Kurstillfälle - UPTKTF
102003 Modul - PREPMOD
102004 Kurs - PREPKURS
102005 Kurstillfälle - PREPKTF
102006 Kurs - UPVKURS
102007 Modul - UPVMOD
102008 Kurstillfälle - UPVKTF
102009 Kurs - FUVKURS
102010 Modul - FUVMOD
102011 Kurstillfälle - FUVKTF
102012 Kurs - KYKURS
102013 Modul - KYMOD
102014 Kurstillfälle - KYKTF
102070 Program - FUVPRG
102071 Programtillfälle - FUVPRGTF
102072 Inriktning - FUVINR
102073 Inriktningstillfälle - FUVINRTF
103210 Utbytesåtagande, utresande - 1993UAT
103211 Individuellt tillfälle för utbytesåtagande, utresande - 1993UATTF
104308 Individuellt utbytesåtagande, utresande - 2007IUAT
105630 Kurs, grundnivå (inkl. attribut från 1993 års studieordning) - 0793GKURS
105631 Kurs, avancerad nivå (inkl. attribut från 1993 års studieordning) - 0793AKURS
105632 Kurstillfälle (inkl. attribut från 1993 års studieordning) - 0793KTF
106390 Individuell kurs, avancerad nivå, inresande - 2007AIKURS
107510 Individuellt kurstillfälle, forskarnivå - 2007FIKTF
107524 Program (inkl. attribut från 1993 års studieordning) - 0793PRG
107525 Programtillfälle (inkl. attribut från 1993 års studieordning) - 0793PRGTF
109970 Program - POLISPRG
109971 Modul - POLISMOD
109972 Kurs - POLISKURS
109973 Kurstillfälle - POLISKTF
109974 Programtillfälle - POLISPRGTF
109977 YH-utbildning - YHUTB
109978 Kurs - YHKURS
109979 YH-utbildningstillfälle - YHUTBTF
109980 Kurstillfälle - YHKTF
110915 Forskningsarbete (utan angiven omfattning) - 2007VFUO
117019 Tillfälle för utbytesåtagande, utresande - 2007UATTFR
121171 Program - FHSPRG
121172 Programtillfälle - FHSPRGTF
121173 Inriktning - FHSINR
121174 Inriktningstillfälle - FHSINRTF
121175 Kurs - FHSKURS
121176 Kurstillfälle - FHSKTF
121177 Modul - FHSMOD
121257 Modul - FUTMOD
121258 Kurs - FUTKURS
121259 Kurstillfälle - FUTKTF
121910 Kurs, forskarnivå (inkl. attribut från grundnivå och avancerad nivå) - 20073KURS
121911 Kurstillfälle, forskarnivå (inkl. attribut från grundnivå och avancerad nivå) - 20073KTF
122030 Kurs - HIKURS
122031 Kurstillfälle - HIKTF
138460 Individuellt kurstillfälle, grundutbildning - 1993GIKTF
138461 Individuellt kurstillfälle, forskarutbildning - 1993FIKTF
138692 Kurs, grundnivå - PU18GKURS
138693 Kurs, avancerad nivå - PU18AKURS
138694 Modul - PU18MOD
138695 Modul utan omfattning - PU18MUO
138696 Kurstillfälle - PU18KTF
143781 Program - PU18PRG
143782 Programtillfälle - PU18PRGTF
147785 Kurspaket - FUPKP
147786 Kurspakettillfälle - FUPKPTF
147908 Modul - UPTMOD19
147909 Kurs - UPTK19
147910 Kurstillfälle - UPTKTF19
148155 Individuellt kurstillfälle - FUPIKTF
148452 Modul utan angiven omfattning - 2007MUAO
148962 Individuellt kurstillfälle, inresande - 2007IKTFI
151503 Kurspaket, forskarnivå - 2007FAKP
151504 Kurspakettillfälle, forskarnivå - 2007FAKPTF
152631 Deltagande utan omfattning, forskarnivå - 2007FDU
152632 Individuellt tillfälle för deltagande utan omfattning, forskarnivå - 2007FDUIT
152633 Deltagande utan omfattning, grund- och avancerad nivå - 2007GADU
152634 Individuellt tillfälle för deltagande utan omfattning, grund- och avancerad nivå - 2007GADUITF
152635 Tillfälle för deltagande utan omfattning, grund- och avancerad nivå - 2007GADUTF