Skip to main content

IMS Sync - Kunskapsbas / Införandeguide för huvudman / Användarsynk - Skolon Support

IMS Sync

Authors list

Introduktion

Skolon har stöd för att läsa in användare, skolmedlemskap och gruppmedlemskap via en IMS formaterad XML-fil. För att det ska fungera korrekt behöver filen schemaläggas att skickas in till Skolon efter önskad tidsintervall och vara formaterad enligt IMS formatet.

Läs mer om standarden här.


Filen ska innehålla tre typer av objekt:

Personobjekt: Innehåller all information om en användare
Gruppobjekt: Innehåller gruppnamn och id
Gruppmedlemskapsobjekt: Innehåller en lista på id som ska vara kopplade till en grupp.

 

Skolons användarprovisioneringsspecifikation

Person

Beskrivning

En person representerar en lärare (eller liknande befattning) eller en elev. Användare måste tillhöra minst en klass eller undervisningsgrupp (via gruppmedlemskapsobjektet) för att läsas in till Skolon. Elever kan bara tillhöra en (1) klass.

Egenskaper

Namn

Beskrivning

Krav

sourcedid.id

Ett unikt ID för en person

Ja

name.fn

Hela formaterade namnet

Ja

name.n.family

Efternamn

Ja

name.n.given

Förnamn

Ja

email

Epost

Ja

tel

Telefonnummer

Nej

tel.telType

Vilken typ av telefon. Antingen Voice, Mobile eller Work

Nej

adr.street

Gatuadress

Nej

adr.locality

Stad

Nej

adr.pcode

Postnummer

Nej

institutionrole.primaryrole

Är detta personens huvudroll, Yes eller No

Nej

institutionrole.institutionroletype

Personens roll. Antingen Staff, Instructor eller Student

Ja

extension.birthdate

Födelsedatum

Nej

extension.yeargroups

<yeargroup unit="B_SK" schoolType="GR">2</yeargroup>
För yeargroup är giltiga värden 0-10.
Se https://github.com/girgen/ss12000v2/blob/master/Enrolment.yaml
Skolform specas under "schoolType", defaultas till "GR. Giltiga värden finns här: https://github.com/girgen/ss12000v2/blob/master/common.yaml

Nej

 

Grupp

Beskrivning

En grupp kan vara antingen en skola, klass, undervisningsgrupp eller någon annan form av användargupp. Varje grupp måste tillhöra en skola.

Egenskaper

Namn

Beskrivning

Krav

sourcedid.id

Ett unikt ID för gruppen

Ja

description.short

Gruppens namn

Ja

grouptype.typevalue

Gruppens typ.
Antingen:
UNIT, SCHOOL, CLASS, CLASSGROUP, STUDYGROUP, COURSEGROUP eller EDUCATIONGROUP

Relationen mellan grupptyperna och grupptyperna i Skolon:
UNIT, SCHOOL beskriver en Skola. Dessa grupper läses enbart och kan inte redigera data i Skolon.


CLASS, CLASSGROUP används för att beskriva klasser. 

STUDYGROUP, COURSEGROUP, EDUCATIONGROUP används för att beskriva undervisningsgrupper

Ja

relationship.sourcedid.id

sourcedid.id beskriver ägaren av gruppen. Oftast en skola.

Ja


Gruppmedlemskap

Beskrivning

Ett gruppmedlemskapsobjekt beskriver vilka personobjekt som tillhör en grupp. Ett medlemskapsobjekt kan (och borde) innehålla flera medlemmar (members).


Egenskaper

Namn

Beskrivning

Krav

sourcedid.id

ID för det gruppobjekt vilket detta medlemsobjekt beskriver medlemmarna för

Ja

member.sourcedid.id

ID för personobjektet som ska vara medlem i gruppen

Ja

Ja, denna artikel var till hjälp. Nej, denna artikel var inte till någon hjälp.