Micro-apps

Intégrer Blackboard Learn

Déployez l’intégration Blackboard Learn pour vous inscrire à un nouveau cours et consulter le cours, ainsi que ses détails connexes en tant qu’étudiant et pour créer une annonce de cours et afficher les membres et les notes du cours en tant qu’instructeur.

Remarque :

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 Blackboard Learn, consultez la section Utiliser les micro-apps Blackboard Learn.

Vérifier les conditions préalables

Vous avez besoin des artefacts suivants 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/learn/api/public/v1/oauth2/authorizationcode
  • URL du jeton : https://{host_name}.com/learn/api/public/v1/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. Vous obtenez cet élément en tant que clé de l’application lorsque vous configurez le serveur OAuth.
  • 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 en tant que clé secrète lorsque vous configurez le client OAuth.

Remarque :

Nous vous recommandons 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 : 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 https://docs.citrix.com/en-us/citrix-gateway-service/.

Créer un compte utilisateur

L’intégration nécessite l’accès régulier à votre instance Blackboard. Nous vous recommandons de créer un compte utilisateur dédié : compte Blackboard Partner https://docs.blackboard.com/partners/become-a-partner.

Les autorisations suivantes sont requises : Privilèges administrateur complet.

Accès aux API

Les API Blackboard sont activées par défaut. Une AMI Blackboard Developer ou un compte Blackboard Partner est requis 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 vous recommandons de consulter les informations suivantes : https://docs.blackboard.com/learn/rest/admin/groups-quotas-rates

Important

La limite de pagination est définie sur 100. Les administrateurs peuvent étendre cette limite jusqu’à 200 en fonction des API.

Le serveur de développement Blackboard Learn prend en charge jusqu’à 10 000 appels d’API par site/24 heures.

Le serveur de production Blackboard Learn prend en charge jusqu’à 75 000 appels d’API par site/24 heures.

En raison de la limite des appels d’API, la synchronisation incrémentielle est configurée pour conserver uniquement les paramètres Membres de cours et Annonces de cours. Les points de terminaison restants seront déclenchés dans le cadre de la synchronisation complète.

Configurer le serveur OAuth

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

  1. Connectez-vous à https://developer.blackboard.com/.
  2. Sélectionnez My Apps et sélectionnez l’icône + pour créer une nouvelle application. Vous pouvez également accéder à : https://developer.blackboard.com/portal/applications/create.
  3. Remplissez les champs requis et sélectionnez Register application and generate API key.
  4. Copiez et enregistrez l’ID d’application (Application ID), la clé de l’application (Application Key) et la clé secrète (Secret) affichées à l’écran. Vous utilisez ces détails pour l’authentification du service lors de la configuration de l’intégration.
  5. Connectez-vous à l’application Blackboard Learn en tant qu’administrateur.
  6. Accédez à System Admin.
  7. Sélectionnez REST API Integrations sous le tableau Intégrations.
  8. Sélectionnez Create Integration.
  9. Renseignez les champs obligatoires :

    1. Collez la valeur Application ID que vous avez sélectionnée à l’étape 4 ci-dessus.
    2. Entrez votre nom d’utilisateur administrateur dans le champ Learn User.
    3. Sélectionnez Yes sous End User Access et Authorized To Act As User.

Configurer le client OAuth

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

  1. Connectez-vous à https://developer.blackboard.com/.
  2. Sélectionnez My Apps et sélectionnez l’icône + pour créer une nouvelle application. Vous pouvez également accéder à : https://developer.blackboard.com/portal/applications/create.
  3. Remplissez les champs requis et sélectionnez Register application and generate API key.
  4. Copiez et enregistrez l’ID d’application (Application ID), la clé de l’application (Application Key) et la clé secrète (Secret) affichées à l’écran. Vous utilisez ces détails pour l’authentification des actions de service lors de la configuration de l’intégration.
  5. Connectez-vous à l’application Blackboard Learn en tant qu’administrateur.
  6. Accédez à System Admin.
  7. Sélectionnez REST API Integrations sous le tableau Intégrations.
  8. Sélectionnez Create Integration.
  9. Renseignez les champs obligatoires :

    1. Collez la valeur Application ID que vous avez sélectionnée à l’étape 4 ci-dessus.
    2. Entrez votre nom d’utilisateur administrateur dans le champ Learn User.
    3. Sélectionnez Yes sous End User Access et Authorized To Act As User.

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

Ajoutez l’intégration Blackboard Learn aux micro-apps Citrix Workspace pour vous connecter à votre application. Les options d’authentification sont présélectionnées. Assurez-vous que ces options sont sélectionnées lorsque vous effectuez le processus. 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 Blackboard Learn.
  3. Donnez un nom d’intégration à l’intégration.
  4. Renseignez la section Paramètres du connecteur.
    • Entrez l’URL de base 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 Informations d’identification du client dans le menu Type d’autorisation.
    2. Sélectionnez En-tête d’autorisation dans le menu Autorisation de jeton.
    3. L’URL du jeton est pré-remplie : https://{host_name}.com/learn/api/public/v1/oauth2/token
    4. Assurez-vous que l’élément suivant est saisi sous Étendue : read
    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 obtenez cet élément en tant que clé de l’application lorsque vous configurez le serveur 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 obtenez cet élément en tant que clé secrète lorsque vous configurez 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 En-tête d’autorisation dans le menu Autorisation de jeton.
    3. L’URL d’autorisation est pré-remplie : https://{host_name}.com/learn/api/public/v1/oauth2/authorizationcode
    4. L’URL du jeton est pré-remplie : https://{host_name}.com/learn/api/public/v1/oauth2/token
    5. Assurez-vous que l’élément suivant est saisi sous Étendue : write
    6. 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 en tant que clé de l’application lorsque vous configurez le client OAuth.
    7. 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 en tant que clé secrète lorsque vous configurez le client OAuth.
  7. Le bouton Activer la limitation du taux de demandes est activé. Laissez 60 pour Nombre de demandes et 1 minute pour Intervalle de temps.
  8. Le champ Délai d’expiration de la demande est défini sur 120 par défaut.
  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 Blackboard de la page Mes notes.

Procédez comme suit :

  1. Sur la page Intégrations de micro-apps, accédez à l’intégration Blackboard Learn 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 l’élément bouton Afficher sur Blackboard, 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}/webapps/bb-social-learning-BBLEARN/execute/mybb?cmd=display&toolId=MyGradesOnMyBb_____MyGradesTool

    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.

Procédez comme suit :

  1. Sur la page Intégrations de micro-apps, sélectionnez le menu en regard de l’intégration Blackboard Learn, 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 répertorié dans le tableau ci-dessous, vous devez modifier le type de données dans le menu correspondant à l’attribut donné.

    Point de terminaison Attribut Modification du type de données
    Annonces de cours Corps Binaire
    Notes de l’utilisateur Afficher le score Double
    Note Score possible Double
  3. Pour chaque point de terminaison, sélectionnez le menu en regard du point de terminaison, puis Modifier.
  4. 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.
  5. 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.
  6. Répétez cette opération 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.

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

Remarques

La limite de pagination est définie sur 100. Les administrateurs peuvent étendre cette limite jusqu’à 200 en fonction des API.

En raison de la limite des appels d’API, la synchronisation incrémentielle est configurée pour conserver uniquement les paramètres Membres de cours et Annonces de cours. Les points de terminaison restants seront déclenchés dans le cadre de la synchronisation complète.

Utiliser les micro-apps Blackboard Learn

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.

Remarque

Pour la micro-app Mes notes, un administrateur doit mettre à jour le paramètre host_name sur le bouton Afficher sur Blackboard de la page Mes notes. Pour obtenir les étapes complètes, consultez la section Configurer les paramètres d’action de service.

Inscription aux cours : permet de s’inscrire à un cours.

Notification ou Page Workflows de cas d’utilisation
Notification Inscription à un nouveau cours Lorsqu’un étudiant s’inscrit à un cours, l’étudiant inscrit reçoit une notification.
Page Détails de l’inscription aux cours Fournit une vue en lecture seule des cours auxquels l’étudiant est inscrit, y compris les détails sur les cours et les instructeurs.
Page Liste des cours Fournit une liste des cours disponibles.
Page Détails du cours Affiche les détails du cours et les détails de l’instructeur, y compris l’option Inscription rapide.

Créer une annonce de cours : permet aux instructeurs de créer 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.

Vue de l’instructeur : permet aux instructeurs d’afficher les membres du cours et leurs notes.

Notification ou Page Workflows de cas d’utilisation
Page Détails du cours Permet à l’instructeur d’afficher la liste des cours disponibles.
Page Détails sur les membres Permet à l’instructeur d’afficher la liste des membres inscrits à un cours.
Page Détails des notes Permet à l’instructeur d’afficher les notes de membres spécifiques inscrit à un cours.

Mes cours : permet d’afficher les annonces de cours et les pièces jointes d’un cours

Notification ou Page Workflows de cas d’utilisation
Notification Nouvelles annonces de cours Lorsqu’une nouvelle annonce est publiée, les étudiants inscrits au cours reçoivent une notification.
Page Détails de l’annonce du cours Fournit une vue en lecture seule des nouvelles annonces d’un cours et de ses détails correspondants.
Page Mes cours Fournit une liste des cours auxquels l’étudiant est inscrit.
Page Détails du cours Fournit une liste des annonces et des pièces jointes associées à un cours.
Page Détails de l’annonce Permet d’afficher une annonce de cours et ses détails correspondants.
Page Détails des pièces jointes Permet d’afficher et de télécharger la pièce jointe.

Mes notes : permet aux étudiants d’afficher les notes de cours.

Notification ou Page Workflows de cas d’utilisation
Notification Nouvelles notes Lorsqu’une nouvelle note est publiée, les étudiants inscrits au cours reçoivent une notification.
Page Mes notes Permet aux étudiants d’afficher les notes en sélectionnant le cours.