Prerequisites: This plugin is not enabled by default. If you need it to be turned on, please contact our support team.
Summary: Use text in curly brackets to pull in information about your users or courses in the course text.
The personalisation filter is a plugin that filters text and replaces it with user-specific or course-specific information. This allows administrators and instructors to show different text to different people in the same course.
Below is an example of how a dashboard would typically look when logging into the LMS:
With the use of the personalisation filter, the dashboard could look like the below:
For example:
Hello {USER_FIRSTNAME}! Welcome to {COURSE_FULLNAME}!
This course starts on {COURSE_STARTDATE}.
After the course ends, your grade will be sent to {USER_MANAGER}.
Becomes:
Hello Dale! Welcome to Tibetan Meditation 101!
This course starts on November 1st, 2032.
After the course ends, your grade will be sent to Gordon Cole.
User fields
These fields apply to the user viewing the page.
|
{USER_USERNAME} |
The user’s username. |
|
{USER_IDNUMBER} |
The user’s ID number. |
|
{USER_EMAIL} |
The user’s email address. |
|
{USER_FIRSTNAME} |
The user’s first name. |
|
{USER_LASTNAME} |
The user’s last name. |
|
{USER_FULLNAME} |
The user’s full name. |
|
{USER_PHONE1} |
The user’s phone number (1). |
|
{USER_PHONE2} |
The user’s phone number (2). |
|
{USER_ADDRESS} |
The user’s address. |
|
{USER_CITY} |
The user’s city. |
|
{USER_COUNTRY} |
The user’s country. |
|
{USER_LASTLOGIN} |
The date and time the user last logged in. |
|
{USER_PICTURE} |
The user’s picture (HTML) |
|
{USER_AUDIENCE} |
The user’s audience. |
|
{USER_ORGANIZATION} |
The user’s organization. |
|
{USER_MANAGER} |
The user’s manager. |
|
{USER_POSITION} |
The user’s position. |
|
{USER_FIELD_[field shortname]} |
A custom field. |
How to add the personalisation filter to a dashboard
As mentioned, the personalisation filter can be added throughout the site and can pull from either the user's profile or the the course fields. Below is an example on how to add it to a HTML block on dashboard:
On the chosen dashboard, the first thing to do will be to turn editing on:
Next you will either need to add a new block if you are adding text (including personalisation) for the first time, or if you already have a block that you are editing, you just need to configure said block on the dashboard.
When editing the text, it might be the case that you have your text in white writing (like above) therefore, you may want to change the colour to black (so you can see your text) and then change it back to white before saving.
You can add user information in to this HTML block so that the user's first name appears when they log into the LMS. In order to do this, it would just be the case of adding {USER_FIRSTNAME} into the text:
Once saved and editing is turned off, you will end up with something like the below:
Note: If using multiple languages on blocks such as slider blocks you will need to add the personalisation filter to each translation.
Course fields
These fields apply to the current course being viewed.
|
{COURSE_FULLNAME} |
The course fullname. |
|
{COURSE_SHORTNAME} |
The course shortname. |
|
{COURSE_IDNUMBER} |
The course ID number. |
|
{COURSE_SUMMARY} |
The course summary. |
|
{COURSE_STARTDATE} |
The date and time the course starts. |
|
{COURSE_USER_ENROLDATE} |
The date and time the current user was enrolled in the course. |
|
{COURSE_USER_GRADE} |
The current user’s current course grade. |
|
{COURSE_USER_GROUP} |
The current user’s course group. Comma- separated if multiple. |
|
{COURSE_USER_GROUPING} |
The current user’s course grouping. Comma- separated if multiple. |
|
{COURSE_USER_ROLE} |
The current user’s role in the course. Comma- separated if multiple. |
|
{COURSE_MANAGER_FULLNAME} {COURSE_COURSECREATOR_FULLNAME} {COURSE_EDITINGTEACHER_FULLNAME} {COURSE_TEACHER_FULLNAME} |
The current full name of all users assigned to that role. Comma-separated if multiple. |
|
{COURSE_MANAGER_EMAIL} {COURSE_COURSECREATOR_EMAIL} {COURSE_EDITINGTEACHER_EMAIL} {COURSE_TEACHER_EMAIL} |
The current email address of users assigned to that role. Comma-separated if multiple. |
How to add the personalisation filter to a course page
Like with a dashboard, you are able to make your course pages more personalised to the learner by either including information about the user or the course page that they are currently on.
Below is an example of how the Course Introduction block typically looks on a course page:
With the Personalisation filter added, it can be tailored to the end user:
To achieve this, the personalisation filter again can be added to the HTML block. However, in this example, it will be added to the Course Introduction Block.
To get to the the text that sits within the Introduction block, you will need to edit the course settings under the course admin block:
Once within the settings it will be the course summary that can be edited to include the personalisation. In this example, we will include the users first name ({USER_FIRSTNAME}) and the course name ({COURSE_FULLNAME}) this demonstrates using a combination of both.
Our summary could go from this:
To this:
Which will then display on the course page to the user, like the below: