Cette documentation fournit des instructions sur l’utilisation de la nouvelle API de mappage de domaine de migration. Ce flux de travail permettra la migration d’une ou de plusieurs URL de liens 1.1 vers un domaine d’enregistrement 1.3 différent, comblant ainsi l’écart exact des exigences de correspondance de domaine.
Ce qu’il peut faire
Cette API de mappage de domaine de migration permettra la migration d’une ou plusieurs URL de lien hérité vers un autre domaine d’enregistrement Advantage. Les cas d’utilisation incluent l’ajout, la suppression ou la mise à jour de domaines hérités et la migration de plusieurs URL de liens hérités vers un domaine d’enregistrement d’avantage différent. Une fois ce mappage terminé, les migrations peuvent être effectuées via les processus de migration normaux de copie de cours, d’importation ou manuellement avec le Migrer bouton.
Par exemple, des liens avec les URL de lien hérité suivantes :
- Domain1.example.com, et
- Domain2.example2.com
Peut être migré vers le domaine d’enregistrement suivant :
Tableau 1 : Exemples de migration disponibles via l’API de mappage de domaine de migration.
Exemple de cas d’utilisateur | URL du lien hérité | Domaine d’enregistrement Avantage | Domaine mappé | URL du lien après la migration |
|---|
Modification de sous-domaine | subdomain1.primary.com/path1 | domain3.com | domain1.com | domain3.com/path1 |
Sous-domaine | subdomain1.domain2.com/path1 | domain3.com | domain2.com | domain3.com/path1 |
Suppression de sous-domaine et modification de domaine | domain2.com/path1 | domain3.com | domain2.com | domain3.com/path1 |
Mappage d’URL de plusieurs liens hérités | domain2.com ; subdomain1.domain2.com | domain3.com | domain2.com | domain3.com |
Ce qu’il ne peut pas faire
Cette fonctionnalité de migration supplémentaire ne permet pas de mettre à jour le chemin d’accès ou de mettre à jour les paramètres personnalisés via le processus de migration. Suivant les indications du tableau ci-dessus, le chemin d’accès de l’URL de lien hérité est effectué jusqu’à l’URL du lien après la migration. Cette API supplémentaire ne fait que combler l’écart exact de correspondance de domaine ; toutes les autres limitations et cas d’utilisation décrits dans le Documentation de migration LTI, et FAQ sur la migration s’appliquent toujours.
L’API de migration (qui migre un seul lien à la fois) ne fonctionne pas avec les domaines hérités mappés.
Comment ça marche
L’URL du lien hérité se trouve au niveau du cours. Accédez à Administrateur du cours >Outils d’apprentissage externes > Gérer les liens d’outils (hérité) et sélectionnez votre lien.
Figure : Un exemple d’url de lien hérité LTI 1.1.
Pour afficher le domaine d’enregistrement Advantage, accédez à Outils d’administration > Gérer l’extensibilité > Avantage LTI et sélectionnez votre inscription.
Figure : Un exemple de domaine d’enregistrement LTI 1.3 Advantage dans le Modifier l’outil de test LTI boîte de dialogue.
La migration n’est tentée que lorsque les déploiements sont partagés. Vous devrez peut-être vérifier les règles de partage pour un déploiement ; le client doit fournir le contexte correct pour l’endroit où la migration est nécessaire.
De l' Avantage LTI , cliquez sur Inscription à l’outil Advantage, et naviguez jusqu’à Afficher les déploiements.
Sélectionnez votre déploiement et assurez-vous qu’il est partagé avec la destination de migration en ajoutant des unités d’organisation dans le Mettre l’outil à la disposition de section. Liens de migration automatique doit être activé.
Figure : L' Mettre l’outil à la disposition de section
L’URL du lien après la migration se trouve au niveau du cours. Accédez à Administrateur du cours > Outils d’apprentissage externes > Avantage LTI et sélectionnez votre lien.
Figure : L' Modifier le lien AGS avec les dates où vous pouvez localiser l’URL du lien après la migration.
Une fois les domaines hérités mappés, les migrations peuvent être effectuées via les processus de migration existants, c’est-à-dire copier, importer ou manuellement à l’aide du Migrer au niveau du cours Gérer les liens d’outils (hérité) page.
Étapes d’exécution
1. Confirmez si la correspondance exacte de domaine est la seule limitation. Le chemin d’accès et les paramètres personnalisés ne peuvent pas être mis à jour. L' Gérer les inscriptions d’outils LTI Advantage l’autorisation est requise.
2. Avec Postman ou tout autre outil de test d’API, utilisez l’API GET pour trouver tous les enregistrements pour l’instance. Copiez ensuite l’ID Client pour le domaine d’enregistrement Advantage souhaité qui a été précédemment bloqué par l’exigence exacte de correspondance de domaine. Il s’agit du domaine d’enregistrement LTI Advantage.
GET /d2l/api/le/(version)/ltiadvantage/registration/ <br/>
3. Utilisez la nouvelle API Mappage Get pour obtenir les enregistrements disponibles pour ce ClientId :
GET/d2l/api/le/{version}/ltiadvantage/registration/{clientId}/legacydomains/
Cette API retourne un tableau JSON de chaînes de domaine héritées qui sont configurées pour un enregistrement LTI Advantage donné ; cette demande initiale doit renvoyer un résultat vide.
4. Pour mapper une URL de lien hérité à un domaine d’enregistrement Advantage, utilisez l’API POST. Il s’agit de la colonne URL de lien héritée qui a été précédemment bloquée par la limitation de correspondance de domaine exacte, notez que https:// est nécessaire. Cette API peut être exécutée plusieurs fois pour être ajoutée à la liste existante.
POST/d2l/api/le/{version}/ltiadvantage/registration/{clientId}/legacydomains/
Figure : Utilisez l’API POST pour mapper l’URL du lien hérité à un domaine d’enregistrement Advantage.
5. Pour mapper plus d’une URL de lien hérité à un enregistrement 1.3, utilisez l’API PUT. L’API PUT remplace la liste existante d’URL mappées.
PUT/d2l/api/le/{version}/ltiadvantage/registration/{clientId}/legacydomains/
Figure : Utilisez l’API PUT pour mapper plusieurs URL de lien hérité à une inscription 1.3.
Tous les événements de migration futurs tentent maintenant une migration à partir des URL de lien hérité mappés à l’enregistrement de domaine 1.3. La migration peut être initiée par API, copie de cours, importation ou manuellement au niveau du cours.
L’URL de lien après la migration étiquetée a le chemin d’accès de l’URL de lien hérité.
Les travaux de migration ayant échoué sont identifiés dans la table du journal de migration avec les entrées du Aucune correspondance de domaine colonne.
Figure : L' Aucune correspondance de domaine indique s’il y a eu des échecs de travail de migration en raison de problèmes de correspondance.
Comment arrêter l’API de mappage de domaine de migration
Pour arrêter ce processus, demandez l’API PUT avec une chaîne vide, cela supprimera les domaines hérités précédemment mappés.
Pour arrêter immédiatement le processus de migration, désactivez le Migration automatique des liens basculez au déploiement ou supprimez toutes les règles de partage où la migration n’est pas souhaitée. L’intégration peut également être désactivée à tout moment, mais cela empêche également toute l’intégration de fonctionner, plutôt que de simplement effectuer une migration.
