Assessment Player Templates
Templates for the assessment player in authoring are used to configure the regions, and label bundle (and any other properties you wish to pass) of the assessment player.
There are three preconfigured regions based presets, and custom ones can be created, by:
- Passing an array of objects to the initialization option activity_edit.player_templates.
- Using the Template builder feature in the UI - turned on by setting activity_edit.player_template_builder.show to
true,
(available from Author API v2021.3.LTS).
Custom templates via initialization options
Assessment Player Templates
As above, custom assessment player templates can be provided via the init option activity_edit.player_templates.
Note: Selecting one of the options updates the JSON (in Source tab). The provided assessment player template reference will be saved in the Activity metadata and used to "select" the assessment player template in the list when loading Activities. If the assessment player template is not passed in the init options for some reason, but was previously selected for an Activity, the assessment player template's configuration data will still show in the source, but no template will be selected in the list.
Default Assessment Player Template
To change the default selected assessment player template when a new Activity is created, use the init option activity_edit.default_player_template.
Enabled Assessment Player Templates
To only show custom assessment player templates, or only one of the defaults for example, you can pass an array of assessment player template references to the following init option: activity_edit.enabled_player_templates.
Examples
Example Preconfigured Assessment Player Templates list:
The example code below shows configuring a new assessment player template, which defines a custom Regions object, a label bundle to show the assessment player text in German, and configuration to only show one of the standard assessment player templates, and the newly defined custom assessment player template in the list.
"enabled_player_templates": [
"e883731f-6fb8-43b3-992b-14f53cdf8350",
"some-unique-reference"
],
"default_player_template": "some-unique-reference",
"player_templates": [
{
"reference": "some-unique-reference",
"name": "Regions with German Label Bundle",
"regions": {
"top-left": [
{
"type": "title_element"
},
{
"type": "timer_element",
"countdown_option": true
}
],
"left": [
{
"type": "save_button"
},
{
"type": "fullscreen_button"
},
{
"type": "separator_element"
},
{
"type": "accessibility_button"
},
{
"type": "calculator_button"
},
{
"type": "verticaltoc_element"
},
{
"type": "masking_button"
},
{
"type": "next_button"
},
{
"type": "previous_button"
}
],
"items": [
{
"type": "slider_element",
"scrollable_option": false,
"warning_on_change_option": false
},
{
"type": "progress_element"
}
],
"bottom-right": [
{ "type": "next_button" },
{
"type": "previous_button"
},
{
"type": "pause_button",
"position": "right"
},
{
"type": "itemcount_element"
}
]
},
"labelBundle": {
"accessibility": "Zugänglichkeit",
"assessmentTimeExpired": "Die Zeit ist abgelaufen.",
"calculator": "Taschenrechner",
"close": "schließen",
"configuration": "Konfiguration",
"confirm": "Ja",
"contactAdministrator": "Kontakt",
"continue": "Fortsetzen",
"decline": "Nein",
"elapsedTime": "Verstrichen",
"fullScreen": "Vollbild",
"introItemMessage": "Drücken sie 'Start', wenn Sie bereit sind",
"nextButtonLabel": "Nächster",
"pause": "Pause",
"play": "Abspielen",
"previousButtonLabel": "Bisherige",
"quit": "Verlassen",
"reachedLastItem": "Das ist das ende.",
"save": "Speichern",
"saveButtonLabel": "Speichern",
"saveInProgress": "Speichern...",
"saving": "Speichern..",
"startTest": "Beginne die Bewertung",
"submit": "Einreichen",
"submitButtonLabel": "Einreichen",
"testPaused": "Pausiert"
}
}
],
Custom assessment player templates via template builder
Assessment player template storage
Assessment player templates created via the UI are stored in Learnosity's databases when the Activity is saved, and can be reused across Activities being created.
Creating an assessment player template
Assessment player template creation can be enabled by setting the init option activity_edit.player_template_builder.show to true.
Note: as well as enabling creation, this init option also gives the ability to edit and delete templates, so it should only be enabled for users who need it.
After enabling, users will be able to see the "Create" button under the assessment player template list:
Upon clicking create, the builder will load the following screen:
All elements are show in the left menu, split into either assigned or unassigned elements.
Elements can be moved into position by either:
- Clicking and dragging (either from the left menu, or from the template itself),
- Clicking an element once, then clicking into a region to drop, or
- Navigating the screen using tab/Shift-Tab, and selecting and dropping an element using Enter.
When an element is selected or being dragged, the regions will become greyed out if the element cannot be part of that region.
Label bundles can be set via the assessment player template builder UI and other properties can be set via the "Source" tab.
Some elements have additional configuration options, which are shown in the left panel, as below:
After naming the assessment player template, clicking "Apply" will add the assessment player template to the list, copy the settings into the current Activity's JSON, and close the window.
The Activity must be saved for the new template to be saved into the database.
Using assessment player templates
After assessment player templates have been created, they will appear, and can be used, by all users of that organization. As above, only those with the init option set will be able to edit/delete assessment player templates.
Assessment player templates will automatically be loaded and shown in the assessment player template list, as in the above picture.
Selecting an assessment player template will do the following:
- Copy all settings configured in the template into the Activity's source JSON.
- Remove any keys set by the currently selected assessment player template.
Changing assessment player templates for an Activity will discard any player settings defined in the earlier assessment player template and add in the configurations from the newly selected assessment player template including configurations defined for label bundles.
Note: Activities are not explicitly linked to assessment player templates - selecting an assessment player template copies the assessment player template data to the Activity source JSON and stores the metadata so it can be highlighted in the list. If the assessment player template is updated however, existing Activities will not be updated.
Editing an assessment player template
When an assessment player template is selected, the "Edit" button will show next to the assessment player template name.
Editing an assessment player template will update the JSON of the current Activity, but not update the JSON of other Activities which were created using the older version of this assessment player template.
The Activity must be saved for the assessment player template changes to be saved into the database. It is recommended that you preview that assessment player template being created in the player tab of the Activity.
Deleting an assessment player template
Hovering over the row will also show the "Delete" button (which turns to a confirmation button when pressed):
Deleting an assessment player template will remove properties which were set by this assessment player template from the JSON of the current Activity, but not update the JSON of other Activities which were created using this assessment player template.
The Activity must be saved for the assessment player template to be removed from the database.