Introduction
This document describes the variables that are available for use in emails sent to the participant.
The general form of using a variable is to use enclose the variable name in the form ${name}. So if a variable is named example it would be used in a template written like this: ${example}.
Variables that are written like this someVariable are variables that works but are strongly discouraged to be used anymore. They are likely replaced with a better alternative.
The mail templates support default values. A default value can be used when a variable is undefined.
Use :- after the variable to specify a default value. Given ${name:-Happy User} the text Happy User will be the output if the variable name is not specified.
Participant email
Description
A participant mail is sent when a user is activated or a reminder is sent. It usually contains information about the user, course and where the user should go to access the platform.
Variables
|
Name |
Description |
Example |
|
projectName |
The title shown to participants. |
Induction Program |
|
projectDescription |
The project description from the course design |
Welcome to your learning experience. This program will help you focus energy into purposeful action, assist in solutions to persistent problems, and improve overall performance. The assignments on this page will help you make the most out of the face-to-face learning session, and ultimately increase your ability to achieve your goals and aspirations. |
|
locale |
The user's preferred locale |
en_US |
|
usersite |
A url to the generic login page where a user can login. The page will contain a login form. |
https://yourdomain.learnifier.com/ |
|
loginsite |
The first part of a participation login link |
|
|
orgname |
The name of the client |
Acme Inc. |
|
linkid |
The participation specific part of a participation login link |
|
|
name |
The user's full name (both first and last name) |
Jane Doe |
|
firstName |
The user's first name (given name) |
Jane |
|
givenName |
The user's first name. Please use firstName instead |
Jane |
|
lastName |
The user's last name (surname) |
Doe |
|
surname |
The user's last name. Please us lastName instead |
Doe |
|
userid |
The numerical user id. Can be used for referencing a specific user. |
132819 |
|
partid |
The participation id. Can be used for referencing a specific user's participation id. |
10921679 |
|
|
The user's primary email |
jane.doe@example.com |
|
loginlink |
A raw url link to a participation login link. In most scenarios accesslink is a better choice. |
http://yourdomain.learnifier.com/l/fdslfjdskfsjdl |
|
accesslink |
A link with associated html code to make it clickable |
<a href="http://yourdomain.learnifier.com/l/fdslfjdskfsjdl">http:// yourdomain.learnifier.com/l/fdslfjdskfsjdl</a> |
Comments
0 comments
Please sign in to leave a comment.