Het Homepage Widget Expansion Pack biedt een reeks systeemwidgets voor startpagina’s om meer een leerervaring op maat aan te bieden voor uw startpagina's.
Belangrijk: het aangepaste Hosted Homepage Widget Expansion Pack wordt in september 2024 (20.24.9) buiten gebruik genomen. Clients kunnen de gehoste versies van de widget tot die datum blijven gebruiken, maar worden niet langer ondersteund door Desire2Learn®. Clients die de verouderde gehoste versies van widgets gebruiken, moeten upgraden naar de nieuwe Brightspace® System-widgets.
De volgende aangepaste gehoste widgets worden vervangen door systeemwidgets:
- Widget Visuele inhoudsopgave
- Widget Welkomstvenster
- Widget Fotobanner
- Widget Beloningen cursist
- Widget Korte aankondigingen
- De widget Profiel voor één kaart
- Widget Inhoud navigeren
De volgende aangepaste gehoste widgets worden niet langer ondersteund:
Opmerking: de widget Meerdere profielen is onderdeel van de Homepage Widget Expansion Pack en blijft zoals normaal functioneren als een systeemwidget.
Als u momenteel een aangepaste gehoste widget beschikbaar hebt in uw Brightspace®-instantie, wordt een nieuwe systeemwidgetversie van dezelfde widget toegevoegd aan uw instantie.
Controleer of uw widgets moeten worden vervangen
Als u de machtiging Startpagina's maken/bewerken hebt, wordt een waarschuwingsbericht weergegeven op alle aangepaste gehoste widgets die actief zijn op de startpagina in de volgende indeling: 'Actie vereist: widgetupdate: deze widget wordt binnenkort niet meer ondersteund. Ga voor automatische ondersteuning om deze widget te vervangen naar de HWEP EOL-ondersteuningsservice.'
Afbeelding: gebruik de berichtenservice in de widget (bijvoorbeeld in de widget Visuele inhoudsopgave) om naar de HWEP EOL-ondersteuningsservice te navigeren.
Opmerking: een vergelijkbare waarschuwing verschijnt ook op de pagina van de tool Beheer startpagina als er aangepaste gehoste versies van widgets actief zijn in de omgeving. Klik op deze waarschuwing om naar de pagina Service voor automatische vervanging van aangepaste widgets te navigeren.
Vanuit de pagina Service voor automatische vervanging van aangepaste widgets kunt u het volgende doen:
- Een lijst controleren met alle aangepaste gehoste widgets en het aantal startpagina's waarop de widget actief is.
- De exacte locaties vinden waarin elke widget actief is door op een getal in de desbetreffende rij van de kolom Startpagina's met verouderde widgets te klikken.
Afbeelding: gebruik de pagina Service voor automatische vervanging van aangepaste widgets voor het zoeken, vervangen of verwijderen van aangepaste gehoste widgets.
Voor meer informatie over hoe u kunt bepalen welke verouderde widgets u gebruikt en hoe u het buiten gebruik stellen van het Homepage Widget Expansion Pack in uw omgeving kunt plannen, raadpleegt u Upgraden vanuit de gehoste widgets.
Opmerking: een functie voor geautomatiseerde vervanging wordt op een later moment toegevoegd.
De service Aangepaste gehoste widgets vervangen gebruiken
De service Aangepaste gehoste widgets vervangen maakt deel uit van de pagina Aangepaste gehoste widget (EOL-ondersteuning Aangepaste gehoste widget). Met de vervangingsservice kunt u:
- Alle instanties van de aangepaste gehoste widget in bulk vervangen door de systeemversie (configuraties worden automatisch gemigreerd).
- Alle instanties van de aangepaste gehoste widget in bulk verwijderen.
Uw site voorbereiden
Houd rekening met het volgende om een soepele vervanging van aangepaste gehoste widgets te ondersteunen:
-
Zorg ervoor dat niemand aangepaste gehoste widgets aan startpagina's kan toevoegen terwijl de service actief is: informeer het team dat aangepaste gehoste widgets niet langer zijn toegestaan of wijzig tijdelijk de bewerkingsmachtigingen voor startpagina’s voor relevante rollen.
-
Zorg ervoor dat voor elke aangepaste gehoste widget de bijbehorende systeemwidget is ingeschakeld voor uw instantie en dat de systeemwidgettool is geactiveerd voor uw organisatie. Desire2Learn® heeft automatisch rechten voor equivalenten van systeemwidgets toegewezen aan alle klanten die gebruikmaken van aangepaste gehoste HWEP-widgets.
-
Plan om uw widget-vervangingen uit te voeren tijdens daluren. Aangepaste gehoste en systeemwidgets hebben kleine variaties die gebruikers kunnen afleiden als ze plotseling worden gewijzigd.
Waarschuwing: houd er bij het plannen van black-outperioden rekening mee dat widgets een cacheduur van twee minuten hebben. Nadat de migratie is voltooid, worden widgets mogelijk pas als gemigreerd weergegeven als deze periode van twee minuten is verstreken.
De service Aangepaste gehoste widgets vervangen uitvoeren
Waarschuwing: automatische vervangingen kunnen niet automatisch worden teruggedraaid. U kunt acties die door de vervangingsservice zijn uitgevoerd, alleen terugdraaien door de wijzigingen handmatig ongedaan te maken.
De service Aangepaste gehoste widgets vervangen uitvoeren
- Ga naar de pagina Aangepaste gehoste widget.
- Selecteer een widget die u wilt vervangen. De service kan slechts op één aangepaste gehoste widget tegelijk worden toegepast en deze widget moet aan het einde van de levenscyclus zijn. Dit geldt voor alle HWEP-widgets behalve de widget Meerdere profielen.
Opmerking: de vervangingsservice kan niet worden uitgevoerd voor aangepaste gehoste widgets zonder analoge systeemwidgets. Dit geldt voor de K12-agenda en de K12-voettekst.
- Klik op Vervangen naast de widget.
Afbeelding: Klik op Vervangen om de service voor vervanging van aangepaste gehoste widgets uit te voeren.
De vervangingsservice wordt uitgevoerd als achtergrondtaak op de Brightspace®-site.
Opmerking: als u probeert de vervangingsservice uit te voeren op een widget terwijl deze al bezig is voor dezelfde widget, wordt de laatste poging niet voortgezet.
U kunt de pagina Aangepaste gehoste widgets verlaten zonder de vervangingsservice te onderbreken.
Na voltooiing, wordt een melding verzonden naar het gedeelte Updatewaarschuwingen (weergegeven door het belpictogram) op de hoofdnavigatiebalk van Brightspace®. Als er een probleem optreedt bij de vervangingsservice, bevat de melding een foutcode. Klik op de melding om naar de pagina Aangepaste gehoste widgets te gaan voor meer informatie over de foutcode.
Raadpleeg de onderstaande lijst met foutcodes voor meer informatie.
| Code |
Definitie |
Oplossing |
|---|
| x001 |
De aangepaste widget die u probeert te vervangen, heeft geen equivalente systeemwidget. |
Dien een ondersteuningsticket in. |
| x002 |
Configuratiebestanden die aan deze widget zijn gekoppeld, kunnen niet worden gemigreerd. |
Dien een ondersteuningsticket in. |
| x003 |
Er is een probleem opgetreden bij het migreren van de roldefinitie van de vroegst geïnstalleerde aangepaste widget op organisatieniveau. |
Dien een ondersteuningsticket in. |
| x004 |
Deze widget is door een gebruiker aan een startpagina toegevoegd terwijl de vervangingsservice actief was. |
Start de vervangingsservice voor deze aangepaste widget opnieuw. |
| x005 |
Deze widget kan niet worden vervangen. |
Dien een ondersteuningsticket in. |
| x006 |
Er is een probleem opgetreden. De analoge systeemwidget voor deze aangepaste widget heeft geen rechten. |
Dien een ondersteuningsticket in. |
| x007 |
Een andere gebruiker voert momenteel het vervangingsproces voor deze widget uit. |
Start de service opnieuw nadat de huidige uitvoering is voltooid (indien nodig). |
| x008 |
Aangepaste titels die aan deze widget zijn gekoppeld, kunnen niet worden gemigreerd. |
Dien een ondersteuningsticket in. |
Overzicht van acties en overwegingen voor de vervangingsservice
Rechten en toolstatus bevestigen
De vervangingsservice controleert of de systeemversie van de widget is ingeschakeld voor de instantie en controleert of de systeemwidget is geactiveerd in Organisatietools:
- Als de vervangingsservice ontdekt dat de systeemwidget niet is ingeschakeld op instantieniveau, wordt deze afgesloten en wordt de gebruiker hiervan op de hoogte gesteld.
- Als de vervangingsservice ontdekt dat de systeemwidget niet is ingeschakeld bij Organisatietools, wordt de widget geactiveerd op organisatieniveau en gaat de service door.
- Als de widget niet actief is op een onderliggende organisatie-eenheid, gaat de vervangingsservice verder alsof de widget actief is voor die organisatie-eenheid en wordt de widget vervangen. De vervangen widget wordt als inactief weergegeven op de startpagina totdat de eigenaar van de startpagina de widget voor die organisatie-eenheid activeert.
Alle betrokken startpagina's en cursussen catalogiseren
De vervangingsservice scant de site op alle instanties van de widget op startpagina's en identificeert alle cursussen die startpagina's gebruiken met deze widget. Op bepaalde sites is de widget mogelijk per ongeluk meerdere keren geïnstalleerd. In deze gevallen selecteert de service de widget-installatie op organisatieniveau met de vroegste installatiedatum als canonieke versie. In de meeste gevallen zijn secundaire installaties identiek aan de oorspronkelijke installatie van de organisatie, waardoor deze strategie onschadelijk is. Er zijn echter speciale gevallen, geïdentificeerd door databasequery’s, waarbij secundaire installaties op een bepaalde manier zijn aangepast. Deze aangepaste secundaire installaties moeten handmatig worden beheerd voordat de vervangingsservice wordt uitgevoerd. Desire2Learn® heeft rechtstreeks contact opgenomen met dergelijke klanten.
Configuratiebestanden migreren
Aangepaste gehoste widgets hebben een standaard config.txt op organisatieniveau. De vervangingsservice controleert of deze config.txt van de organisatie al is gemigreerd naar Widgetgegevens voor de organisatie en voert de migratie uit als dit nog niet is gebeurd.
Aangepaste gehoste widgets maken gebruik van een combinatie van lokaal opgeslagen config.txt-bestanden en extern opgeslagen widgetgegevens om configuraties op te slaan voor elk cursusgeval van een widget. Met deze benadering kan een widget uniek zijn in elke cursus.
Systeemwidgets gebruiken uitsluitend Widgetgegevens voor gegevensopslag. De migratie kan alleen slagen als de service gegevens van config.txt-bestanden overbrengt naar Widgetgegevens. Met behulp van de catalogus betrokken cursussen leest de vervangingsservice de gegevens uit het config.txt-bestand van elke cursus en worden deze gekopieerd naar de specifieke widgetgegevens voor die cursus.
De volgende gevallen zijn mogelijk:
- Als de lokale config.txt identiek is aan de gegevens die al zijn opgeslagen in de widgetgegevens van de organisatie, wordt de lokale configuratie als redundant beschouwd en wordt deze niet gemigreerd. Aangepaste configuraties kunnen in de toekomst naar behoefte worden toegevoegd. Oudere config.txt-bestanden worden niet uit het bestandssysteem verwijderd; ze worden ter plaatse bewaard als back-up voor het geval de vervangingsservice mislukt.
- Als het config.txt-bestand ontbreekt op organisatieniveau, worden configuraties van alle cursusniveaus gemigreerd.
- Als een cursus een configuratie heeft die zowel in Widgetgegevens als in een config.txt-bestand aanwezig is, houdt de vervangingsservice de versie in Widgetgegevens en worden de config.txt-gegevens genegeerd. Hoewel dit scenario onwaarschijnlijk is, kan het gebeuren als in een cursus zowel de systeem- als aangepaste versies van een widget worden gebruikt. Als de JSON in het config.txt-bestand niet kan worden gelezen of het bestand zelf onleesbaar is, wordt de configuratie niet gemigreerd. Als dit gebeurt in het geval van een configuratie op cursusniveau, neemt de widget de configuratie over die is opgeslagen in de organisatie.
Opmerking: configuraties voor gerecyclede cursussen worden niet gemigreerd.
Rolconfiguraties migreren
De widgets Beloningen cursist, Korte aankondigingen en Welkomstvenster hebben roldefinities. Roldefinities zijn een koppeling tussen de rollen die beschikbaar zijn in de widget, zoals cursist of moderator, en de rollen die zijn gedefinieerd in Brightspace®. Voor aangepaste gehoste widgets worden deze definities opgeslagen als een JavaScript-variabele in het inhoudsveld van de aangepaste widget. Voor systeemwidgets worden roldefinities opgeslagen in een configuratievariabele die specifiek is voor elke widget.
Opmerking: voor aangepaste gehoste widgets kunnen roldefinities alleen per widget-installatie worden gedefinieerd, niet per organisatie-eenheid.
Hieronder vindt u een voorbeeld van roldefinities:
var roleDefinitions = {
"administrator": [
"D2LAdmin"
],
"moderator": [
"D2LAdmin",
"Superbeheerder",
"Instructeur"
],
"instructor": [],
"learner": []
};
De vervangingsservice scant het inhoudsveld van de widget, extraheert de roldefinitie en slaat deze op in de juiste configuratievariabele van de organisatie voor die widget.
Als het JavaScript-object dat de roldefinitie definieert niet geldig is, wordt de bijbehorende roldefinitie niet gemigreerd.
In gevallen waarin een widget meerdere keren op een site is geïnstalleerd, gebruikt de vervangingsservice de roldefinities van de widget-installatie op organisatieniveau met de vroegste installatiedatum als canonieke roldefinities voor de site. Er is een databasezoekactie voor alle rolconfiguraties uitgevoerd om ervoor te zorgen dat er geen sites zijn met verschillende roldefinities voor meerdere installaties.
Titel van widget en aangepaste titels migreren
De vervangingsservice probeert aangepaste namen te migreren die horen bij de aangepaste gehoste widget, inclusief naam van aangepaste widget, vervanging van naam van aangepaste widget en vervanging van naam van startpagina-widget:
| Titeltype |
Brightspace®-UI |
Locatie |
Bewerking |
|---|
| Veld Naam aangepaste widget |
 Afbeelding: Het veld Naam.
|
Klik op het pictogram Bewerken naast de naam van de widget > Eigenschappen van aangepaste widget > Naam. |
De vervanging wordt toegepast op de organisatie-eenheid waar de widget is geïnstalleerd, mits er geen bestaande vervanging voor de naam van de aangepaste widget is voor de systeemwidget. De vervangingsservice gebruikt de naam van de laatst gemaakte widget. |
| Naam aangepaste widget vervangen |
 Afbeelding: De selectievakjes van Widgetinstellingen en de keuzerondjes van Widgetnaam.
|
Klik op het pictogram Aanpassen naast de naam van de widget > Widgetinstellingen > Widgetnaam > selecteer Aangepast. |
Indien aanwezig, wordt deze toegepast als een extra vervanging voor de organisatie-eenheid waar de widget is geïnstalleerd. De widget neemt de naam over van de laatst gemaakte vervanging. |
| Naam van startpaginawidget vervangen |
Afbeelding: De selectievakjes van Widgetinstellingen en de keuzerondjes van Widgetnaam.
|
Klik op Deze widget vormgeven op een willekeurige startpagina > Widgetinstellingen > Widgetnaam > selecteer Aangepast. |
Indien aanwezig, wordt deze vervanging ook toegepast op de startpagina. De widget neemt de naam over van de laatst gemaakte vervanging.
Opmerking: de widget geeft prioriteit aan de vervanging van de naam van de startpaginawidget boven een andere naam.
|
De aangepaste gehoste widget vervangen
Alle systeemwidgets en alle aangepaste widgets hebben een unieke id. Widgets worden aan startpagina's toegevoegd door naar deze id's te verwijzen. Als u een aangepaste widget op een startpagina wilt vervangen, werkt de vervangingsservice de startpaginarecord bij om de id van de bijbehorende systeemwidget te gebruiken. Met deze actie wordt de oude aangepaste widget verwijdert en de systeemwidget toegevoegd. De nieuw toegevoegde systeemwidget werkt hetzelfde als de oude aangepaste widget, omdat de configuratie en rollen van de widget vooraf zijn gemigreerd.
Cursussen worden niet rechtstreeks gewijzigd. Individuele cursussen worden alleen beïnvloed als een startpagina die ze gebruiken wordt bijgewerkt.
De aangepaste gehoste widget verwijderen
In de laatste fase wordt de widget van de site verwijderd om toekomstig gebruik op startpagina's te voorkomen. Binnen de database wordt de widget verwijderd uit de lijst met aangepaste widgets, waarbij alle aangepaste inhoud wordt verwijderd die eerder is opgeslagen in het inhoudsveld van de widget. Dit komt overeen met het gebruik van de functie Verwijderen in het venster Aangepaste widgets van de pagina Widgets beheren.
Waarschuwing: als een gebruiker een widget aan een startpagina heeft toegevoegd terwijl de vervangingsservice wordt uitgevoerd, wordt de bewerking van de service voltooid, maar wordt de widget niet verwijderd. In plaats daarvan wordt er een melding naar de gebruiker verzonden. In dat geval moet de vervangingsservice opnieuw worden uitgevoerd om de onlangs toegevoegde widget te verwijderen. Raadpleeg het gedeelte De service Aangepaste gehoste widgets vervangen uitvoeren.
Zodra de widget van de site is verwijderd, is deze niet meer beschikbaar voor gebruik op startpagina's. Aangezien de vervangingsservice startpagina's bijwerkt maar geen cursussen, betekent dit dat gerecyclede, verwijderde en inactieve cursussen ook worden beïnvloed, ook al zijn ze niet beschikbaar voor gebruikers.