Ao configurar a integração do Instructure OneRoster, revise as considerações sobre a integração de repasse de notas. A integração de repasse de notas (GPB) do Instructure OneRoster inclui variações das especificações do OneRoster, conforme exigido por diferentes fornecedores de SIS.
Categorias de classificação
Dependendo da configuração do seu livro de notas do SIS, você pode personalizar oobterCategoriasConsulte a documentação para sincronizar corretamente as tarefas do Canvas com o seu livro de notas do SIS.
Períodos de avaliação
Como a maioria dos fornecedores de SIS calcula automaticamente os períodos de avaliação com base na data de entrega da tarefa, você pode não precisar incluir esse endpoint na sua configuração de repasse de notas.
Carga útil do item de linha
Você pode configurar suas solicitações de itens de linha. Saiba mais sobre o OneRoster.estrutura de dados da categoria do item de linha.
Carga útil de resultados
Você pode configurar suas solicitações de itens de linha. Saiba mais sobre o OneRoster.resultados.
Observação:A Instructure é uma consumidora do OneRoster. Para obter as definições de consumidor e provedor do OneRoster, consulte oIntrodução ao OneRoster.
Categorias de classificação
Quando a integração do Instructure OneRoster executa uma sincronização de notas, oobterTodasAsCategoriasA solicitação retorna todas as categorias de notas do livro de notas do SIS.
Qualquer categoria de avaliação que não inclua o(a)metadata.classIdO campo é considerado uma categoria global que pode ser aplicada e utilizada em todas as classes.
Categorias globais
Se o seu sistema de registro de notas (SIS) suporta apenas categorias de notas globais, a integração deverá funcionar corretamente sem os campos de metadados.
Extensão do objeto de categoria: metadata.classId
Para permitir que a API OneRoster v1.1 associe categorias e outros objetos na especificação de repasse de notas de forma mais correta, é necessário um campo de categoria.
A extensão abaixo permite que a integração identifique corretamente as categorias de notas do SIS necessárias para o repasse de notas. Quaisquer categorias que não possuam essa identificação serão consideradas.metadata.classIdOs campos são considerados globais e o primeiro nome de categoria que corresponde a um nome de grupo de atribuição do Canvas é usado para GPB.
Se você optar por apoiarmetadata.classIdVocê também deve incluir uma consulta de filtro para o(a)obterCategoriasendpoint. Isso permite que a integração extraia categorias para uma única seção.
Extensão de objeto de categoria |
|---|
{
"categories": [
{
"status": "active",
"title": "Assessments",
"sourcedId": "guid",
"href": "URI to resource in SIS",
"metadata": {
"classId": "{class_id}"
},
"dateLastModified": null
}…
]
} |
Opção de endpoint: getCategoriesForClass
Antecipando a especificação da API OneRoster 1.2, você pode adicionar suporte para um novo recurso.obterCategoriasParaClasseendpoint. Isso permite que a integração identifique as categorias de notas disponíveis no SIS para uma seção durante a sincronização de repasse de notas.
Observação:Se você implementar essa abordagem, não precisará configurar o suporte para o(s)metadata.classId campo.
Nenhuma categoria correspondente
A sua integração com o Instructure OneRoster pode estar configurada para sincronizar tarefas do Canvas com as categorias de avaliação do SIS. Durante a sincronização de notas, se nenhuma categoria correspondente for encontrada, uma mensagem de erro será exibida indicando que nenhum dos nomes das categorias de avaliação do SIS corresponde aos nomes dos grupos de tarefas do Canvas.
Categoria padrão
Seu SIS pode incluir um padrãoID de origemCategoria de avaliação compatível com todos os livros de notas do SIS. Durante a sincronização de notas do Canvas, se uma tarefa não puder ser associada a uma categoria de avaliação do SIS, ela será sincronizada com a categoria de avaliação padrão.
Se uma categoria comumID de origemSe não estiver disponível, esse valor também pode ser enviado comonulo.
Categorias não enviadas
Se o sistema de informação acadêmica (SIS) da sua instituição suporta boletins de notas sem categorias de avaliação, a integração com o Instructure OneRoster pode ser configurada para enviar o JSON do item de linha da tarefa sem o campo de categoria ou com ele.“categoria”: nuloA integração pode optar por sempre enviar. nuloou apenas enviar nuloSe nenhuma categoria correspondente for encontrada.
Alternativamente, sua integração existente pode sincronizar automaticamente itens de linha de tarefas não categorizadas com a categoria de avaliação não categorizada do livro de notas do SIS. Se este for o caso da sua integração, os instrutores podem mover a tarefa para a categoria de avaliação apropriada do SIS. Para evitar que a tarefa seja sincronizada novamente com o campo não categorizado, sua integração deve ser configurada para reconhecer a categoria atribuída manualmente como um campo fixo.
Categoria predominante
O sistema de notas SIS da sua instituição pode estar configurado com uma categoria de avaliação padrão predefinida e sempre utilizada. Para acomodar essa configuração, a sua integração com o Instructure OneRoster pode incluir uma categoria predefinida no código.ID de origemTodos os diários de classe dos instrutores em seu SIS devem incluir esta categoria. Como alternativa, a integração pode ser configurada com uma configuração de sobreposição.nulovalor da categoria.
Períodos de avaliação
Durante a sincronização de notas do Canvas, a maioria dos sistemas de informação acadêmica (SIS) calcula e associa automaticamente o período de avaliação correto de uma tarefa usando o...data de vencimentoitem de linha. Esse cálculo automático significa que operíodo de avaliaçãoO item de linha pode ser omitido ou enviado comonulo.
Se a sua integração exigir, umperíodo de avaliaçãoO item de linha pode ser configurado. No entanto, se estiver configurado incorretamente, os erros de sincronização de notas ocorrerão com mais frequência.
Saiba mais sobreSessões acadêmicas do OneRoster.
Considerações sobre a carga útil do item de linha
Você pode configurar as solicitações de itens de linha para inclusão na sua carga útil de sincronização GPB.
O gráfico abaixo exibe as solicitações de itens de linha configuráveis. Como parte do processo de configuração individual do cliente, você pode personalizar a maioria dos valores padrão. Você também pode omitir qualquer um desses valores da carga útil. Alternativamente, se os dados correspondentes estiverem disponíveis na extração de dados do Canvas, você também pode configurar campos de metadados adicionais.
Saiba mais sobre o OneRosterestrutura de dados da categoria do item de linha.
Nome do campo do item de linha do OneRoster | Valor padrão |
|---|
ID de origem
| UUIDv4 |
título
| {assignment.name} |
status
| "ativo" |
descrição
| Importado da Canvas:https://school.instructure.com/courses/{course_id}/assignments/{assignment_id} |
resultValueMax
| {assignment.points_possible} |
valorMínimo do resultado
| 0 |
atribuirData
| {assignment.unlock_at} OU {assignment.due_at} |
data de vencimento
| {assignment.due_at} |
aula
| {Objeto de referência da classe OneRoster} |
categoria
| {Objeto de referência da categoria OneRoster} OU nulo* |
período de avaliação
| nulo OU {Objeto de referência academicSession do OneRoster}** |
*ver Notas de implementação da transferência de notas para categorias
**Consulte as notas de implementação da repasse de notas para períodos de avaliação.
Exemplos de configurações de carga útil
Exemplo de payload com SourceID |
|---|
{
"lineItem": {
"sourcedId": "799e2caf-728d-4ef6-8ff9-5325e64cecd5”
"status": "active”,
"title": "Canvas Test Assignment 1",
"description": "Importado do Canvas:https://school.instructure.com/courses/5582/assignments/135”,
"resultValueMax": 10,
"resultValueMin": 0,
"assignDate": "2021-03-10T23:59:59",
"dueDate": "2021-03-10T23:59:59",
"metadata": {
"vendorId": ""
},
"class": {
"href": "~/ims/oneroster/v1p1/classes/100453379",
"sourcedId": "100453379",
"type": "class"
},
"category": {
"href": "~/ims/oneroster/v1p1/categories/C5C3AC8C-8D0F-48EB-96F4-31437B640D16”,
"sourcedId": "C5C3AC8C-8D0F-48EB-96F4-31437B640D16”,
"type": “category"
},
"gradingPeriod": null
}
} |
Exemplo de payload sem ID de origem |
|---|
{
"lineItem": {
"status": "ativo",
"title": "Tarefa de Teste do Canvas 1",
"description": "Importado do Canvas:https://school.instructure.com/courses/5582/assignments/135”,
"resultValueMax": 10,
"resultValueMin": 0,
"assignDate": "2021-03-10T23:59:59",
"dueDate": "2021-03-10T23:59:59",
"metadata": {
"vendorId": ""
},
"class": {
"href": "~/ims/oneroster/v1p1/classes/100453379",
"sourcedId": "100453379",
"type": "class"
},
"category": {
"href": "~/ims/oneroster/v1p1/categories/C5C3AC8C-8D0F-48EB-96F4-31437B640D16”,
"sourcedId": "C5C3AC8C-8D0F-48EB-96F4-31437B640D16”,
"type": “category"
},
"gradingPeriod": null
}
} |
Considerações sobre a carga útil resultante
Você pode configurar os payloads de resultados incluídos na sua sincronização GPB.
O gráfico abaixo exibe as solicitações de itens de linha configuráveis. Como parte do processo de configuração individual do cliente, você pode personalizar a maioria dos valores padrão. Você também pode omitir qualquer um desses valores da carga útil. Alternativamente, se os dados correspondentes estiverem disponíveis na extração de dados do Canvas, você também pode configurar campos de metadados adicionais.
Saiba mais sobre o OneRosterresultados.
Nome do campo OneRoster | Valor padrão |
|---|
ID de origem | {sourcedId} |
item de linha | {Objeto de referência lineItem do OneRoster} |
estudante | {Objeto de referência do usuário OneRoster} |
status da pontuação | "Totalmente avaliado", "Não entregue" ou "Isento" |
pontuação | {submission.score} |
comentário | omitido por padrão* |
data da pontuação | omitido por padrão** |
*Consulte as notas de implementação da repasse de notas para obter comentários.
**Consulte as notas de implementação da passagem de notas para scoreDate
Exemplo de carga útil |
|---|
{
"resultado": {
"sourcedId": "0031e9ee-5bd0-4d80-a5f7-5c14fe75acc0”,
"lineItem": {
"href": "~/ims/oneroster/v1p1/lineItems/0ea49ae5-4a6b-45d5-a0c2-b01facbfbc5f”,
"sourcedId": "0ea49ae5-4a6b-45d5-a0c2-b01facbfbc5f”,
"type": “lineItem"
},
"aluno": {
"href": "~/ims/oneroster/v1p1/students/S100051158”,
"sourcedId": "S100051158",
"type": “student"
},
"scoreStatus": "fully graded",
"score": 10
}
} |
Pontuações
No Canvas, um instrutor pode atribuir notas negativas, bem como exceder a nota máxima. Considere como sua integração lidará com essas situações potenciais.
Em certos casos, como um isentostatus da pontuação, sua integração deve ser configurada para passar umnulovalor de pontuação, caso contrário, um0O valor da pontuação é passado para o SIS.
Valor scoreStatus do Canvas | Notas |
|---|
totalmente graduado |
submission.workflow_state = avaliadoDeve sempre ter uma pontuação associada.
|
não submetido |
submission.missing = trueGeralmente, só será aprovado se houver uma pontuação associada, mas é possível ter umapontuação=nula
|
isentar |
submission.excused = trueA pontuação seránulopor padrão ou0
|