Le progiciel d’extension du composant graphique de la page Accueil offre divers composants graphiques de page d’accueil pour vous permettre de créer une expérience d’apprentissage plus personnalisée pour vos pages d’accueil.
Important : le progiciel d'extension du composant graphique spécial spécial Page d'accueil sera retiré en septembre 2024/20.24.9. Les clients peuvent continuer à utiliser les versions hébergées du composant graphique jusqu’à cette date, mais elles ne sont plus prises en charge par D2L. Les clients qui utilisent des composants graphiques spéciaux hébergés doivent effectuer une mise à niveau vers les nouveaux composants graphiques du système Brightspace.
Voici les composants graphiques spéciaux hébergés qui seront remplacés par des composants graphiques du système :
- Composant graphique Table de matières visuelle
- Composant graphique de la fenêtre d’accueil
- Composant graphique Bannière de photo
- Composant graphique Récompenses pour les élèves
- Composant graphique Nouvelles simplifiées
- Composant graphique Carte de profil unique
- Composant graphique de navigateur de contenu
Voici les composants graphiques spéciaux hébergés qui ne seront plus pris en charge :
- Calendrier K12
- Pieds de page K12
Remarque : le composant graphique Multiprofil fait partie du progiciel d'extension du composant graphique Page d'accueil et continuera de fonctionner normalement comme composant graphique système.
Si vous avez actuellement un composant graphique spécial hébergé dans votre instance Brightspace, une nouvelle version du composant graphique système de ce même composant graphique est ajoutée à votre instance.
Vérifiez si vos composants graphiques doivent être remplacés
Si vous disposez de l'autorisation Créer/modifier la page d’accueil, une mise en garde s'affiche dans tous les composants graphiques spéciaux hébergés actifs sur la page d'accueil dans le format suivant : « Action requise : mise à jour du composant graphique : la prise en charge de ce composant est terminée. Pour obtenir un soutien automatisé pour remplacer ce composant graphique, visitez le service de soutien de fin de vie HWEP. »
Figure : utilisez le service de messagerie du composant graphique (par exemple, dans le composant graphique Table des matières visuelle) pour accéder au service de soutien de fin de vie HWEP.
Remarque : Une mise en garde similaire s’affiche également à la page d’accueil de l'outil Gestion s'il existe des composants graphiques spéciaux hébergés actifs dans l'environnement. Cliquez sur cette mise en garde pour accéder à la page Service de remplacement automatisé de composants graphiques spéciaux.
À la page Service de remplacement automatisé de composants graphiques spéciaux, vous pouvez effectuer ce qui suit :
- Vérifier la liste de tous les composants graphiques spéciaux hébergés et le nombre de pages d’accueil sur laquelle ils sont actifs.
- Repérer l'emplacement exact où chaque composant graphique est actif en cliquant sur le chiffre correspondant à la ligne de la colonne Pages d’accueil utilisant d’anciens composants graphiques.
Figure : Accédez à la page Service de remplacement automatisé de composants graphiques spéciaux pour localiser, remplacer ou supprimer des composants graphiques spéciaux hébergés.
Pour plus d’informations sur la manière d’identifier les anciens composants graphiques que vous utilisez et de planifier le retrait du Progiciel d’extension du composant graphique de la page Accueil de votre environnement, reportez-vous à la section Mise à niveau des composants graphiques hébergés.
Remarque : la fonction de remplacement automatique sera ajoutée à une date ultérieure.
Utilisation du Service de remplacement de composants graphiques spéciaux hébergés
Le Service de remplacement de composants graphiques personnalisés hébergés fait partie de la page Composant graphique spécial hébergé (Soutien de fin de vie d’un composant graphique spécial hébergé). Le service de remplacement vous permet de :
- Remplacer en bloc toutes les instances du composant graphique spécial hébergé par la version du système (les configurations sont migrées automatiquement).
- Supprimer en bloc toutes les instances du composant graphique spécial hébergé.
Préparer votre site
Pour assurer un remplacement en douceur des composants graphiques spéciaux hébergés, tenez compte des éléments suivants :
-
Assurez-vous que personne n'est en mesure d'ajouter des composants graphiques spéciaux hébergés sur les pages d’accueil lorsque le service est actif : annoncez à l'équipe que les composants graphiques spéciaux hébergés ne sont plus autorisés ou modifiez temporairement les autorisations relatives à la modification des pages d’accueil des rôles concernés.
-
Assurez-vous que le composant graphique système correspondant à chaque composant graphique spécial hébergé est activé pour votre instance et que l'outil composant graphique système est activé pour votre organisation. D2L a automatiquement fourni des autorisations pour les composants graphiques système équivalents à tous les clients à l'aide des composants graphiques spéciaux hébergés HWEP.
-
Planifiez d'effectuer le remplacement de vos composants graphiques en dehors des périodes de pointe. Les composants graphiques spéciaux hébergés et les composants graphiques système comportent des variations mineures qui peuvent distraire les utilisateurs s'ils sont remplacés soudainement.
Mise en garde : Lorsque vous planifiez des périodes d'interdiction, considérez que les composants graphiques ont une durée de mémoire cache de deux minutes. Une fois la migration terminée, il se peut que les composants graphiques n'apparaissent pas immédiatement comme étant migrés tant que cette période de deux minutes n'est pas terminée.
Exécuter le Service de remplacement de composants graphiques spéciaux hébergés
Avertissement : Les remplacements automatisés ne peuvent pas être annulés automatiquement. Pour annuler les actions effectuées par le service de remplacement, vous devez annuler manuellement les modifications apportées.
Marche à suivre pour exécuter le Service de remplacement de composants graphiques spéciaux hébergés
- Accédez à la page Composant graphique spécial hébergé.
- Sélectionnez le composant graphique que vous voulez remplacer. Le service ne peut être exécuté que sur un seul composant graphique spécial hébergé à la fois, et ce dernier doit être à son stade de fin de vie. Cela comprend tous les composants graphiques HWEP, sauf le composant graphique Multiprofil.
Remarque : Le service de remplacement ne peut pas être exécuté sur des composants graphiques spéciaux hébergés qui n'ont pas de composant graphique système analogue. Cela comprend le Calendrier K12 et le Pied de page K12.
- Cliquez sur l’option Remplacer à côté du composant graphique.
Figure : Cliquez sur Remplacer pour exécuter le Service de remplacement de composants graphiques spéciaux hébergés.
Le service de remplacement s'exécute en arrière-plan sur le site Brightspace.
Remarque : Si vous essayez d'exécuter le service de remplacement sur un composant graphique qui est déjà en cours de traitement, la dernière tentative ne sera pas exécutée.
Vous pouvez quitter la page Composants graphiques spéciaux hébergés sans interrompre le service de remplacement.
Une fois exécuté, le service de remplacement publie une notification dans la section Alertes de mise à jour (icône de cloche) de la barre de navigation principale de Brightspace. Si le service de remplacement rencontre un problème, la notification comprend un code d'erreur. Cliquez sur la notification pour accéder à la page Composants graphiques spéciaux hébergés et consulter les détails sur le code d'erreur.
Pour en savoir plus, reportez-vous à la liste des codes d'erreur ci-dessous.
Code |
Définition |
Solution |
---|
x001 |
Le composant graphique spécial que vous tentez de remplacer ne comporte pas de composant graphique système équivalent. |
Veuillez soumettre un ticket d’assistance technique. |
x002 |
Les fichiers de configuration associés à ce composant graphique n'ont pas pu être migrés. |
Veuillez soumettre un ticket d’assistance technique. |
x003 |
Un problème est survenu lors de la migration de la définition du rôle du composant graphique spécial installé au niveau de l'organisation. |
Veuillez soumettre un ticket d’assistance technique. |
x004 |
Un utilisateur a ajouté ce composant graphique à une page d'accueil alors que le service de remplacement était en cours d'exécution. |
Exécutez de nouveau le service de remplacement pour ce composant graphique spécial. |
x005 |
Ce composant graphique n'a pas pu être remplacé. |
Veuillez soumettre un ticket d’assistance technique. |
x006 |
Un problème est survenu. Le composant graphique analogique du système pour ce composant graphique spécial n'est pas admissible. |
Veuillez soumettre un ticket d’assistance technique. |
x007 |
Un autre utilisateur exécute actuellement le processus de remplacement pour ce composant graphique. |
Relancez le service à la fin de l'exécution en cours (si nécessaire). |
x008 |
Les titres personnalisés associés à ce composant graphique n'ont pas pu être migrés. |
Veuillez soumettre un ticket d’assistance technique. |
Aperçu des actions et des considérations relatives au service de remplacement
Confirmer l'admissibilité et l'état de l'outil
Le service de remplacement vérifie que la version système du composant graphique est activée pour l'instance concernée et vérifie si le composant graphique système est activé dans les Outils de l'organisation :
- Si le service de remplacement découvre que le composant graphique système n'est pas activé au niveau de l'instance, il se ferme et envoie une notification à l'utilisateur.
- Si le service de remplacement découvre que le composant graphique système n'est pas activé dans les Outils de l'organisation, il active le composant graphique au niveau de l'organisation et continue le traitement.
- Si le composant graphique n'est pas actif dans toute unité organisationnelle secondaire, le service de remplacement s’exécute comme si le composant graphique est actif pour cette unité organisationnelle et remplace le composant graphique. Le composant graphique remplacé paraît inactif à la page d’accueil jusqu'à ce que le propriétaire de la page d’accueil l’active pour cette unité organisationnelle.
Cataloguer toutes les pages d'accueil et les cours concernés
Le service de remplacement recherche toutes les instances du composant graphique dans les pages d’accueil du site et identifie tous les cours dont la page d’accueil utilise ce composant graphique. Sur certains sites, le composant graphique peut avoir été installé plusieurs fois par erreur. Dans ce cas, le service sélectionne l'installation du composant graphique au niveau de l'organisation et utilise la date d'installation la plus ancienne comme version canonique. Dans la plupart des cas, les installations secondaires sont identiques à l'installation initiale de l'organisation; cette stratégie est donc sans risque. Cependant, dans de rares cas identifiés par des requêtes dans la base de données, les installations secondaires ont été personnalisées d'une certaine façon. Ces installations secondaires personnalisées doivent être gérées manuellement avant d'exécuter le service de remplacement. D2L a directement communiqué avec ces clients.
Migration des fichiers de configuration
Les composants graphiques spéciaux hébergés ont la valeur par défaut config.txt au niveau de l'organisation. Le service de remplacement vérifie si cette organisation config.txt a déjà été migrée vers les données du composant graphique de l'organisation et effectue la migration si elle n'a pas encore été effectuée.
Les composants graphiques spéciaux hébergés utilisent une combinaison de fichiers config.txt stockés localement et de données de composant graphique stockées à distance pour enregistrer les configurations de chaque cours d'un composant graphique. Cette approche permet à un composant graphique d'être unique dans chaque cours.
Les composants graphiques du système utilisent exclusivement les données du composant graphique pour le stockage des données. Pour que la migration soit réussie, le service doit transférer les données des fichiers config.txt dans les données du composant graphique. À l'aide de son catalogue des cours concernés, le service de remplacement lit les données du fichier config.txt de chaque cours et les copie dans les données du composant graphique propres à ce cours.
Les cas suivants sont possibles :
- Si la version locale config.txt est identique aux données déjà stockées dans les données du composant graphique de l'organisation, la configuration locale est considérée comme redondante et n'est pas migrée. Des configurations personnalisées peuvent être ajoutées ultérieurement, au besoin. Les fichiers config.txt de l’ancien système ne sont pas supprimés du système de fichiers; ils sont conservés sur le site en tant que sauvegarde en cas d'échec du service de remplacement.
- Si le fichier config.txt est manquant au niveau de l'organisation, les configurations de tous les niveaux de cours sont migrées.
- Si un cours comporte une configuration dans les données du composant graphique et dans un fichier config.txt, le service de remplacement conserve la version des données de composant graphique et élimine les données config.txt. Bien que ce scénario soit peu probable, cela peut se produire si, dans un cours, le composant graphique spécial et le composant graphique du système sont tous deux utilisées. Si le JSON intégré dans le fichier config.txt ne peut pas être lu ou si le fichier lui-même est illisible, la configuration n'est pas migrée. Si cela se produit dans le cas d'une configuration au niveau du cours, le composant graphique hérite de la configuration stockée dans l'organisation.
Remarque : Les configurations des cours recyclés ne sont pas migrées.
Migration des configurations de rôles
Les composants graphiques Récompenses de l’élève, Annonces simplifiées et Fenêtre d'accueil ont des définitions de rôle. La définition de rôle est une mise en correspondance entre les rôles offerts dans le composant graphique, comme apprenant ou modérateur, et les rôles définis dans Brightspace. Pour les composants graphiques spéciaux hébergés, ces définitions sont stockées en tant que variable JavaScript dans le champ de contenu du composant graphique spécial. Pour les composants graphiques du système, les définitions de rôle sont stockées dans une variable de configuration propre à chaque composant graphique.
Remarque : Pour les composants graphiques spéciaux hébergés, les définitions des rôles peuvent uniquement être définies lors de l’installation du composant graphique, et non par l’unité organisationnelle.
Voici un exemple de définitions de rôle :
var roleDefinitions = {
"administrator": [
"D2LAdmin"
],
"moderator": [
"D2LAdmin",
"Super Administrator",
"Instructor"
],
"instructor": [],
"learner": []
};
Le service de remplacement balaie le champ de contenu du composant graphique, extrait la définition du rôle et l'enregistre dans la variable de configuration de l'organisation appropriée pour ce composant graphique.
Si l'objet JavaScript définissant la définition de rôle n'est pas valide, la définition de rôle correspondante n'est pas migrée.
Dans les cas où un composant graphique a été installé plusieurs fois sur un site, le service de remplacement utilise les définitions de rôle de l'installation effectuée au niveau de l'organisation et la date d'installation la plus ancienne comme définition de rôle canonique pour le site. Une recherche dans la base de données de toutes les configurations de rôles a été effectuée pour s'assurer que les sites n’ont pas des définitions de rôles divergentes dans plusieurs installations.
Migration du titre du composant graphique et des titres personnalisés
Le service de remplacement tente de migrer le nom personnalisé associé au composant graphique spécial hébergé, y compris le nom du composant graphique spécial, le nom prioritaire du composant graphique spécial et le nom prioritaire du composant graphique Page d’accueil :
Type de titre |
UI Brightspace |
Emplacement |
Opération |
---|
Champ Nom du composant graphique spécial |
Figure : Le champ Nom.
|
Cliquez sur l'icône de modification à côté du nom du composant graphique > Propriétés du composant graphique spécial > Nom. |
La priorité est appliquée à l’endroit où le composant graphique est installé dans l'unité organisationnelle, dans la mesure où aucune priorité n'est appliquée sur le nom du composant graphique spécial pour le composant graphique du système. Le service de remplacement adopte le nom du composant graphique créé le plus récemment. |
Nom prioritaire du composant graphique spécial |
Figure : Les cases à cocher Paramètres du composant graphique et les boutons radio Nom du composant graphique.
|
Cliquez sur l'icône de personnalisation à côté du nom du composant graphique, sélectionnez Propriétés du composant graphique, Nom du composant graphique, puis Personnalisé. |
Le cas échéant, le nom est défini comme priorité additionnelle là où le composant graphique est installé dans l'unité organisationnelle. Le composant graphique adopte le nom de la dernière priorité créée. |
Nom prioritaire du composant graphique Page d'accueil |
Figure : Les cases à cocher Paramètres du composant graphique et les boutons radio Nom du composant graphique.
|
Sélectionnez l’option Styliser ce composant graphique sur n'importe quelle page d'accueil, puis cliquez sur Paramètres du composant graphique, sur Nom du composant graphique, puis sur Personnalisé. |
Le cas échéant, cette priorité additionnelle est appliquée à la page d'accueil. Le composant graphique adopte le nom de la dernière priorité créée.
Remarque : Le composant graphique accorde la priorité au Nom prioritaire du composant graphique Page d'accueil plutôt qu’à tout autre nom.
|
Remplacement du composant graphique spécial hébergé
Tous les composants graphiques du système et tous les composants graphiques spéciaux ont un ID unique. Les composants graphiques sont ajoutés aux pages d’accueil en se référant à ces ID. Pour remplacer un composant graphique spécial sur une page d'accueil, le service de remplacement met à jour le dossier de la page d'accueil de sorte à utiliser l'ID du composant graphique système correspondant. Cette action supprime l'ancien composant graphique spécial et ajoute le composant graphique système. Le composant graphique système nouvellement ajouté fonctionne de la même façon que l'ancien composant graphique spécial, car sa configuration et ses rôles ont été migrés au préalable.
Les cours ne sont pas directement modifiés. Les cours individuels ne sont touchés que si leur page d’accueil connexe est mise à jour.
Désinstallation d'un composant graphique spécial hébergé
À l'étape finale, le composant graphique est désinstallé du site pour empêcher son utilisation future sur les pages d'accueil. Dans la base de données, le composant graphique est supprimé de la liste des composants graphiques spéciaux, ce qui supprime tout le contenu personnalisé précédemment stocké dans le champ de contenu du composant graphique. Cela équivaut à utiliser la fonction Supprimer dans le volet Composants graphiques spéciaux de la page Gérer les composants graphiques.
Avertissement : Si un utilisateur ajoute un composant graphique sur une page d'accueil pendant que le service de remplacement est en cours d'exécution, le service termine sa tâche, mais ne désinstalle pas le composant graphique. Une notification est plutôt envoyée à l'utilisateur. Dans ce cas, le service de remplacement doit être exécuté de nouveau pour supprimer le composant graphique récemment ajouté. Reportez-vous à la section Exécuter le Service de remplacement de composants graphiques spéciaux hébergés.
Une fois le composant graphique désinstallé du site, il ne peut plus être utilisé sur les pages d'accueil. Puisque le service de remplacement effectue une mise à jour des pages d’accueil, mais pas des cours, cela signifie que les cours recyclés, supprimés et inactifs sont également touchés, même s'ils ne sont pas accessibles aux utilisateurs.