Documentation administrateur

Utilisation d’IPSIS OneRoster avec Brightspace pour les parents et les tuteurs

IPSIS OneRoster permet d’envoyer des relations utilisateur définies entre le parent/tuteur légal et l’enfant dans Brightspace. L’intégration IPSIS OneRoster pour Brightspace pour les parents et les tuteurs est uniquement disponible pour les clients des États-Unis, du Canada, de l’Australie et de l’Irlande.

Seuls les rôles suivants sont actuellement pertinents pour les relations :

Parent
Tuteur légal
Élève

Tous les autres rôles seront ignorés.

Étapes de configuration de OneRoster

Dans la page Administration d’IPSIS, sélectionnez l’onglet Configuration.
Si vous utilisez un système source OneRoster 1.1 – CSV, les identifiants SFTP sont affichés. Copiez l’hôte, le nom d’utilisateur et le mot de passe (ces données sont requises par votre SIS pour envoyer des fichiers CSV vers Brightspace).
Si vous utilisez un système source OneRoster 1.1 – REST, vous devez sélectionner la méthode OAuth.
1. OAuth 1.0 est sélectionné par défaut. Entrez l’URL de point d’extrémité valide, la clé du client, le secret du client, et sélectionnez le mode de signature OAuth.
2. Si OAuth2 est sélectionné, entrez l’ID de client valide et la clé secrète du client.
Faites correspondre le rôle de parent ou tuteur du SIS à votre rôle de parent dans Brightspace.
Faites correspondre le rôle d’élève du SIS à votre rôle d’élève dans Brightspace.
Mettez en correspondance l’établissement pour le système informatique de renseignements sur les élèves à un type d’unité organisationnelle de Brightspace.
Examinez les autres réglages, puis cliquez sur Enregistrer.

Remarque : Selon le format d’échange de données choisi, téléversez un fichier CSV pour créer des relations parent-enfant, ou effectuez une requête REST pour créer des relations parent/tuteur-enfant. Reportez-vous ci-dessous pour voir un exemple de fichier CSV et de requête REST.

Exemple de fichier CSV

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}

Requête REST

La requête de création d’utilisateur REST doit inclure l’information sur le parent dans le champ d’agent pour permettre la création de relations parent-enfant.

Pour en savoir plus sur les requêtes REST, reportez-vous à la rubrique Valeurs de mise en correspondance REST ci-dessous.

Exemple de fichier REST JSON présentant des relations définies

Pour un apprenant :

{
	"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"
		}]
	}]
}

Pour un parent ou un tuteur :

{
	"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"
		}]
	}]
}

Valeurs de correspondance CSV

Afin de créer des relations parent-enfant, les valeurs AgentSourceIds du fichier users.CSV doivent être actualisées pour les parents et les élèves.

Séances académiques

OneRoster	Valeurs prises en charge	Correspondances dans Brightspace	Requise	Remarques
SourcedId			O
État	actif, tobedeleted		N	Champ requis pour les fichiers en mode delta.
Date de modification la plus récente			N	Champ requis pour les fichiers en mode delta. Format de date AAAA-MM-DDTHH:MM:SS.sssZ
Titre		Nom et code de l'UO	O
Type			O	Type d’unité organisationnelle
StartDate			O	AAAA-MM-JJ
EndDate			O	AAAA-MM-JJ
ParentSourcedId			N	Inutilisée
Année scolaire			N	Inutilisée

Organisations

OneRoster	Valeurs prises en charge	Correspondances dans Brightspace	Requise	Remarques
SourcedId			O
État	actif, tobedeleted		N	Champ requis pour les fichiers en mode delta.
Date de modification la plus récente			N	Champ requis pour les fichiers en mode delta. Format de date AAAA-MM-DDTHH:MM:SS.sssZ
Nom		Nom et code de l'UO	O	Si le champ d’identifiant est vide, le nom est copié dans le code d’unité organisationnelle dans Brightspace
Type	national, state, local, district, school, department		O	Définit le type d’UO dans Brightspace. http://www.imsglobal.org/oneroster-v11-final-specification#_Toc480452024
Identifiant		Code de l’UO (si fourni)	N
ParentSourcedId			N	Ce champ indique l’unité organisationnelle primaire.

Cours

OneRoster	Valeurs prises en charge	Correspondances dans Brightspace	Requise	Remarques
SourcedId			O
État	actif, tobedeleted		N	Champ requis pour les fichiers en mode delta.
Date de modification la plus récente			N	Champ requis pour les fichiers en mode delta. Format de date AAAA-MM-DDTHH:MM:SS.sssZ
SchoolYearSourcedId			N	Non utilisé
Titre		Nom et code de l'UO	O	Crée un modèle de cours Brightspace. Si le champ CourseCode est vide, le titre est copié dans le code d’unité organisationnelle.
CourseCode		Code de l’unité org.	N	Si fourni
Notes d'appréciation			N	Non utilisé
OrgSourcedId			O	Ce champ indique l’unité organisationnelle primaire.
Objets			N	Non utilisé
SubjectCodes			N	Non utilisé

Classes

OneRoster	Valeurs prises en charge	Correspondances dans Brightspace	Requise	Remarques
SourcedId			O
État	actif, tobedeleted		N	Champ requis pour les fichiers en mode delta.
Date de modification la plus récente			N	Champ requis pour les fichiers en mode delta. Format de date AAAA-MM-DDTHH:MM:SS.sssZ
Titre		Nom et code de l'UO	O	Crée une section et une offre de cours Brightspace. Si le champ ClassCode est vide, le titre est copié dans le code d’unité organisationnelle.
Notes d'appréciation			N	Non utilisé
CourseSourcedId			O	Ce champ indique l’unité organisationnelle primaire.
ClassCode		Code de l’UO (si fourni)	N	Si fourni
ClassType			O	Non utilisé
Emplacement			N	Non utilisé
SchoolSourcedId			O	Non utilisé
TermsSourcedIds			N	Non utilisé
Objets			N	Non utilisé
SubjectCodes			N	Non utilisé
Periods			N	Non utilisé

Utilisateurs

OneRoster	Valeurs prises en charge	Correspondances dans Brightspace	Requise	Remarques
SourcedId		OrgDefinedId	O	Si le champ d’identifiant est vide, la valeur du champ SourcedId est copiée dans le champ OrgDefinedId.
État	actif, tobedeleted		N	Champ requis pour les fichiers en mode delta.
Date de modification la plus récente			N	Champ requis pour les fichiers en mode delta. Format de date AAAA-MM-DDTHH:MM:SS.sssZ
EnabledUser			O	Non utilisé
OrgSourcedIds		Inscriptions à une UO supérieure (avec son rôle dans l’UO).	O	Inscription dans les unités organisationnelles de l’établissement
Rôle	administrator, aide, guardian, parent, proctor, relative, student, teacher (administrateur, aide, tuteur, parent, surveillant, parenté, apprenant, enseignant)		O	Rôle dans l’UO
Nom d’utilisateur		Nom d’utilisateur	O
UserIds			N	Non utilisé
GivenName		FirstName	O
FamilyName		LastName	O
MiddleName		MiddleName	N
Identifiant		OrgDefinedId	N	Si fourni
Courriel		ExternalEmail	N
SMS		MobilePhone	N
Phone		HomePhone	N
AgentSourcedIds			N	Utilisé pour Brightspace pour les parents et les tuteurs. Ce champ affirme la relation parent-enfant. Les rangées parent et enfant doivent faire mutuellement référence aux valeurs sourcedId de l’autre.
Notes d'appréciation			N	Non utilisé
Mot de passe		Mot de passe	N

Inscriptions

OneRoster	Valeurs prises en charge	Correspondances dans Brightspace	Requise	Remarques
SourcedId			O
État	actif, tobedeleted		N	Champ requis pour les fichiers en mode delta.
Date de modification la plus récente			N	Champ requis pour les fichiers en mode delta. Format de date AAAA-MM-DDTHH:MM:SS.sssZ
UserSourcedId			O	Utilisateur à inscrire
ClassSourcedId	AAAA-MM-JJ		O	Inscription Brightspace
SchoolSourcedId			N	Non utilisé
Rôle	administrator, aide, guardian, parent, proctor, relative, student, teacher (administrateur, aide, tuteur, parent, surveillant, parenté, apprenant, enseignant)	Rôle	O
Primaire			N	Non utilisé
BeginDate			N	AAAA-MM-JJ
EndDate			N	AAAA-MM-JJ

Valeurs de correspondance REST