Esta documentação fornece instruções sobre como usar a nova API de mapeamento de domínio de migração. Esse fluxo de trabalho permitirá a migração de um ou mais URLs de link 1.1 para um domínio de registro 1.3 diferente, preenchendo a lacuna exata do requisito de correspondência de domínio.
O que ele pode fazer
Essa API de mapeamento de domínio de migração permitirá a migração de um ou mais URLs de link legados para um domínio de registro Advantage diferente. Os casos de uso incluem adicionar, remover ou atualizar domínios legados e fazer com que vários URLs de link legados migrem para um domínio de registro de vantagem diferente. Após a conclusão desse mapeamento, as migrações podem ser concluídas por meio dos processos normais de migração de cópia do curso, importação ou manualmente com o comando Migrar botão.
Por exemplo, links com os seguintes URLs de links legados:
- Domain1.example.com, e
- Domain2.example2.com
Pode ser migrado para o seguinte domínio de registro:
Tabela 1: Exemplos de migração disponíveis por meio da API de Mapeamento de Domínio de Migração.
Exemplo de um caso de usuário | URL do link legado | Domínio de registro Advantage | Domínio mapeado | URL do link após a migração |
|---|
Alteração de subdomínio | subdomain1.primary.com/path1 | domain3.com | domain1.com | domain3.com/path1 |
Subdomínio | subdomain1.domain2.com/path1 | domain3.com | domain2.com | domain3.com/path1 |
Remoção de subdomínio e alteração de domínio | domain2.com/path1 | domain3.com | domain2.com | domain3.com/path1 |
Mapeamento de URL de vários links herdados | domain2.com; subdomain1.domain2.com | domain3.com | domain2.com | domain3.com |
O que não pode fazer
Essa funcionalidade de migração adicional não permite que o caminho seja atualizado ou que os parâmetros personalizados sejam atualizados por meio do processo de migração. Conforme mostrado na tabela acima, o caminho da URL do link herdado é transportado para a URL do link após a migração. Essa API adicional preenche apenas a lacuna exata de correspondência de domínio; todas as outras limitações e casos de uso descritos no Documentação de migração de LTIe Perguntas frequentes sobre migração ainda se aplicam.
A API de migração (que migra um único link por vez) não funciona com domínios legados mapeados.
Como funciona
O URL do link legado pode ser encontrado no nível do curso. Navegue até Administração do curso >Ferramentas de aprendizagem externas > Gerenciar links de ferramentas (herdado) e selecione seu link.
Figura: Um exemplo de um URL de link herdado LTI 1.1.
Para visualizar o Domínio de Registro Advantage, navegue até Ferramentas de administração > Gerenciar extensibilidade > Vantagem LTI e selecione seu registro.
Figura: Um exemplo de um Domínio de Registro LTI 1.3 Advantage no Editar ferramenta de teste de LTI diálogo.
A migração só é tentada quando as implantações são compartilhadas. Talvez seja necessário verificar as regras de compartilhamento de uma implantação; O cliente deve fornecer o contexto correto para onde a migração é necessária.
Do Vantagem LTI , clique em Registro da ferramenta Advantagee navegue até Exibir implantações.
Selecione sua implantação e certifique-se de que ela seja compartilhada com o destino da migração adicionando unidades organizacionais no Disponibilizar ferramenta para secção. Links de migração automática deve ser habilitado.
Figura: O Disponibilizar ferramenta para secção
O URL do link após a migração pode ser encontrado no nível do curso. Navegue até Administração do curso > Ferramentas de aprendizagem externas > Vantagem LTI e selecione seu link.
Figura: O Editar link AGS com datas onde você pode localizar o URL do link após a migração.
Depois que os domínios legados são mapeados, as migrações podem ser concluídas por meio de processos de migração existentes, de cópia do curso, importação ou manualmente usando o comando Migrar no nível do curso Gerenciar links de ferramentas (herdado) página.
Passos a serem executados
1. Confirme se a correspondência exata de domínio é a única limitação. O caminho e quaisquer parâmetros personalizados não podem ser atualizados. O Gerenciar registros da ferramenta LTI Advantage é necessária permissão.
2. Com o Postman ou qualquer outra ferramenta de teste de API, use a API GET para encontrar todos os registros da instância. Em seguida, copie o ClientID para o Domínio de Registro Advantage desejado que foi bloqueado anteriormente pelo requisito de correspondência de domínio exato. Este é o Domínio de Registro LTI Advantage.
GET /d2l/api/le/(versão)/ltiadvantage/registration/ <br/>
3. Use a nova API Mapping Get para obter registros disponíveis para esse ClientId:
GET/d2l/api/le/{versão}/ltiadvantage/registration/{clientId}/legacydomains/
Essa API retorna uma matriz JSON de strings de domínio herdadas configuradas para um determinado registro LTI Advantage; Essa solicitação inicial deve retornar um resultado vazio.
4. Para mapear um URL de link legado para um domínio de registro Advantage, use a API POST. Esta é a coluna de URL do link herdado que foi bloqueada anteriormente pela limitação exata de correspondência de domínio, observe que https:// é necessária. Essa API pode ser executada várias vezes para adicionar à lista existente.
POST/d2l/api/le/{versão}/ltiadvantage/registration/{clientId}/legacydomains/
Figura: Use a API POST para mapear o URL do link herdado para um domínio de registro do Advantage.
5. Para mapear mais de um URL de link legado para um registro 1.3, use a API PUT. A API PUT substitui a lista existente de URLs mapeadas.
PUT/d2l/api/le/{versão}/ltiadvantage/registration/{clientId}/legacydomains/
Figura: Use a API PUT para mapear várias URLs de Link Legado para um registro 1.3.
Todos os eventos de migração futuros agora tentam uma migração dos URLs de link herdados mapeados para o registro de domínio 1.3. A migração pode ser iniciada por API, cópia do curso, importação ou manualmente no nível do curso.
O URL do link após a migração rotulado tem o caminho do URL do link legado.
Os trabalhos de migração com falha são identificados na tabela de log de migração com entradas no Sem correspondência de domínio coluna.
Figura: O Sem correspondência de domínio indica se houve alguma falha no trabalho de migração devido a problemas de correspondência.
Como interromper a API de mapeamento de domínio de migração
Para interromper esse processo, solicite a API PUT com uma string vazia, isso removerá os domínios legados mapeados anteriormente.
Para interromper imediatamente o processo de migração, desative o Links de migração automática alterne na implantação ou remova todas as regras de compartilhamento em que a migração não é desejada. A integração também pode ser desativada a qualquer momento, mas isso também impede que toda a integração funcione, em vez de apenas a migração.
