Introduction
This document describes the variables that are available for use in emails sent to project team members or instructors using the automated communication function.
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.
Introduction
All variables starting with participant are variables that output values related to WHO the rule was communication rules was matched for, not the recipient (who is the project team members or instructors).
So if a communication is setup to send a message to the project team when a participant has completed a certain activity, ${participantName} refer to the participant, not Sarah.
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. |
|
projectAdministrativeName |
The administrative project name. This is the name visible in the client portal |
Induction Program for Sales People Q1 2019. |
|
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. |
|
name |
The recipient's full name (both first and last name) |
Irene Instructor |
|
firstName |
The recipient's first name (given name) |
Irene |
|
lastName |
The recipient's last name (surname) |
Instructor |
|
userid |
The numerical user id. Can be used for referencing a specific user. |
132819 |
|
|
The recipient's primary email |
irene.instructor@example.com |
|
participantName |
The participant's full name (both first and last name) |
Jane Doe |
|
participantFirstName |
The user's first name (given name) |
Jane |
|
participantLastName |
The participant's last name (surname) |
Doe |
|
participantUserid |
The numerical user id. Can be used for referencing a specific user. |
132819 |
|
participantEmail |
The participant's primary email |
jane.doe@example.com |
|
date.short date.medium date.long date.full |
The current date in different date formats. The format is taken from the project |
1/1/19 2019-01-01 Tuesday January 1 2019 |
|
datetime.short datetime.medium datetime.long datetime.full |
The current date and time in different date formats. The format is taken from the project |
1/1/19 3:00PM 2019-01-01 15:00 3 o'clock Tuesday January 1 2019 |
Comments
0 comments
Please sign in to leave a comment.