Ce document explique comment intégrer la plateforme Panorama à votre système de gestion de l'apprentissage (LMS) Canvas LTI 1.1. Avant de suivre les étapes ci-dessous, assurez-vous de disposer d'un accès administrateur complet à votre instance Canvas. Si vous avez des questions sur l'une des étapes de ce processus, veuillez contacter votre gestionnaire de compte dédié.
Obtention de votre clé de consommateur, de votre secret LTI et du fichier XML pour votre intégration
Avant de suivre les étapes ci-dessous, vous devez avoir reçu un courriel de votre gestionnaire de compte vous invitant à créer votre compte Panorama. Créez votre compte, puis suivez les étapes ci-dessous.
- Connectez-vous à votre compte Panorama.
- Cliquez sur Configurations dans le menu de gauche, puis sélectionnez Paramètres d'intégration.
- Sélectionnez LTI 1.1.
- Cliquez sur Télécharger le XML LTI 1.1, puis copiez votre clé de consommateur et votre secret LTI. Ils seront nécessaires dans la section suivante de ce guide.
Génération d'une clé client et d'un secret
- Cliquez sur + Developer Key > API Key.
-
Saisissez les informations suivantes :
- Key Name : Panorama API Integration
-
Redirect URls : https://<zoneURL>/canvas-auth
- Zone États-Unis : https://panorama-api.yuja.com/canvas-auth
- Zone Canada : https://panorama-api-cz.yuja.com/canvas-auth
- Zone UE : https://panorama-api-ez.yuja.com/canvas-auth
- Zone Australie : https://panorama-api-az.yuja.com/canvas-auth
- (Facultatif) Activez Enforce Scopes.
Remarque : Nous déconseillons d'appliquer les portées. Vous devrez alors réintégrer Panorama avec l'API de Canvas chaque fois que Panorama ajoutera une nouvelle fonctionnalité utilisant l'API. Si vous ne souhaitez pas procéder ainsi, assurez-vous que Enforce Scopes est désactivé, puis passez à l'étape 5. - Cochez Allow Include Parameters puis cochez les paramètres suivants :
- Accounts
- url:GET|/api/v1/accounts
- url:GET|/api/v1/accounts/:id
- url:GET|/api/v1/accounts/:account_id/courses
- url:GET|/api/v1/accounts/:account_id/sub_accounts
- Admins
- url:GET|/api/v1/accounts/:account_id/admins
- Assignments
- url:GET|/api/v1/courses/:course_id/assignments
- url:GET|/api/v1/courses/:course_id/assignments/:id
- url:PUT|/api/v1/courses/:course_id/assignments/:id
- Courses
- url:GET|/api/v1/courses
- url:GET|/api/v1/courses/:id
- url:GET|/api/v1/courses/:course_id/users
- url:GET|/api/v1/courses/:course_id/users/:id
- url:PUT|/api/v1/courses/:id
- url:POST|/api/v1/courses/:course_id/files
- Discussion Topics
- url:GET|/api/v1/courses/:course_id/discussion_topics
- url:GET|/api/v1/courses/:course_id/discussion_topics/:topic_id
- url:PUT|/api/v1/courses/:course_id/discussion_topics/:topic_id
- url:PUT|/api/v1/courses/:course_id/discussion_topics/:topic_id/entries/:id
- Enrollments
- url:GET|/api/v1/users/:user_id/enrollments
- url:GET|/api/v1/courses/:course_id/enrollments
- Enrollment Terms
- url:GET|/api/v1/accounts/:account_id/terms
- url:GET|/api/v1/accounts/:account_id/terms/:id
- Files
- url:GET|/api/v1/courses/:course_id/files
- url:GET|/api/v1/files/:id
- url:POST|/api/v1/files/:id
- url:PUT|/api/v1/files/:id
- Pages
- url:GET|/api/v1/courses/:course_id/pages
- url:GET|/api/v1/courses/:course_id/pages/:url_or_id
- url:PUT|/api/v1/courses/:course_id/pages/:url_or_id
- url:POST|/api/v1/courses/:course_id/pages
- Quizzes
- url:GET|/api/v1/courses/:course_id/quizzes
- url:GET|/api/v1/courses/:course_id/quizzes/:id
- url:GET|/api/quiz/v1/courses/:course_id/quizzes/:assignment_id
- url:GET|/api/quiz/v1/courses/:course_id/quizzes
- url:PUT|/api/v1/courses/:course_id/quizzes/:id
- url:PATCH|/api/quiz/v1/courses/:course_id/quizzes/:assignment_id
- Roles
- url:GET|/api/v1/accounts/:account_id/roles
- url:GET|/api/v1/accounts/:account_id/roles/:id
- Rubrics
- url:GET|/api/v1/courses/:course_id/rubrics
- url:GET|/api/v1/courses/:course_id/rubrics/:id
- LTI Resource Links
- url:GET|/api/v1/courses/:course_id/lti_resource_links
- url:GET|/api/v1/courses/:course_id/lti_resource_links/:id
- Accounts
- Cliquez sur Save.
- Repérez la clé de développeur Panorama API Integration que vous venez de créer et copiez le Client ID sous Details.
- Cliquez sur Show Key et copiez le Client Secret.
- Connectez-vous à Panorama, puis, dans le menu de gauche, cliquez sur Configuration > Paramètres d'intégration.
- Dans le menu déroulant Sélectionner l'intégration , sélectionnez LMS API.
- Cliquez sur Ajouter une clé d'accès.
- Pour la méthode d'authentification Canvas, choisissez Client ID.
- Dans le champ Client ID , saisissez l'ID de l'étape 8.
- Dans le champ Client Secret , saisissez le secret client de l'étape 9.
- Si vous avez utilisé des portées appliquées, activez Utiliser les portées appliquées. Sinon, ignorez cette étape.
- Cliquez sur S'authentifier avec Canvas.
Remarque : Assurez-vous d'être connecté à Canvas en tant qu'administrateur disposant de tous les privilèges. - Cliquez sur Authorize.
- Copiez la réponse d'authentification et retournez dans Panorama. Collez la réponse dans le champ Réponse d'authentification Canvas.
- Cliquez sur Ajouter une clé d'accès.
- Cliquez sur Enregistrer les modifications pour terminer la configuration.
Ajout de Panorama à Canvas
Une fois que vous avez obtenu votre clé de consommateur, votre clé secrète et votre configuration XML, vous pouvez ajouter Panorama à votre instance Canvas.
- Connectez-vous à Canvas en tant qu'administrateur. Dans la barre latérale gauche, cliquez sur Admin, puis sélectionnez le compte Canvas de votre établissement.
- Cliquez sur Settings > Apps > View App Configurations.
- Cliquez sur + App, renseignez les informations suivantes, puis cliquez sur Submit pour terminer la configuration de Panorama pour Canvas.
- Configuration Type : Paste XML
- Name : Panorama Configuration
- Consumer Key : Obtenue dans la première section de ce guide.
- Secret Key : Le secret LTI obtenu dans la première section de ce guide.
- XML Configuration : Ouvrez le fichier XML téléchargé dans la première section de ce guide. Copiez son contenu dans un éditeur de texte tel que le Bloc-notes, puis collez-le ici.
Installation de LMS Visualizer
Cette étape exige que la fonctionnalité Custom CSS/JavaScript Overrides soit activée sur votre instance Canvas. Si elle n'est pas activée, veuillez contacter votre gestionnaire de compte Canvas. LMS Visualizer permettra l'affichage des icônes d'accessibilité de Panorama.
- Connectez-vous à votre compte Panorama.
- Cliquez sur Configurations > Paramètres d'intégration.
- Sélectionnez LMS Visualizer > Télécharger Visualizer.
- Ensuite, connectez-vous à Canvas en tant qu'administrateur. Dans la barre latérale gauche, cliquez sur Admin et sélectionnez le compte auquel appliquer YuJa Panorama - LMS Viewer.
- Sélectionnez Settings dans la barre de navigation de gauche, et assurez-vous que l'onglet Settings est sélectionné dans la rangée du haut.
- Faites défiler jusqu'à la section Features.
- Si l'option Custom CSS/JavaScript overrides est disponible, assurez-vous qu'elle est cochée. Ensuite, faites défiler vers le bas et cliquez sur Update Settings.
- Si l'option Custom CSS/JavaScript overrides n'est pas disponible, veuillez contacter votre gestionnaire de compte Canvas pour activer Custom CSS/JavaScript overrides dans le Theme Editor.
- Si l'option Custom CSS/JavaScript overrides est disponible, assurez-vous qu'elle est cochée. Ensuite, faites défiler vers le bas et cliquez sur Update Settings.
- Ensuite, cliquez sur Themes dans la barre de navigation de gauche, puis choisissez le bouton + Theme. Sélectionnez un modèle de thème dans la liste déroulante.
- Dans le Canvas Theme Editor, accédez à l'onglet Upload et sélectionnez le fichier Canvas Visualizer que vous avez téléchargé à l'étape 3 de cette section. Important : L'onglet Upload n'est disponible qu'une fois que votre gestionnaire de compte l'a activé.
- Ensuite, cliquez sur Preview Your Changes, puis choisissez Apply Theme. Lorsqu'on vous demande de nommer votre thème, saisissez Panorama Theme.
Désinstallation de Panorama d'une instance Canvas
Pour retirer Panorama d'une instance Canvas, l'administrateur devra supprimer l' application LTI et le LMS Viewer. Pour savoir comment retirer ces fonctionnalités, suivez les étapes ci-dessous.
- Connectez-vous à Canvas en tant qu'administrateur. Dans la barre latérale gauche, cliquez sur Admin, puis sélectionnez le compte Canvas de votre organisation.
- Sélectionnez Settings dans la barre de navigation de gauche.
- Sélectionnez l'onglet App dans la rangée du haut, puis cliquez sur View App Configuration.
- Sélectionnez l'icône d'engrenage de l'application LTI Panorama, puis cliquez sur Delete.
- Sélectionnez Delete pour confirmer la suppression de l'outil et désactiver l'intégration de Panorama pour LTI 1.1.
- Enfin, en tant qu'administrateur, vous devrez supprimer le LMS Viewer en cliquant sur Themes dans le menu de navigation.
- Ensuite, sélectionnez le thème de Panorama, et cliquez sur Open in Theme Editor.
- Dans le panneau de gauche, cliquez sur Upload.
- Sous JavaScript file, cliquez sur le X pour supprimer le script Panorama .
- Cliquez sur Save theme. Panorama a maintenant été désinstallé avec succès de l'instance Canvas.