By: Kathleen Murphy, Manager, Learning Solutions
UPDATE End of Life Date: December 2024 release
The Homepage Widget Expansion Pack (HWEP) is a collection of widgets created by D2L Learning Services (formerly Learning and Creative Services). Widgets in the initial generation of the HWEP were delivered as custom widgets and referenced a centrally-hosted codebase. These widgets are known as Custom Hosted Widgets.
In January 2022, a subsequent generation of HWEP widgets was launched using Brightspace system widgets, but the original Custom Hosted versions of these widgets remained in service. Any client that purchased the original Custom Hosted widgets was automatically entitled to the system widget versions and encouraged to migrate.
The Custom Hosted Widgets are legacy technology and are now in end-of-life. Custom Hosted Widgets will be removed from client sites as part of the 24.12 Brightspace release.
What Widgets are Affected?
All Custom Hosted Widgets, with the exception of the K12 Calendar and K12 Footer widgets, have identical system widget equivalents and can be replaced with system widgets. These include:
- Visual Table of Contents Widget
- Welcome Window Widget
- Photo Banner Widget
- Learner Awards Widget
- Slim Announcements Widget
- Single Profile Card Widget
- Content Navigator Widget
Custom Hosted Widgets that will no longer be supported include:
The Multi-Profile Widget is the newest widget in the Homepage Widget Expansion Pack and was never released as a Custom Hosted Widget. It is not affected by the end-of-life and will continue to function normally as a system widget.
Why are we making this decision?
Removing the legacy Custom Hosted Widgets from client sites will simplify widget management for site administrators and instructors. The system widget versions of the widgets also offer many improvements including:
- Seamless and consistent updates.
- Improved load times.
- Improved widget configuration process.
- Improved language support.
- Support for Locale Management.
What is the impact?
Homepages that currently use Custom Hosted Widgets will function normally until the end-of-life date. After the end-of-life date, Custom Hosted Widgets will be automatically removed from homepages and uninstalled from client sites.
What about Custom Widgets?
LCS has also produced custom widgets that referenced code stored locally on the file systems of client sites. These widgets are client-owned and are not subject to the end-of-life.
Identifying Custom Hosted Widgets
Code Inspection
Look within the contents of the custom widget code. If the source code for the widget references cdn.lcs.brightspace.com you are currently using a Custom Hosted Widget. If the widget content reference files on the client file server, the widget is locally deployed and not affected by the end-of-life.
In-Widget Messaging
The December 2023 Brightspace release introduces in-widget end-of-life notifications. If a widget is displaying an end-of-life notice, the widget is a Custom Hosted Widget and is in end-of-life. These notifications only appear to users with the Edit Homepages permission in the course. If a user has the Edit Homepages permission at the top-level organization, the user will see a link to the Custom Hosted Widgets support page. The image below shows an in-widget end-of-life notification for the Visual Table of Contents Custom Hosted Widget. Replace this widget with its System Widget equivalent to remove the notification.
Using the Custom Hosted Widget support page
The December 2023 Brightspace release introduced the Custom Hosted Widget support page. If your site has one or more Custom Hosted Widgets installed, a notification will appear on the Homepages screen (refer to the image below) indicating that there are end-of-life Custom Hosted Widgets on your site. Users with the Edit Homepages permission at the top-level organization will see a link in the notification to Manage Legacy Widgets. Click the link to access the Custom Hosted Widget support page. On this this page you can:
- See a list of all Custom Hosted Widgets installed on the site and the number of homepages where the widget is used.
- Drill down to see the exact homepages where each widget is used.
Replacement strategy and options
To prepare for the end-of-life of each Custom Hosted Widget, these widgets must be deleted from homepages where they are in use or replaced with system equivalents on homepages where they are in use. Depending on your widget usage you may employ a manual or automatic replacement strategy.
Manual Replacement
Many clients have a small number of homepages using Custom Hosted Widgets and can manually replace Custom Hosted Widgets with system widgets. Clients in this situation can begin replacing widgets immediately. To learn how to manually replace Custom Hosted Widgets please read Homepage Widgets - Upgrading from the Hosted Widgets. Use the Custom Hosted Widgets support page to track the homepage usage and installation status of Custom Hosted widgets on your site as you replace or delete them.
Automatic Replacement
Some Brightspace clients have more homepages using Custom Hosted Widgets than could reasonably be replaced by hand. These clients may consider automatic replacement.
The 20.24.4 Brightspace release will introduce a new BETA feature called the Automated Replacement service to non-production sites. The Automated Replacement service will be added to the Custom Hosted Widgets support page and will allow users to:
- Bulk replace all instances a Custom Hosted Widgets on homepages with the system version. Custom data including text, images, and role settings will be automatically migrated. Once all homepage instances of the widget are replaced, the widget installation will be automatically removed from the site.
- Delete all instances a Custom Hosted Widgets on homepages and remove the widget from the site
Use the BETA release of the Automated Replacement service to plan your widget replacement project on your non-production sites.
The June 20.24.6 release will introduce the Automated Replacement service to production sites.
Timeline
September 2023/20.23.9: Communication about the intent to retire the Custom Hosted versions of widgets in the Homepage Widget Expansion Pack are published in the Release Notes Announcements. To provide clients with time to review, plan replacement options, and perform recommended actions, Custom Hosted Widgets will continue to function until the planned end-of-life date.
December 2023/20.23.12: Admins and instructors with Edit Homepage permissions will see an in-widget message about the end-of-life with instructions on recommended actions.
April 2024/20.24.4: The Automated Replacement service is added to Custom Hosted Widget support page on all non-production sites.
June 2024/20.24.6: The Automated Replacement service is added to Custom Hosted Widget support page on all production sites.
December 2024/20.24.12: All remaining Custom Hosted Widgets are automatically removed from homepages on client sites and the widgets are uninstalled from sites. HTTP requests to Custom Hosted Widget end-points deliver a 404 error.
