Intégrer Canvas LMS

Déployez l’intégration Canvas LMS pour afficher les cours, créer des annonces de cours, gérer l’inscription aux cours et vérifier les notes des étudiants.

• En tant qu’étudiant, consultez les cours et leurs détails.
• En tant qu’enseignant, créez une annonce de cours, affichez/ajoutez des membres du cours et affichez les notes des élèves.

Votre avis nous intéresse ! Veuillez fournir vos commentaires pour ce modèle d’intégration au fur et à mesure que vous l’utilisez. Pour tout problème, notre équipe surveille également nos forums dédiés quotidiennement.

Pour plus de détails sur la micro-app prête à l’emploi pour Canvas LMS, consultez la section Utiliser les micro-apps Canvas LMS.

Vérifier les conditions préalables

Une fois l’intégration avec Canvas LMS configurée, vous aurez besoin de ces artefacts pour ajouter l’intégration dans les micro-apps Citrix Workspace :

• URL de base : https://{host_name}.com
• URL d’autorisation : https://{host_name}.com/login/oauth2/auth
• URL du jeton : https://{host_name}.com/login/oauth2/token
• ID du client : l’ID du client est la chaîne représentant les informations d’inscription client uniques au serveur d’autorisation.
• Clé secrète client : la clé secrète client représente la chaîne unique générée lors de la configuration de l’intégration de l’application cible.

Remarque :

Il est recommandé de toujours utiliser OAuth 2.0 comme méthode d’authentification de service lorsque cette méthode est disponible. OAuth 2.0 garantit que votre intégration respecte la conformité maximale en matière de sécurité avec votre micro-app configurée.

Configurez Citrix Gateway pour prendre en charge l’authentification unique pour Canvas LMS : une fois que les utilisateurs se connectent, ils sont automatiquement reconnectés sans avoir à entrer leurs informations d’identification une seconde fois. Pour plus d’informations sur la configuration de l’authentification unique (SSO, Single Sign-On), consultez Citrix Gateway Service.

Activer les API

Les API Canvas sont activées par défaut. Vous avez besoin d’un compte de partenaire Canvas pour accéder aux API. Le nombre de requêtes d’API pouvant être exécutées sur des ressources spécifiques est limité. Nous recommandons donc la limitation des API, comme décrit dans cet article : https://canvas.instructure.com/doc/api/file.throttling.html.

Créer un compte de service

L’intégration nécessite un accès régulier à votre instance Canvas LMS. Nous vous recommandons donc de créer un compte utilisateur dédié. Ce compte doit disposer des autorisations suivantes : Privilèges administrateur complet.

Il est recommandé d’avoir un compte de partenaire Canvas : https://www.instructure.com/canvas/become-partner.

Configurer le serveur OAuth

Configurez le serveur OAuth pour lire les données via l’intégration Canvas.

1. Connectez-vous à https://{host_name}.com/accounts en tant qu’administrateur.
2. Sélectionnez le compte que vous souhaitez intégrer.
3. Sélectionnez Developer Keys et sélectionnez + Developer Key.
4. Sélectionnez + API Key et remplissez les champs requis, y compris Key Name, Owner Email, Redirect URIs.
5. Entrez les URL de redirection autorisées suivantes pour cette application dans le champ Redirect URL : https://{yourmicroappserverurl}/admin/api/gwsc/auth/serverContext.
6. Sélectionnez Canevas pour Client Credentials Audience et cliquez sur Save.
7. Status doit être ON.
8. Copiez les valeurs ClientID et Secret à partir des détails. Vous utilisez ces valeurs pour l’authentification du service lors de la configuration de l’intégration.

Configurer le client OAuth

Configurez le client OAuth pour écrire les données via l’intégration Canvas.

1. Connectez-vous à https://{host_name}.com/accounts en tant qu’administrateur.
2. Sélectionnez le compte que vous souhaitez intégrer.
3. Sélectionnez Developer Keys et sélectionnez + Developer Key.
4. Sélectionnez + API Key et remplissez les champs requis, y compris Key Name, Owner Email, Redirect URIs.
5. Entrez les URL de redirection autorisées suivantes pour cette application dans le champ Redirect URL : https://{yourmicroappserverurl}/admin/api/gwsc/auth/serviceAction/callback.
6. Sélectionnez Canevas pour Client Credentials Audience et cliquez sur Save.
7. Status doit être ON.
8. Copiez les valeurs ClientID et Secret à partir des détails. Vous utilisez ces valeurs pour l’authentification des actions de service lors de la configuration de l’intégration.

Ajouter l’intégration aux micro-apps Citrix Workspace

Ajoutez l’intégration Canvas LMS aux micro-apps Citrix Workspace pour vous connecter à votre application. Des micro-apps prêtes à l’emploi sont proposées, ainsi que des notifications et des actions préconfigurées qui sont prêtes à être utilisées dans votre espace de travail.

Procédez comme suit :

1. Sur la page Intégrations de micro-apps, sélectionnez Ajouter nouvelle intégration et Ajouter une nouvelle intégration à partir des modèles fournis par Citrix.
2. Choisissez la vignette Canvas LMS .
3. Donnez un nom à l’intégration.

4. Renseignez la section Paramètres du connecteur :

   • Entrez l’URL de base https://{host_name}.com de l’instance :
   • Sélectionnez une icône pour l’intégration dans la bibliothèque d’icônes ou gardez l’icône par défaut.

5. Sous Authentification du service, sélectionnez OAuth 2.0 dans le menu Méthode d’authentification et complétez les détails d’authentification. Les options d’authentification sont présélectionnées. Assurez-vous que ces options sont sélectionnées lorsque vous effectuez le processus. Utilisez le protocole de sécurité OAuth 2.0 pour générer des jetons de demande/autorisation pour l’accès délégué. Il est recommandé de toujours utiliser OAuth 2.0 comme méthode d’authentification de service lorsque cette méthode est disponible. OAuth 2.0 garantit que votre intégration respecte la conformité maximale en matière de sécurité avec votre micro-app configurée.

   1. Sélectionnez Code d’autorisation dans le menu Type d’autorisation.
   2. L’URL d’autorisation est pré-remplie : https://{host_name}.com/login/oauth2/auth.
   3. L’URL du jeton est pré-remplie : https://{host_name}.com/login/oauth2/token.
   4. Saisissez votre ID client. L’ID du client est la chaîne représentant les informations d’inscription client uniques au serveur d’autorisation. Vous obtenez cet élément lorsque vous avez configuré le serveur OAuth.
   5. Entrez la Clé secrète client. La clé secrète client représente la chaîne unique générée lors de la configuration de l’intégration de l’application cible. Vous obtenez cet élément lorsque vous avez configuré le serveur OAuth.

6. Sous Authentification des actions de service, activez Utiliser authentification utilisateur distincte dans Actions. L’authentification des actions de service s’authentifie au niveau de l’action de service. Les options d’authentification sont présélectionnées. Assurez-vous que ces options sont sélectionnées lorsque vous effectuez le processus.

   1. Sélectionnez OAuth 2.0 dans le menu Méthode d’authentification et complétez les détails d’authentification.
   2. Sélectionnez Code d’autorisation dans le menu Type d’autorisation.
   3. L’URL d’autorisation est pré-remplie : https://{host_name}.com/login/oauth2/auth.
   4. L’URL du jeton est pré-remplie : https://{host_name}.com/login/oauth2/token.
   5. Saisissez votre ID client. L’ID du client est la chaîne représentant les informations d’inscription client uniques au serveur d’autorisation. Vous avez obtenu cette valeur lorsque vous avez configuré le client OAuth.
   6. Entrez la Clé secrète client. La clé secrète client représente la chaîne unique générée lors de la configuration de l’intégration de l’application cible. Vous avez obtenu cette valeur lorsque vous avez configuré le client OAuth.
7. Activez l’option Limitation du taux de demandes. Entrez 500 pour Nombre de demandes et 1 minute pour Intervalle de temps.
8. Laissez l’option Délais d’expiration des demandes vide.
9. (Facultatif) Activez la fonction Journalisation pour conserver 24 heures de journalisation à des fins de support.
10. Sélectionnez Enregistrer pour continuer.

Configurer les paramètres d’action de service

Après avoir configuré le modèle ci-dessus, vous devez configurer une action de service correctement. Pour la micro-app Mes notes, mettez à jour le paramètre host_name sur le bouton Afficher sur Canvas de la page Mes notes.

Procédez comme suit :

1. Sur la page Intégrations de micro-apps, accédez à l’intégration Canvas LMS et sélectionnez la micro-app Mes notes.
2. Sélectionnez Pages, puis la page Mes notes.
3. Dans le générateur de pages, sélectionnez le composant Afficher sur Canvas, puis Actions dans le panneau droit.
4. Sous Actions, sélectionnez Aller à l’URL.
5. Dans le champ Modèle d’URL, remplacez host_name par le nom d’hôte de votre instance. Ce formulaire est utilisé : https://{host_name}/courses/\{\{id\}\}/grades
6. Lorsque vous avez terminé, quittez l’écran. Les modifications sont enregistrées automatiquement pour le générateur.

Modifier les attributs de table

Pour terminer la configuration de l’intégration, vous devez modifier le type de données des points de terminaison répertoriés ci-dessous. Pour chaque point de terminaison répertorié dans le tableau suivant, vous devez modifier le type de données dans le menu correspondant à l’attribut donné.

Tableau	Colonne	Type de données
Attributions	points_possible	Binaire
Attributions	description	Binaire
Notes	current_grade	Binaire

Procédez comme suit :

1. Sur la page Intégrations de micro-apps, sélectionnez le menu en regard de l’intégration Canvas LMS, puis Modifier. L’écran Chargement des données s’ouvre. Si ce n’est pas le cas, sélectionnez Chargement des données dans la colonne de navigation gauche.
2. Pour chaque point de terminaison, sélectionnez le menu en regard du point de terminaison, puis Modifier.
3. Sur l’écran Modifier le point de terminaison de données, faites défiler jusqu’au bas de la page. Sur la table sous Structure des données, sélectionnez l’icône du crayon pour modifier le tableau.
4. Sur l’écran Modifier attributs de table, modifiez le champ Type de données en sélectionnant la nouvelle valeur dans le menu. Pour chaque modification apportée à chaque point de terminaison, sélectionnez Enregistrer, puis Appliquer.
5. Répétez cette procédure pour les autres points de terminaison.

Vous êtes maintenant prêt à définir et exécuter votre première synchronisation de données. Pour plus d’informations sur les règles de synchronisation, ainsi que sur la synchronisation qui ne respecte pas ses règles de planification et de veto, consultez la section Synchroniser les données.

Remarque :

Nous vous recommandons de définir l’intervalle Synchronisation complète sur Toutes les 8 heures et l’intervalle Synchronisation incrémentielle sur Toutes les heures.

Pour plus d’informations sur les points de terminaison d’API et les entités de table, consultez la section Spécifications du connecteur Canvas LMS.

Remarque :

En raison d’une limite du nombre d’appels d’API, la synchronisation incrémentielle est configurée pour ne conserver que les annonces. Les points de terminaison restants sont déclenchés dans le cadre de la synchronisation complète.

Utiliser les micro-apps Canvas LMS

Les intégrations d’application existantes sont fournies avec des micro-apps prêtes à l’emploi. Commencez avec ces micro-apps et personnalisez-les en fonction de vos besoins.

Créer une annonce de cours : les enseignants créent une annonce pour un cours.

Notification ou Page	Workflows de cas d’utilisation
Page Créer une annonce de cours	Fournit un formulaire permettant de créer une annonce pour un cours et d’ajouter les détails suivants : Cours (menu déroulant Cours), Titre, Message et Date de publication.

Mes cours : affichez les annonces de cours, les devoirs et les fichiers de cours.

Notification ou Page	Workflows de cas d’utilisation
Notification Invitation au cours	Lorsqu’un étudiant est invité à un cours, il reçoit une notification.
Notification Nouvelles annonces de cours	Lorsqu’une nouvelle annonce est publiée pour un cours, les étudiants inscrits au cours reçoivent une notification.
Notification (future) Nouvelles annonces de cours	En cas de nouvelle annonce pour un cours avec une date de publication future, les étudiants inscrits au cours reçoivent une notification.
Page Accepter/rejeter l’invitation	Fournit une vue en lecture seule d’une invitation à un cours avec les options Accepter ou Rejeter.
Page Liste des cours	Permet aux utilisateurs d’afficher la liste des cours auxquels ils sont inscrits.
Page Détails du cours	Permet aux utilisateurs d’afficher la liste des annonces et des fichiers d’un cours.
Page Détails de l’annonce	Permet aux utilisateurs de consulter l’annonce du cours et ses détails.
Page Détails de l’attribution	Permet aux utilisateurs d’afficher une attribution et ses détails.
Page Détails du fichier	Permet aux utilisateurs d’afficher et de télécharger des fichiers.

Mes notes : les élèves voient leurs notes de cours.

Notification ou Page	Workflows de cas d’utilisation
Notification Nouvelles notes	Lorsque de nouvelles notes sont publiées pour un cours, les étudiants inscrits au cours reçoivent une notification.
Page Liste des cours	Permet aux utilisateurs d’afficher la liste des cours auxquels ils sont inscrits.
Page Mes notes	Permet aux utilisateurs d’afficher les notes du cours sélectionné.

Vue de l’enseignant : les enseignants affichent et ajoutent des participants au cours et affichent les élèves.

Notification ou Page	Workflows de cas d’utilisation
Page Liste des cours	Permet aux enseignants de consulter la liste des cours disponibles.
Page Répertorier membres	Permet aux enseignants d’afficher la liste des membres inscrits à un cours, avec un bouton Ajouter qui accède à la page Ajouter un utilisateur.
Page Détails sur les membres	Permet aux enseignants de consulter les notes et les détails des membres d’un cours.
Page Ajouter un utilisateur	Permet aux enseignants d’ajouter un étudiant au cours sélectionné.