Beheerdersdocumentatie

IPSIS OneRoster gebruiken met Brightspace® ouder/voogd

IPSIS OneRoster kan gebruikersrelaties tussen een ouder/wettelijke voogd en een kind naar Brightspace® sturen. Integratie van IPSIS OneRoster in Brightspace® ouder & voogd is alleen beschikbaar voor klanten in de VS, Canada, Australië en Ierland.

Momenteel worden alleen de volgende rollen als relevant beschouwd voor een relatie:

Bovenliggend item
Voogd
Cursist

Alle andere rollen worden genegeerd.

Stappen om OneRoster in te stellen

Open op de pagina IPSIS-beheer het tabblad Configuratie.
Als u een OneRoster 1.1 - CSV-bronsysteem hebt, worden de SFTP-aanmeldgegevens weergegeven. Kopieer de host, de gebruikersnaam en het wachtwoord (deze zijn nodig voor uw SIS om CSV-bestanden naar Brightspace® te verzenden).
Als u een OneRoster 1.1 - REST-bronsysteem hebt, moet u de OAuth-methode selecteren.
1. OAuth1.0a is standaard geselecteerd. Voer de geldige URL van het eindpunt, de consumentsleutel en het consumentgeheim in en selecteer de OAuth-ondertekeningsmethode.
2. Als OAuth2 is geselecteerd, voert u de geldige client-id en het clientgeheim in.
Wijs de rol van SIS-ouder of -voogd toe aan uw Brightspace®-rol voor ouders/voogden.
Wijs de rol van SIS-cursist toe aan uw Brightspace®-rol voor cursisten.
Wijs de SIS Org School toe aan een type organisatie-eenheid van Brightspace®.
Controleer de andere instellingen en klik op Opslaan.

Opmerking: Upload op basis van de indeling van uw gegevensuitwisseling een CSV-bestand om relaties tussen ouder en kind te maken of maak een REST-aanvraag om relaties tussen ouder/voogd en kind te maken. Zie hieronder voor een voorbeeld van een CSV-bestand en een REST-aanvraag.

Voorbeeld van CSV-bestand

sourcedId,status,dateLastModified,enabledUser,orgSourcedIds,role,username,userIds,givenName,familyName,middleName,identifier,email,sms,phone,agentSourcedIds,grades,password
{studentsourceId},active,,TRUE,{orgSourcedIds},student,{learner username},{userId},{learner given Name},{learner family name},,,{learner email},,, "{parentsourceId1}, {parentsourceId2}",,{password}
{parentsourceId1},active,,TRUE,{orgSourcedIds},parent,{parent username},{userIds},{parent given name},{parent family name},,,{parent email},,,{studentsourceId},,{ password}
{parentsourceId2},active,,TRUE,{orgSourcedIds},parent,{parent username},{userId},{parent given name},{parent family name},,,{parent email},,,{studentsourceId},,{ password}

REST-aanvraag

Als u ouder/voogd-kindrelaties wilt maken, moet in de REST-aanvraag voor het maken van een gebruiker ouder-/voogdinformatie in het agentveld worden opgenomen.

Raadpleeg REST-toewijzingswaarden hieronder voor gedetailleerde informatie over REST-aanvragen.

REST JSON-voorbeeld met gedefinieerde relaties

Voor een cursist:

{
	"users": [{
		"sourcedId": "user1",
		"status": "active",
		"dateLastModified": "2017-06-05T22:15:00.000Z",
		"username": "userone",
		"givenName": "Richard",
		"middleName": "",
		"familyName": "Deckard",
		"role": "student",
		"identifier": "user1",
		"enabledUser": true,
		"grades": [],
		"userIds": [],
		"orgs": [{
			"sourcedId": "District1",
			"href": "https://oneroster.infinitec",
			"type": "org"
		},
		{
			"sourcedId": "School1",
			"href": "https://some_url/learningdata/v1p1/schools/5C354F4D-DFD0-406D-8B83-7D5C8B64EF8B",
			"type": "org"
		}],
		"agents": [{
			"sourcedId": "Parent1",
			"href": "https://some_url/learningdata/learningdata/v1p1/users/Parent1",
			"type": "user"
		},
		{
			"sourcedId": "Parent2",
			"href": "https://some_url/learningdata/learningdata/v1p1/users/Parent2",
			"type": "user"
		}]
	}]
}

Voor een ouder/voogd:

{
	"users": [{
		"sourcedId": "Parent1",
		"status": "active",
		"dateLastModified": "2017-06-05T22:15:00.000Z",
		"username": "Parent1",
		"givenName": "James",
		"middleName": "",
		"familyName": "Deckard",
		"role": "parent",
		"identifier": "Parent1",
		"enabledUser": true,
		"grades": [],
		"userIds": [],
		"orgs": [{
			"sourcedId": "District1",
			"href": "https://oneroster.infinitec",
			"type": "org"
		},
		{
			"sourcedId": "School1",
			"href": "https://some_url/learningdata/v1p1/schools/5C354F4D-DFD0-406D-8B83-7D5C8B64EF8B",
			"type": "org"
		}]
	}]
}

CSV-toewijzingswaarden

Als u relaties tussen ouder/voogd en kind wilt kunnen maken, moet u AgentSourceId's in het bestand users.CSV bijwerken voor zowel ouders/voogden als cursisten.

Academische sessies

OneRoster	Ondersteunde waarden	Brightspace®-toewijzingen	Verplicht	Opmerkingen
SourcedId			J
Status	actief, tobedeleted		N	Veld is vereist voor bestanden in delta-modus.
DateLastModified			N	Veld is vereist voor bestanden in delta-modus. Datumnotatie JJJJ-MM-DDTHH:mm:SS.sssZ
Titel		Naam organisatie-eenheid en code organisatie-eenheid	J
Type			J	Type organisatie-eenheid
StartDate			J	DD-MM-JJJJ
EndDate			J	DD-MM-JJJJ
ParentSourcedId			N	Niet gebruikt
SchoolYear			N	Niet gebruikt

Organisaties

OneRoster	Ondersteunde waarden	Brightspace®-toewijzingen	Verplicht	Opmerkingen
SourcedId			J
Status	actief, tobedeleted		N	Veld is vereist voor bestanden in delta-modus.
DateLastModified			N	Veld is vereist voor bestanden in delta-modus. Datumnotatie JJJJ-MM-DDTHH:mm:SS.sssZ
Naam		Naam organisatie-eenheid en code organisatie-eenheid	J	Als het veld Id leeg is, wordt de naam gekopieerd in Code organisatie-eenheid in Brightspace®
Type	nationaal, staat, lokaal, district, school, afdeling		J	Definieert het OrgUnitType in Brightspace®. http://www.imsglobal.org/oneroster-v11-final-specification#_Toc480452024
Id		Code organisatie-eenheid (indien opgegeven)	N
ParentSourcedId			N	Dit veld specificeert de bovenliggende organisatie-eenheid.

Cursussen

OneRoster	Ondersteunde waarden	Brightspace®-toewijzingen	Verplicht	Opmerkingen
SourcedId			J
Status	actief, tobedeleted		N	Veld is vereist voor bestanden in delta-modus.
DateLastModified			N	Veld is vereist voor bestanden in delta-modus. Datumnotatie JJJJ-MM-DDTHH:mm:SS.sssZ
SchoolYearSourcedId			N	Niet gebruikt
Titel		Naam organisatie-eenheid en code organisatie-eenheid	J	Maakt een Brightspace®-cursussjabloon. Als het veld CourseCode leeg is, wordt de titel gekopieerd naar de OrgUnitCode.
CourseCode		Code organisatie-eenheid	N	Indien verstrekt
Scores			N	Niet gebruikt
OrgSourcedId			J	Dit veld specificeert de bovenliggende organisatie-eenheid.
Onderwerpen			N	Niet gebruikt
SubjectCodes			N	Niet gebruikt

Groepen

OneRoster	Ondersteunde waarden	Brightspace®-toewijzingen	Verplicht	Opmerkingen
SourcedId			J
Status	actief, tobedeleted		N	Veld is vereist voor bestanden in delta-modus.
DateLastModified			N	Veld is vereist voor bestanden in delta-modus. Datumnotatie JJJJ-MM-DDTHH:mm:SS.sssZ
Titel		Naam organisatie-eenheid en code organisatie-eenheid	J	Maakt een Brightspace®-sectie en cursuseditie. Als het veld ClassCode leeg is, wordt de titel gekopieerd naar de code van de organisatie-eenheid.
Scores			N	Niet gebruikt
CourseSourcedId			J	Dit veld specificeert de bovenliggende organisatie-eenheid
ClassCode		Code organisatie-eenheid (indien opgegeven)	N	Indien verstrekt
ClassType			J	Niet gebruikt
Locatie			N	Niet gebruikt
SchoolSourcedId			J	Niet gebruikt
TermsSourcedIds			N	Niet gebruikt
Onderwerpen			N	Niet gebruikt
SubjectCodes			N	Niet gebruikt
Perioden			N	Niet gebruikt

Gebruikers

OneRoster	Ondersteunde waarden	Brightspace®-toewijzingen	Verplicht	Opmerkingen
SourcedId		OrgDefinedId	J	Als het veld Id niet wordt ingevuld, wordt de SourcedId naar de OrgDefinedId gekopieerd.
Status	actief, tobedeleted		N	Veld is vereist voor bestanden in delta-modus.
DateLastModified			N	Veld is vereist voor bestanden in delta-modus. Datumnotatie JJJJ-MM-DDTHH:mm:SS.sssZ
EnabledUser			J	Niet gebruikt
OrgSourcedIds		Inschrijvingen bovenste org. eenheid (met rol in organisatie)	J	Inschrijving in de organisatie-eenheden van de school
Rol	beheerder, assistent, voogd, ouder, surveillant, familielid, student, leraar		J	Rol in organisatie
UserName		UserName	J
UserIds			N	Niet gebruikt
GivenName		FirstName	J
FamilyName		LastName	J
MiddleName		MiddleName	N
Id		OrgDefinedId	N	Indien verstrekt
E-mail		ExternalEmail	N
Sms		MobilePhone	N
Telefoon		HomePhone	N
AgentSourcedIds			N	Gebruikt voor Brightspace® ouder & voogd. Dit veld bevestigt de relatie tussen ouder en kind. Zowel de onderliggende als de bovenliggende rijen moeten verwijzen naar elkaars bron-id's.
Scores			N	Niet gebruikt
Wachtwoord		Wachtwoord	N

Inschrijvingen

OneRoster	Ondersteunde waarden	Brightspace®-toewijzingen	Verplicht	Opmerkingen
SourcedId			J
Status	actief, tobedeleted		N	Veld is vereist voor bestanden in delta-modus.
DateLastModified			N	Veld is vereist voor bestanden in delta-modus. Datumnotatie JJJJ-MM-DDTHH:mm:SS.sssZ
UserSourcedId			J	Gebruiker om in te schrijven
ClassSourcedId	DD-MM-JJJJ		J	Brightspace®-inschrijving
SchoolSourcedId			N	Niet gebruikt
Rol	beheerder, assistent, voogd, ouder, surveillant, familielid, student, leraar	Rol	J
Primair			N	Niet gebruikt
BeginDate			N	DD-MM-JJJJ
EndDate			N	DD-MM-JJJJ

REST-toewijzingswaarden