Plataforma do Pacote de integração para o Sistema de informações do aluno (IPSIS)
A plataforma do IPSIS (Integration Pack for Student Information Systems, pacote de integração para sistemas de informações do aluno) é uma plataforma de integração do Brightspace que consiste em componentes comuns e uma coleção de produtos que permitem importar informações (como a estrutura da organização, os usuários e as informações de inscrição) do sistema de informações da organização para o Brightspace. Depois que essas informações são importadas para o Brightspace, é possível continuar a atualizar o sistema de informações e importar as informações para o Brightspace usando a plataforma IPSIS.
Sistemas de informações compatíveis
A Plataforma IPSIS integra-se aos seguintes tipos comuns de sistemas de informações:
- SIS (Student Information Systems, sistema de informações do aluno) – ferramenta de software usada por organizações educacionais para gerenciar alunos, cursos e inscrições.
- HRIS (Human Resource Systems, sistema de informações de recursos humanos) – ferramenta de software usada por organizações corporativas para gerenciar funcionários e seus dados.
- LIS (Learner Information Systems, sistema de informações do aluno): ferramenta de software usada por organizações educacionais para gerenciar o registro de matrículas de alunos.
Componentes e produtos na Plataforma IPSIS
Na Plataforma IPSIS, existem componentes comuns e vários produtos com recursos exclusivos para integrar seu sistema de informações específico ao Brightspace. A coleção de componentes e produtos é composta por:
- CSV padrão da D2L – usado para integração com sistemas SIS/HRIS por meio de arquivos CSV (Comma-Separated Value, valor separado por vírgula) definidos pela D2L.
- Ellucian ILP – usado para integração com sistemas Banner ou Colleague, de acordo com especificações do LIS.
- OneRoster CSV ou REST – usado para integração com sistemas de informações K-12 compatíveis com a especificação OneRoster IMS Global Learning Consortium.
- Adaptador LIS v2.0 – usado para integração com sistemas compatíveis com a especificação do LIS IMS Global Learning Consortium.
- Mesclagem de Curso SIS - uma interface no Brightspace usada para permitir que os instrutores mesclem e desmesclem vários cursos processados pelo IPSIS dentro e fora de uma oferta de curso principal.
- IU (Section Association Interface, interface de associação de seção) – usada para realizar a manipulação manual de relações entre cursos ou seções para inscrição no SIS e nas ofertas de curso no Brightspace.
- Interface de administração do IPSIS (IU do administrador): usada para configurar e avaliar o status das integrações do SIS com o Brightspace.
Sobre o OneRoster 1.1 REST
OneRoster é um padrão de IMS projetado para permitir o compartilhamento seguro de listas de aulas e dados relacionados entre um sistema de informações do aluno (SIS) e qualquer outro sistema. O padrão OneRoster dá suporte à exportação/importação de planilhas (CSV), bem como a trocas diretas entre sistemas usando APIs REST. Este guia administrativo se concentra na especificação REST.
Antes de usar o OneRoster REST 1.1
A D2L oferece suporte à especificação IMS OneRoster v1.1 e recertifica-se anualmente com o conjunto de certificação de produtos IMS Global. A D2L dá suporte às seguintes certificações de conformidade:
- Núcleo de envio de notas do provedor de dados REST
- Núcleo da lista de consumidores de dados REST
A implementação do Brightspace da especificação OneRoster v1.1 permite que os administradores agendem dados a serem extraídos de seu SIS para preencher os dados necessários relacionados à lista (escolas, aulas, usuários, inscrições etc.) na plataforma Brightspace. A nova interface de usuário IPSIS OneRoster REST inclui uma programação para permitir que os administradores configurem a hora do dia em que ocorre a obtenção dos dados. Além disso, para um parceiro SIS que oferece suporte ao serviço de Notas, os administradores podem definir as notas a serem retornadas com a sincronização de dados diária e/ou permitir que um membro do corpo docente inicie uma sincronização manual.
Endpoints usados
| Tipo |
URL |
|---|
| GET |
ims/oneroster/v1p1/academicSessions |
| GET |
ims/oneroster/v1p1/classes |
| GET |
ims/oneroster/v1p1/enrollments |
| GET |
ims/oneroster/v1p1/orgs |
| GET |
ims/oneroster/v1p1/orgs/{id} |
| GET |
ims/oneroster/v1p1/schools/{id} |
| GET |
ims/oneroster/v1p1/schools/{id}/classes |
| GET |
ims/oneroster/v1p1/schools/{id}/courses |
| GET |
ims/oneroster/v1p1/schools/{id}/enrollments |
| GET |
ims/oneroster/v1p1/users |
| GET |
ims/oneroster/v1p1/categories (+metadados solicitados) |
| PUT |
ims/oneroster/v1p1/categories (IC) |
| PUT |
ims/oneroster/v1p1/lineitems |
| PUT |
ims/oneroster/v1p1/results |
Como o OneRoster REST está associado ao Brightspace
Valores de associação geral
Abaixo estão os valores de associação entre um tipo de objeto OneRoster e um tipo de objeto Brightspace
| OneRoster |
D2L Brightspace |
|---|
| Sessões acadêmicas |
Unidades Organizacionais* |
| Organizações |
Unidades Organizacionais* |
| Escolas |
Unidades Organizacionais* |
| Cursos |
Modelo de curso |
| Aulas |
Oferta de curso e Seção de curso |
| Usuários |
Usuário |
| Inscrições |
Inscrição |
| LineItems |
Nota |
| Resultados |
Valor da Nota |
*Os tipos de unidade organizacional geralmente são tipos personalizados que podem ser associados durante o processo de configuração.
Sessões acadêmicas
| OneRoster |
Valores aceitos |
Usado pelo Brightspace para |
Obrigatório |
|---|
| sourcedId |
|
N/A |
Y |
| status |
ativo ou a ser excluído |
Criar/Substituir ou excluir |
Y |
| dateLastModified |
AAAA-MM-DDTHH:mm:SS.sssZ |
N/A |
Y |
| metadados |
N/A |
N/A |
|
| título |
|
Nome da unidade organizacional e Código da unidade organizacional |
Y |
| StartDate |
AAAA-MM-DD |
Exposto para sessão acadêmica no livro de notas |
Y |
| endDate |
AAAA-MM-DD |
Exposto para sessão acadêmica no livro de notas |
Y |
| tipo |
|
Tipo de unidade organizacional |
Y |
| principal |
N/A |
N/A |
N/A |
| Secundários |
N/A |
N/A |
N/A |
| SchoolYear |
N/A |
N/A |
N/A |
Organizações
| OneRoster |
Valores aceitos |
Usado pelo Brightspace para |
Obrigatório |
|---|
| SourcedId |
|
N/A |
Y |
| Status |
ativo ou a ser excluído |
Substituir ou excluir |
Y |
| Data da Última Alteração |
AAAA-MM-DDTHH:mm:SS.sssZ |
N/A |
Y |
| Metadados |
N/A |
N/A |
|
| Nome |
|
Nome da unidade organizacional e Código da unidade organizacional |
Y |
| Identificador |
|
Código da unidade organizacional (se informado) |
N |
| StartDate |
AAAA-MM-DD |
N/A |
Y |
| EndDate |
AAAA-MM-DD |
N/A |
Y |
| Tipo |
|
Tipo de unidade organizacional |
Y |
| Pai |
|
Unidade organizacional principal |
Necessário para criar a estrutura organizacional |
| Secundários |
N/A |
N/A |
N/A |
Cursos
| OneRoster |
Valores aceitos |
Usado pelo Brightspace para |
Obrigatório |
|---|
| SourcedId |
|
N/A |
Y |
| Status |
ativo ou a ser excluído |
Ativo |
Y |
| Data da Última Alteração |
AAAA-MM-DDTHH:mm:SS.sssZ |
N/A |
Y |
| Metadados |
N/A |
N/A |
|
| Título |
|
Nome da unidade organizacional e Código da unidade organizacional |
Y |
| SchoolYear |
|
Unidade organizacional principal |
N |
| CourseCode |
|
Código da unidade organizacional (se informado) |
N |
| Notas |
N/A |
N/A |
|
| Assuntos |
N/A |
N/A |
|
| Org |
|
Unidade organizacional principal |
N |
| StartDate |
AAAA-MM-DD |
N/A |
|
| EndDate |
AAAA-MM-DD |
N/A |
|
| SubjectCodes |
N/A |
N/A |
|
| Recursos |
N/A |
N/A |
|
Aulas
| OneRoster |
Valores aceitos |
Usado pelo Brightspace para |
Obrigatório |
|---|
| SourcedId |
|
N/A |
Y |
| Status |
ativo ou a ser excluído |
Ativo ou inativo |
Y |
| Data da Última Alteração |
AAAA-MM-DDTHH:mm:SS.sssZ |
N/A |
Y |
| Metadados |
Não associado |
| Título |
|
Nome da unidade organizacional e Código da unidade organizacional |
Y |
| ClassCode |
|
Código da unidade organizacional (se informado) |
N |
| ClassType |
N/A |
| Local |
N/A |
| Notas |
N/A |
| Assuntos |
N/A |
| Curso |
|
Unidade organizacional principal |
Y |
| Escola |
|
Unidade organizacional principal |
Y |
| Termos |
|
Unidade organizacional principal |
Y |
| SubjectCodes |
N/A |
| Periods |
N/A |
| Recursos |
N/A |
Usuários
| OneRoster |
Valores aceitos |
Usado pelo Brightspace para |
Obrigatório |
|---|
| SourcedId |
|
OrgDefinedId |
Y |
| Status |
ativo ou a ser excluído |
IsActive |
Y |
| Data da Última Alteração |
AAAA-MM-DDTHH:mm:SS.sssZ |
N/A |
Y |
| Metadados |
Não associado |
| UserName |
|
UserName |
Y |
| UserIds |
Não associado |
| EnabledUser |
|
IsActive |
Y |
| GivenName |
|
FirstName |
Y |
| FamilyName |
|
LastName |
Y |
| MiddleName |
|
MiddleName |
N |
| Função |
|
Role in Org (Função na organização) |
Y |
| Identificador |
|
OrgDefinedId (se informado) |
N |
| E-mail |
|
ExternalEmail |
N |
| Sms |
|
N/A |
N |
| Telefone |
|
N/A |
N |
| Agentes |
|
Brightspace para Pais e Responsáveis |
N |
| Organizações |
Inscrições da unidade organizacional superior (com função na organização) |
| Notas |
N/A |
| Senha |
|
Senha do usuário |
N |
Inscrições
| OneRoster |
Valores aceitos |
Usado pelo Brightspace para |
Obrigatório |
|---|
| SourcedId |
|
N/A |
Y |
| Status |
ativo ou a ser excluído |
Ativo |
Y |
| Data da Última Alteração |
AAAA-MM-DDTHH:mm:SS.sssZ |
|
Y |
| Metadados |
N/A |
| Usuário |
|
Usuário a ser inscrito |
Y |
| Classe |
|
Oferta de curso e seção em que será inscrito |
Y |
| Escola |
N/A |
| Função |
|
Função |
Y |
| Chave primária |
N/A |
| BeginDate |
N/A |
| EndDate |
N/A |
Pressuposições e limitações
Premissas
A D2L pode trabalhar com qualquer SIS que ofereça suporte ao OneRoster 1.1 REST e seja certificado com o IMS Global ou que esteja em vias de obter sua certificação.
Processo REST
- Execuções agendadas executadas a partir da data de execução anterior da extração de dados até a data de início da extração de dados atual. Se esta for a primeira execução, ela funcionará como uma operação de sincronização e será executada sem data de início até o intervalo de datas.
- Há uma opção para acionar uma execução manualmente a partir da data de execução anterior, a partir de uma data específica ou para todos os registros do sistema
- Ordem de chamada: ordem em que os vários endpoints ou o consumo de vários arquivos são chamados.
Escolas
Sessões acadêmicas
Organizações
Cursos
Aulas
Usuários
Inscrições
- A ordem em que os dados são enviados de volta ao Infinite Campus
- Itens de linha (enviados sob demanda ou à noite com base nas permissões de exportação de nota)
- Resultados (enviados sob demanda ou à noite com base nas permissões de exportação de nota)
Exportação de notas
Para que uma nota seja exportada, o curso deve ter sido criado por meio do OneRoster e a Exportação de notas do sistema de origem do IPSIS do OneRoster deve estar ativada. O curso só pode ser mapeado para um sistema de origem ativo com notas. As notas devem pertencer a Categorias de nota que têm a opção "Exportar para SIS" marcada e a devem ter uma Sessão acadêmica selecionada.
Sessões acadêmicas
O menu suspenso Sessão acadêmica fica visível ao criar uma nova nota. O menu é preenchido localizando todas as unidades organizacionais criadas pelo mesmo SIS do curso em que o mapeamento do SIS está na sessão acadêmica. A sessão acadêmica deve ser pai da oferta de curso.
Categorias
O Infinite Campus não oferece suporte a Categorias. Porém, a Categoria é necessária no Brightspace. Essa categoria é usada para vincular notas para que o Brightspace saiba quais notas devem ou não ser enviadas.
Como funciona a sincronização de notas
As notas (itens de linha) são sincronizadas se atenderem a qualquer uma das seguintes condições:
- O item de linha nunca foi enviado
- O item de linha foi atualizado desde o último envio (isso inclui nome, sessão acadêmica, pontos, exclusão, restauração de exclusão)
- Houve falha ao enviar o item de linha durante a última exportação
- Os itens de linha usam as datas finais da sessão acadêmica associada à nota. A data final é enviada para a atribuição e o prazo
Observação: o ID originado do item de linha enviado é específico da classe e é gerado da seguinte maneira: {lineItemSourcedId}_{classSourcedId}
As notas (resultados) são sincronizadas se atenderem a qualquer uma das seguintes condições:
Observação: o ID originado do item de linha enviado é específico da classe e é gerado da seguinte maneira: {lineItemSourcedId}_{classSourcedId}
As notas (resultados) são sincronizadas se atenderem a qualquer uma das seguintes condições:
- O resultado nunca foi enviado
- O resultado foi atualizado desde o último envio
- Houve falha ao enviar o resultado durante a última exportação
- O item de linha principal foi modificado desde a última exportação
Observação: os itens de linha e os resultados que foram enviados ao SIS como excluídos não aparecem na IU do Histórico de exportação.
Limitações
- Os registros com o status tobedeleted serão excluídos somente se o secundário for excluído.
- Não é possível cancelar a inscrição em unidades organizacionais superiores que foram criadas antes da versão de junho de 2024/20.24.6 por meio da integração do OneRoster.
- As inscrições que foram criadas manualmente no Brightspace não podem ter sua inscrição cancelada por meio da integração do OneRoster.
- Caracteres não suportados: há vários caracteres não suportados no código de unidade organizacional do Brightspace. Esses caracteres são substituídos por um sublinhado (_). Caracteres não suportados: \ : * ? “ ” < > | ‘ # , % &
- Truncamentos: o tamanho máximo do código da unidade organizacional no Brightspace é de 50 caracteres. Se exceder esse comprimento, ele será truncado na interface do usuário.
- O OneRoster permite vários ScoreStatus: o Brightspace envia apenas notas ou isenções completas
Opções de configuração do OneRoster REST
Você trabalhará com seu consultor de implementação da Brightspace para configurar o sistema de origem OneRoster REST. O Brightspace padroniza automaticamente as configurações mais comuns. No entanto, você pode editar essas configurações a qualquer momento, desde que tenha as permissões adequadas.
Antes que o sistema de origem possa ser configurado, verifique se os seguintes itens estão concluídos:
Requisitos gerais
Entre em contato com seu representante do Infinite Campus para obter as informações da API. Você precisará de:
- URL do endpoint
- Chave de cliente
- Chave secreta do cliente
Configuração
Após a configuração inicial, é possível atualizar a configuração do sistema de origem OneRoster REST:
- No menu Ferramentas administrativas, selecione Administração do IPSIS e, em seguida, selecione a guia Configuração.
- As credenciais fornecidas durante a configuração inicial serão exibidas primeiro. Essas credenciais podem ser editadas, se necessário. (O Infinite Campus é compatível com OAuth1.0a e OAuth Signature HMAC-SHA256).
- Sistema de origem
- Nome do SIS: o campo Nome do SIS é editável e é recomendado mantê-lo atualizado.
- Atualizações programadas: a hora em que o Brightspace sincronizará automaticamente com o SIS. É recomendável concluir esse processo durante a noite.
- Substituição no Brightspace: escolhas granulares para identificar quais campos o SIS pode substituir no Brightspace.
- Pessoas
- Associação a funções do SIS: esta seção contém a função específica do OneRoster que associa nomes de função do SIS a nomes de função do Brightspace. As funções Professor e Aluno são incluídas por padrão, mas podem ser excluídas. Os seguintes tipos de função estão disponíveis no OneRoster:
- Administrador
- Assistente
- Responsável
- Pai
- Fiscal de prova
- Relativo
- Aluno
- Professor
Para adicionar outros nomes de função do SIS a fim de associá-los a funções do Brightspace, clique em + Adicionar função.Observação: se o SIS enviar uma função que não está configurada, isso resultará em um erro e impedirá a criação do usuário.
- Associar Entradas do SIS a Usuários existentes: permite associar entradas do SIS baseadas em nome de usuário ou ID definido da organização a usuários que foram criados fora do SIS (manualmente, por meio de operações em lote, usando APIs etc.). Quando as associações estão desativadas, podem acabar sendo criadas entradas duplicadas.
- Cursos e seções
- Cursos e seções: Associações: esta seção contém os tipos de unidade organizacional específicos do OneRoster para associar as organizações do SIS aos nomes da organização do Brightspace.
- Clique em + Adicionar tipo de unidade organizacional para adicionar outros nomes de unidade organizacional específicos do SIS. Os seguintes tipos de unidade organizacional são necessários para o Infinite Campus:
- Organizações do SIS
- Tipo de sessão acadêmica
- Semestre
- Termo
- SchoolYear
- Período de avaliação
- Grupo SIS
- Oferta de curso
- Seção do Curso
- Modelo de curso
- Associação de Seção
- Exclusão: esta seção fornece três opções para determinar como o status tobedeleted afetará uma unidade organizacional no Brightspace.
- Nenhuma ação: a associação de unidade organizacional é excluída das associações do IPSIS, mas a unidade organizacional permanece inalterada no Brightspace
- Desativar a oferta de curso: a associação da unidade organizacional é excluída das associações do IPSIS e a oferta de curso é marcada como inativa no Brightspace
- Conteúdo do curso : permite copiar o conteúdo de um curso mestre ou de um modelo de curso para o curso recém-criado. Clique em Sim e escolha uma destas opções:
- Modelo do curso principal do novo curso
- O conteúdo é copiado do Modelo de curso principal para a nova Oferta de curso secundária
- Curso terciário em que o Código da unidade organizacional corresponde ao modelo principal
- O conteúdo é copiado de uma oferta de curso principal na oferta de curso terciária quando a oferta de curso principal e o modelo do curso compartilharem o mesmo código de unidade organizacional
- Cancelar inscrição: fornece a opção de cancelar a inscrição de usuários de seções e cursos com base na Data final da inscrição fornecida pelo SIS e a opção de cancelar a inscrição de usuários de organizações SIS se eles não estiverem mais associados a elas no SIS.
- Exportação de notas
- Esta seção fornece a opção de permitir a sincronização de todas as notas modificadas no momento da atualização programada e/ou permitir a exportação de notas iniciada pelo professor a partir da oferta de curso.
- Ao terminar, clique em Salvar configuração.
Solução de problemas
O Painel oferece o status de processamento do lote mais recente. As páginas Painel e Lotes mostram um indicador final se o lote tiver sido concluído com sucesso ou com erros. Cada lote apresenta um link rápido ao Log de auditoria e, se foi concluído com erros, apresenta um link rápido às Mensagens de erro.
Analise todos os logs para verificar se todos os endpoints foram processados como esperado. Se mensagens de erro tiverem sido registradas, expanda o erro para analisar os metadados capturados a fim de identificar os erros. Depois, corrija os dados no SIS e aguarde até o dia seguinte pela atualização programada ou solicite uma atualização do Painel. O objetivo é que as execuções sejam concluídas sem erros.
Como sincronizar notas
É possível definir a sincronização de notas para todas as noites com atualização diária da lista, sob demanda por meio da interface de notas ou ambas. Essas opções são configuradas em Administração do IPSIS > Configuração > Exportar notas.
Para enviar notas, uma categoria, um item de nota e uma nota são obrigatórios. Consulte a seção Exportação de notas para ver as regras gerais de envio de notas.
Criar uma categoria
- Na página inicial do curso, acesse Notas.
- Na área Gerenciar notas, no botão Novo, clique em Categoria.
- Configure as preferências e opções desejadas para a categoria.
- Clique em Exportar para SIS para indicar que todos os itens de linha associados a essa categoria devem ser sincronizados com o SIS.
- Clique em Salvar e fechar.
Criar uma nota
- Na área Gerenciar notas, clique em Novo e selecione Item.
- Configure as preferências e opções desejadas para a categoria.
- Escolha uma sessão acadêmica no menu suspenso.
- Associe a nota à Categoria sincronizada com o SIS.
- Clique em Salvar e fechar.
Exportar para SIS
Para sincronizar notas manualmente com o SIS:
- Na página inicial do curso, navegue até Notas – Inserir notas – Exportar para SIS
- Na IU Exportar notas, você verá uma página de resumo que inclui:
- Seção: um menu suspenso que permite escolher entre diferentes seções do curso (se várias seções estiverem presentes)
- Sessão acadêmica: um menu suspenso que permite escolher entre diferentes anos letivos associados ao curso (se várias sessões acadêmicas forem usadas)
- Visão geral: lista o número de categorias e de notas dentro das categorias que atendem aos critérios selecionados na Seção e na Sessão acadêmica acima e que podem ser exportadas
- Exportação programada: visível somente se configurada na configuração de integração SIS e pode ser editada na guia Configuração em Administração do IPSIS
- Clique em exportar. A página é atualizada e direciona à página Exibir todas as exportações. Esta IU fornece uma visão geral de quem enviou as notas e quando.
- Depois que a exportação for concluída, clique em Nome da exportação para exibir detalhes que incluem: nome do curso, datas de início e término da exportação e usuário que iniciou a exportação
Observação: se as notas forem enviadas por meio da sincronização noturna, o usuário do Serviço do IPSIS será exibido
- Detalhes de exportação bem-sucedida e com falha para Categorias, Notas e Resultados:
- Para navegar de volta para o histórico de exportações, acesse Notas > Lançar notas > Exportar para SIS e clique em Exibir histórico de exportação no canto superior direito.
Usar as informações da sessão acadêmica para as datas de início e de término do curso
Na página de Administração do IPSIS, a caixa de seleção Usar datas de oferta de curso permite usar informações de sessão acadêmica para as datas de início e término da oferta de curso. Essa caixa de seleção está desativada por padrão. Essa opção permite escolher se as datas das sessões acadêmicas (semestre, período letivo, ano letivo ou período de avaliação) serão associadas à oferta de curso (o padrão é período letivo). A data inicial e a data final de um curso também podem ser deslocadas por um número determinado de dias. Se várias sessões acadêmicas forem definidas para uma única oferta de curso, a primeira Sessão acadêmica recebida do SIS será usada nas datas de início e de término.