Documentação do administrador

Usar o Pacote de integração para sistemas de informação ao aluno OneRoster com o Brightspace para pais e responsáveis

O IPSIS OneRoster pode enviar os relacionamentos de usuários entre um pai/tutor legal e o filho ao Brightspace. A integração do Brightspace Parent & Guardian com o IPSIS OneRoster está disponível apenas para clientes nos EUA, Canadá, Austrália e Irlanda.

Atualmente, apenas as seguintes funções são consideradas relevantes para o relacionamento:

Pai
Responsável
Aluno

Todas as outras funções serão ignoradas.

Etapas para configurar o OneRoster

Na página Administração do IPSIS, abra a guia Configuração.
Se você tiver um sistema de origem OneRoster 1.1 – CSV, serão exibidas as credenciais do SFTP. Copie o host, o nome de usuário e a senha (o SIS precisa dessas informações para enviar arquivos CSV ao Brightspace).
Se você tiver um sistema de origem OneRoster 1.1 – REST, será preciso selecionar o método OAuth.
1. OAuth1.0a é selecionado por padrão. Insira o URL da extremidade válido, a chave e a senha do cliente e selecione o Método de assinatura OAuth.
2. Se OAuth2 for selecionado, insira o Id e a senha do cliente válidos.
Mapeie a função Pai ou Responsável do SIS para sua função do Brightspace para pais/responsáveis.
Mapeie a função Learner do SIS para sua função do Brightspace para alunos.
Mapeie a Escola Organizacional SIS em um tipo de unidade organizacional Brightspace.
Revise as outras configurações e clique em Salvar.

Observação: com base no formato de troca de dados, carregue um arquivo .CSV para criar relacionamentos pai-filho, ou faça uma solicitação REST para criar relacionamentos pai/responsável-filho. Veja abaixo um exemplo de arquivo CSV e solicitação REST.

Exemplo de arquivo 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}

Solicitação REST

Para criar relacionamentos pai/responsável-filho, a solicitação de criação de usuário REST deve incluir informações dos pais/responsáveis no campo do agente.

Para obter informações mais detalhadas sobre solicitações REST, visite Valores de mapeamento REST abaixo.

Exemplo de REST JSON com relacionamentos definidos

Para alunos:

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

Para um pai/responsável:

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

Valores de mapeamento CSV

Para criar relacionamentos pai/responsável-filho, os AgentSourceIds no arquivo users.CSV precisam ser atualizados para pais/responsáveis e alunos.

Sessões acadêmicas

OneRoster	Valores suportados	Mapeamentos do Brightspace	Obrigatório	Observações
SourcedId			Y
Status	ativo, a ser excluído		N	O campo é obrigatório para arquivos no modo delta.
Data da Última Alteração			N	O campo é obrigatório para arquivos no modo delta. Formato de data YYYY-MM-DDTHH:mm:SS.sssZ
Título		Nome da unidade organizacional e Código da unidade organizacional	Y
Tipo			Y	Tipo de unidade organizacional
StartDate			Y	AAAA-MM-DD
EndDate			Y	AAAA-MM-DD
ParentSourcedId			N	Não usado
SchoolYear			N	Não usado

Organizações

OneRoster	Valores suportados	Mapeamentos do Brightspace	Obrigatório	Observações
SourcedId			Y
Status	ativo, a ser excluído		N	O campo é obrigatório para arquivos no modo delta.
Data da Última Alteração			N	O campo é obrigatório para arquivos no modo delta. Formato de data YYYY-MM-DDTHH:mm:SS.sssZ
Nome		Nome da unidade organizacional e Código da unidade organizacional	Y	Se o campo identificador estiver vazio, o Nome será copiado no Código da unidade organizacional no Brightspace
Tipo	nacional, estadual, local, distrito, escola, departamento		Y	Define a OrgUnitType no Brightspace. http://www.imsglobal.org/oneroster-v11-final-specification#_Toc480452024
Identificador		Código da unidade organizacional (se fornecido)	N
ParentSourcedId			N	Este campo especifica a unidade organizacional principal.

Cursos

OneRoster	Valores suportados	Mapeamentos do Brightspace	Obrigatório	Observações
SourcedId			Y
Status	ativo, a ser excluído		N	O campo é obrigatório para arquivos no modo delta.
Data da Última Alteração			N	O campo é obrigatório para arquivos no modo delta. Formato de data YYYY-MM-DDTHH:mm:SS.sssZ
SchoolYearSourcedId			N	Não Usado
Título		Nome da unidade organizacional e Código da unidade organizacional	Y	Cria um modelo de curso do Brightspace. Se o campo CourseCode estiver vazio, o Título será copiado para o OrgUnitCode.
CourseCode		Código da unidade organizacional	N	Se fornecido
Notas			N	Não Usado
OrgSourcedId			Y	Este campo especifica a unidade organizacional principal.
Assuntos			N	Não Usado
SubjectCodes			N	Não Usado

Aulas

OneRoster	Valores suportados	Mapeamentos do Brightspace	Obrigatório	Observações
SourcedId			Y
Status	ativo, a ser excluído		N	O campo é obrigatório para arquivos no modo delta.
Data da Última Alteração			N	O campo é obrigatório para arquivos no modo delta. Formato de data YYYY-MM-DDTHH:mm:SS.sssZ
Título		Nome da unidade organizacional e Código da unidade organizacional	Y	Cria uma Seção e uma oferta de curso no Brightspace. Se o campo ClassCode estiver vazio, o Título será copiado para o código da unidade organizacional.
Notas			N	Não Usado
CourseSourcedId			Y	Este campo especifica a unidade organizacional principal
ClassCode		Código da unidade organizacional (se fornecido)	N	Se fornecido
ClassType			Y	Não Usado
Local			N	Não Usado
SchoolSourcedId			Y	Não Usado
TermsSourcedIds			N	Não Usado
Assuntos			N	Não Usado
SubjectCodes			N	Não Usado
Periods			N	Não Usado

Usuários

OneRoster	Valores suportados	Mapeamentos do Brightspace	Obrigatório	Observações
SourcedId		OrgDefinedId	Y	Se o campo Identificador não estiver preenchido, o SourcedId será copiado para o OrgDefinedId.
Status	ativo, a ser excluído		N	O campo é obrigatório para arquivos no modo delta.
Data da Última Alteração			N	O campo é obrigatório para arquivos no modo delta. Formato de data YYYY-MM-DDTHH:mm:SS.sssZ
EnabledUser			Y	Não Usado
OrgSourcedIds		Inscrições da unidade organizacional superior (com função na organização)	Y	A inscrição nas unidades organizacionais de escola
Função	administrador, assistente, guardião, pai ou mãe, fiscal de prova, parente, aluno, professor		Y	Função na organização
UserName		UserName	Y
UserIds			N	Não Usado
GivenName		FirstName	Y
FamilyName		LastName	Y
MiddleName		MiddleName	N
Identificador		OrgDefinedId	N	Se fornecido
E-mail		ExternalEmail	N
Sms		MobilePhone	N
Telefone		HomePhone	N
AgentSourcedIds			N	Usado para Brightspace Parent & Guardian. Este campo determina a relação pai (mãe)-filho(a). As linhas pai (mãe) e filho(a) devem fazer referência aos sourcedIds uns dos outros.
Notas			N	Não Usado
Senha		Senha	N

Inscrições

OneRoster	Valores suportados	Mapeamentos do Brightspace	Obrigatório	Observações
SourcedId			Y
Status	ativo, a ser excluído		N	O campo é obrigatório para arquivos no modo delta.
Data da Última Alteração			N	O campo é obrigatório para arquivos no modo delta. Formato de data YYYY-MM-DDTHH:mm:SS.sssZ
UserSourcedId			Y	Usuário a ser inscrito
ClassSourcedId	AAAA-MM-DD		Y	Inscrição no Brightspace
SchoolSourcedId			N	Não Usado
Função	administrador, assistente, guardião, pai ou mãe, fiscal de prova, parente, aluno, professor	Função	Y
Chave primária			N	Não Usado
BeginDate			N	AAAA-MM-DD
EndDate			N	AAAA-MM-DD

Valores de mapeamento REST