Quando configurando o escalonamentoPara a integração com o OneRoster, você deve oferecer suporte a ambas as configurações de serviço de escalonamento e observar as diretrizes de melhores práticas.
Seguir as melhores práticas de integração garante a transferência correta dos dados de cadastro e elimina as tentativas e erros na correção das matrículas.
Observação:A Instructure é uma consumidora do OneRoster. Para obter as definições de consumidor e provedor do OneRoster, consulte oIntrodução ao OneRoster.
Períodos/Semestres Acadêmicos
Se o seu sistema de informação acadêmica (SIS) utiliza um ID de termo comum para agrupar termos, inclua esse ID na resposta da API. O ID de termo comum pode ser usado para identificar termos que precisem ser mesclados no Canvas.
Saiba mais sobre o OneRosterespecificações da sessão acadêmica.
Exemplo |
|---|
{
"title": "A 707 07/08",
"sourcedId": "{hash}-{schoolId}-{termIdentifer}",
...
}
|
Conjunto de dados disponível
Configure os endpoints de extração de dados do OneRoster para o ano letivo atual, incluindo todos os dados históricos e futuros dentro do ano letivo, conforme definido pelo seu sistema. Além disso, inclua todos os objetos de dados na extração com as datas de término necessárias para evitar a exclusão indesejada de dados nos sistemas de destino.
Saiba mais sobre o OneRosterpontos finais de escalonamento e conformidade do ponto final de escalonamento.
Registros de Matrícula Duplicados
Caso um usuário possua vários registros de matrícula para a mesma turma, forneça apenas o registro de matrícula atual.
Por exemplo, se o Aluno A da Turma 123 estiver matriculado, for removido e, em seguida, rematriculado, forneça o status de matrícula mais apropriado no momento em que a chamada da API for feita, em vez dos múltiplos registros de matrícula do Aluno A.
Datas de início e término das inscrições
Cada registro de matrícula deve incluir uma data de início (startDate) e uma data de término (endDate), mesmo que essas datas coincidam com as datas do período letivo. Ao comparar as datas de matrícula e do período letivo, o Canvas consegue manter os status de matrícula corretos.
obterTodosOsUsuários/usuários
Se a sua instituição suporta o uso da função de observador do Canvas (para pais, responsáveis, etc.), recomenda-se que você inclua esses perfis de usuário na configuração da sua implementação.
Sincronizações incrementais de dados
Em vez de usar extrações de dados completas, você pode configurar sincronizações de dados incrementais usando umdataÚltimaModificaçãofiltro de consulta.
Observação:Para implementar sincronizações de dados incrementais de forma confiável, você deve incluir o status de exclusão ou a data de término de cada registro de matrícula. Sem essas informações, as perdas de matrículas só podem ser calculadas comparando uma nova sincronização completa de dados com uma sincronização completa anterior.