Homepage Widget Expansion Pack configuration variables are used for each System Widget included in the Homepage Widget Expansion Pack (HWEP). These configuration variables are now available to system administrators.
Homepage Widget Expansion Pack configuration variables have the following format: d2l.Custom.LCSWidgets.[WidgetName].ContextOverride. This format enables you to change contextual information pieces, such as role definitions directly from the configuration variable and replaces the need to edit the code of custom widgets. The Learner Awards, Multi-Profile, Slim Announcements, and Welcome Window widgets use this configuration variable to link the widget's permissions to different system roles using a JavaScript string. The rest of the HWEP widgets also have this configuration variable, but they do not currently use it. Refer to the table below for the available variables.
The following table indicates the configuration variables used to edit the individual permissions of all HWEP widgets.
| Widget |
Variable |
Type |
Default Value |
Description |
Example Value |
|---|
| Content Navigator Widget |
d2l.Custom.LCSWidgets.ContentNavigator.ContextOverride
|
Org
|
null
|
Override the context for the Content Navigator Widget.
|
Currently is not in use. |
| Learner Awards Widget |
d2l.Custom.LCSWidgets.LearnerAwards.ContextOverride
|
Org
|
null
|
Override the context for the Learner Awards Widget.
Note: The widget identifies roles listed in the “learner” array as learners (or consumers) of the widget. If an award is set to be hidden until earned, it is not visible to learners who have not yet earned it.
|
var roleDefinitions = { "learner": [ "Role1", "Role2" ] }; |
| Photo Banner Widget |
d2l.Custom.LCSWidgets.PhotoBanner.ContextOverride
|
Org
|
null
|
Override the context for the Photo Banner Widget.
|
Currently is not in use. |
| Multi-Profile Widget |
d2l.Custom.LCSWidgets.Profiles.ContextOverride
|
Org
|
null
|
Override the context for the Multi-Profile Widget.
The widget recognizes roles included in the “administrator” array as administrators of the widget and roles included in the “instructor” array as instructors of the widget. Administrators have access to all the widget's configuration options in the context menu inside of the widget. Instructors only have access to the Update User Settings option in the context menu inside of the widget.
|
var roleDefinitions = { "administrator": [ "Role1", "Role2" ], "instructor": [ "Role1", "Role2" ] }; |
| Single Profile Card Widget |
d2l.Custom.LCSWidgets.SingleProfile.ContextOverride
|
Org
|
null
|
Override the context for the Single Profile Widget.
|
Currently is not in use. |
| Slim Announcements Widget |
d2l.Custom.LCSWidgets.SlimAnnouncements.ContextOverride
|
Org
|
null
|
Override the context for the Slim Announcements Widget.
The widget recognizes the roles included in the “moderator” array as moderators of the widget. Moderators are presented with a link to create a new announcement inside the Announcements tool.
|
var roleDefinitions = { "moderator": [ "Role1", "Role2" ] }; |
| Visual Table of Contents Widget |
d2l.Custom.LCSWidgets.VisualTOC.ContextOverride
|
Org
|
null
|
Override the context for the Visual Table of Contents Widget.
|
Currently is not in use. |
| Welcome Widget |
d2l.Custom.LCSWidgets.WelcomeWindow.ContextOverride
|
Org
|
null
|
Override the context for the Welcome Widget.
The widget recognizes the roles included in the “editor” array as editors of the widget. Editors can view the default content, which explains how to set up content for the widget if it has not been configured yet in the current Org Unit.
|
var roleDefinitions = { "editor": ["Role1", "Role2" ] }; |