Você pode configurar as opções de integração do Instructure OneRoster em cada nível de conexão do cliente.
Durante a fase de testes alfa de integração, a Instructure trabalhará com você para estabelecer as configurações padrão recomendadas para sua instituição.
Saiba mais sobreconfigurações de serviço de escalonamento e melhores práticas de integração de escalas.
Observação:A Instructure é uma consumidora do OneRoster. Para obter as definições de consumidor e provedor do OneRoster, consulte oIntrodução ao OneRoster.
Concorrência
A concorrência é o número de endpoints que podem ser processados simultaneamente. Com uma concorrência de três, você pode configurar até três endpoints concorrentes separados. Por exemplo, você pode usar oobterTermos,getTeachers,obterClassespontos de extremidade simultaneamente.
Saiba mais sobre como configurarpontos de referência específicos da escola para o cadastro de alunospara permitir a sincronização simultânea de dados de matrícula.
Observação:A Instructure não aplica concorrência à paginação. Como resultado, o carregamento de dados é tão lento quanto o tempo de resposta do endpoint mais lento combinado com a paginação em uma única thread.
Tratamento de erros
O tratamento de erros refere-se à configuração dos códigos de erro exibidos.
Siga a OneRosterespecificações de tratamento de errosAlém disso, recomenda-se que você inclua seu nome SIS no início do documento.imsx_descriptionIsso permite que a integração exiba automaticamente descrições de erros instrutivas para os usuários finais.
Pontos finais excluídos
Os endpoints excluídos são os endpoints que não estão incluídos em uma chamada de API.
Se dois endpoints retornarem conjuntos de dados idênticos, exclua um deles para reduzir o número de chamadas à API. Por exemplo,obterTodasAsSessõesAcadêmicas e obterTodosOsTermosPodem fornecer conjuntos de dados idênticos, portanto, inclua apenas um na configuração do seu endpoint.
Durante o período de testes alfa de integração, informe a Instructure sobre quaisquer endpoints excluídos.
Saiba mais sobre o OneRosterconfigurações de endpoint.
Consultas de filtro
Filtre os dados incluídos em uma sincronização de dados usando consultas de filtro. Você pode configurar consultas de filtro para cada tarefa individualmente, permitindo sincronizações de dados em lote e incrementais.
Durante o período de testes alfa de integração, informe a Instructure sobre as consultas de filtro configuradas para o OneRoster.
Saiba mais sobre o OneRosterconsultas de filtroAlém disso, saiba mais sobrerequisitos de implementação de sincronização incremental.
Paginação
Como as chamadas de API para um SIS podem solicitar grandes quantidades de dados, a paginação organiza os resultados das suas consultas de API. Para diminuir o tráfego HTTP e melhorar o tempo de sincronização, recomenda-se configurar a paginação para suportar um limite de até 1000 registros por vez.
Saiba mais sobre o OneRosterrequisitos de paginação.
Observação: Embora não seja recomendado, a Instructure pode dar suporte a implementações em que todos os dados solicitados estejam incluídos em uma única chamada de API, desde que o número de timeouts não se torne excessivo.
Tentativas repetidas
As tentativas representam o número de vezes que a integração tenta fazer uma chamada à API. A integração do Instructure OneRoster tenta fazer uma chamada à API até três vezes antes de apresentar um erro. Há um período de atraso entre cada tentativa, e um multiplicador de atraso aumenta o período de atraso entre as tentativas.
Com a configuração de exemplo abaixo, uma chamada de API será tentada até três vezes, aguardando 5 segundos após o primeiro erro e, em seguida, 15 segundos após o segundo erro consecutivo. Se a chamada falhar na terceira vez, a tarefa de integração falhará.
Exemplo de configuração de repetição | Interpretação |
|---|
“defaultRetries”: 2
| 3 tentativas |
“defaultDelay”: 5000
| 5 segundos |
“multiplicadorDeAtrasoPadrão”: 3
| 15 segundos |
Tempo limite
Os timeouts ocorrem quando uma requisição à API do servidor web demora muito tempo em comparação com o tempo de espera do servidor do seu site. Se necessário, você pode aumentar o tempo de espera do servidor do seu site (por exemplo, para mais de 2 minutos). No entanto, sempre que possível, você deve ajustar sua integração para torná-la mais responsiva (por exemplo, menos de 20 segundos).