Introduction
Tokens are variables that can be inserted in standard messages within the Message Management module.
Applying Tokens to Messages
When adding tokens to messages, you need to remember the following conventions:
· The token name must be in uppercase.
· The token must be encased in [%%]. For example, [%FIRST_NAME%].
Token List
The list of message management tokens are shown below. For each group, the tokens are listed in alphabetical order.
Token information about Achievements
Token Name |
Description |
ACHIEVEMENT_CATEGORY |
|
ACHIEVEMENT_CLASS |
|
ACHIEVEMENT_DESCRIPTION |
|
ACHIEVEMENT_EXPIREDDATE |
|
ACHIEVEMENT_EXTERNALID |
|
ACHIEVEMENT_ISSUEDDATE |
|
ACHIEVEMENT_TITLE |
|
Tokens about Email Recipients
Token Name |
Description |
EMAIL_PRIMARY |
Displays the user’s primary email address. |
FIRST_NAME |
Displays the user’s first name. |
FULL_NAME |
|
LAST_NAME |
Displays the user’s first name. |
MANAGER_APPROVAL_COUNT |
|
MANAGER_EXTERNAL_APPROVAL_COUNT |
Displays the number of external course requests pending manager approval |
SUFFIX_NAME |
|
USER_HOME_ADDRESS1 |
Displays the first line of the user’s home address. |
USER_HOME_ADDRESS2 |
Displays the second line of the user’s home address. |
USER_HOME_CITY |
Displays the city where the user resides. |
USER_HOME_COMPANYNAME |
|
USER_HOME_COUNTRY |
Displays the country where the user resides. |
USER_HOME_FAX |
Displays the user’s home fax number. |
USER_HOME_LOCATION |
|
USER_HOME_PHONE1 |
Displays the user’s home telephone number. |
USER_HOME_PHONE2 |
|
USER_HOME_POSTALCODE |
Displays the postal code associated with the user’s home address. |
USER_HOME_PROVINCE |
Displays the province where the user lives. |
USER_HOME_REGION |
|
USER_MESSAGE_COUNT |
|
USER_NAME |
|
USER_PASS |
Displays the user's password. |
USER_TIMEZONE |
Displays the time zone of the user. |
USER_WORK_ADDRESS1 |
Displays the user’s primary work address. |
USER_WORK_ADDRESS2 |
Displays the user’s secondary work address. |
USER_WORK_CITY |
Displays the city where the user works. |
USER_WORK_COMPANYNAME |
Displays the name of the company where the user works. |
USER_WORK_COUNTRY |
Displays the country where the user works. |
USER_WORK_FAX |
Displays the user’s workplace fax number. |
USER_WORK_LOCATION |
Displays the user’s work location. |
USER_WORK_PHONE1 |
Displays the user’s primary work telephone number. |
USER_WORK_PHONE2 |
Displays the user’s secondary work telephone number. |
USER_WORK_POSTALCODE |
Displays the postal code in the user’s work address. |
USER_WORK_PROVINCE |
Displays the region specified in the user’s work address. |
USER_WORK_REGION |
Displays the region specified in the user’s work address. |
Tokens about a User References within the Email (not the Email Recipient)
Token Name |
Description |
AUX_HOME_ADDRESS1 |
|
AUX_HOME_ADDRESS2 |
|
AUX_HOME_CITY |
|
AUX_HOME_COMPANYNAME |
|
AUX_HOME_COUNTRY |
|
AUX_HOME_FAX |
|
AUX_HOME_LOCATION |
|
AUX_HOME_PHONE1 |
|
AUX_HOME_PHONE2 |
|
AUX_HOME_POSTALCODE |
|
AUX_HOME_PROVINCE |
|
AUX_HOME_REGION |
|
AUX_USER_EMAIL |
|
AUX_USER_FIRST_NAME |
|
AUX_USER_FULL_NAME |
|
AUX_USER_LAST_NAME |
|
AUX_USER_NAME |
|
AUX_USER_PASS |
|
AUX_USER_SUFFIX_NAME |
|
AUX_USER_TIMEZONE |
|
AUX_WORK_ADDRESS1 |
|
AUX_WORK_ADDRESS2 |
|
AUX_WORK_CITY |
|
AUX_WORK_COMPANYNAME |
|
AUX_WORK_COUNTRY |
|
AUX_WORK_FAX |
|
AUX_WORK_LOCATION |
|
AUX_WORK_PHONE1 |
|
AUX_WORK_PHONE2 |
|
AUX_WORK_POSTALCODE |
|
AUX_WORK_PROVINCE |
|
AUX_WORK_REGION |
|
Tokens for Courses
Token Name |
Description |
COURSE_CODE |
|
COURSE_COMPETENCY_AUTHORITY |
Displays the competency authority associated with the course. |
COURSE_CREDIT_HOURS |
Displays the number of credit hours assigned to the course. |
COURSE_DELIVERY_PROVIDER |
|
COURSE_INSTRUCTIONAL_MEDIA |
Displays the instructional media of the course. |
COURSE_NAME |
|
COURSE_PUBLISHER |
Displays the publisher associated with the course. |
COURSE_SUBJECT |
|
INQUIRIES |
Indicates any text entered for course inquiries. |
Tokens about Sessions
Token Name |
Description |
CURRENT_SESSION_ENROLLMENT |
|
SESSION_ADDITIONAL |
Displays any text entered in the Additional text box for the session. |
SESSION_ENDDATE |
Displays the end date of the session. |
SESSION_MAX_ENROLLMENT |
Displays the maximum enrollment specified for the session.
|
SESSION_MIN_ENROLLMENT |
Displays the minimum enrollment specified for the session. |
SESSION_STARTDATE |
Displays the start date of the session. |
SESSION_TIMEZONE_NAME |
Displays the time zone of the session. |
Tokens for the First Class of a Session
Token Name |
Description |
CLASS_ENDDATE (without time: 9/10/2005 ex.) |
|
CLASS_ENDDATETIME |
|
CLASS_ENDTIME (without date: 9:00:00 AM ex.) |
|
CLASS_ENDTIME_SESSION (without date: 9:00 AM ex.) |
|
CLASS_ENDTIME_USER (without date: 9:00 AM ex. In the users time zone + user's time zone name) |
|
CLASS_STARTDATE (without time: 9/10/2005 ex.) |
|
CLASS_STARTDATETIME |
|
CLASS_STARTTIME (without date: 9:00:00 AM ex.) |
|
CLASS_STARTTIME_SESSION (without date: 9:00 AM ex.) |
|
CLASS_STARTTIME_USER (without date: 9:00 AM ex. In the user's time zone) |
|
CLASS_STARTTIME_USER (without date: 9:00 AM ex. In the user's time zone) |
|
LOCATION_NAME |
|
REGION_NAME |
|
|
|
Tokens Shown in a Listing Format
Token Name |
Description |
COMMUNITY_MAX_LIST |
Displays the maximum session enrollment specified for the community. |
LEARNTRACK_NAME_LIST |
|
ORGANIZATIONALUNIT_NAME_LIST |
|
SESSION_CODE_LIST |
Displays the code assigned to the session. |
SESSION_PRESENTER_LIST |
|
SYSTEM_URL |
|
The community enrollment is a list that looks like the below:
(A community will only show up if there is at least 1 user registered within the community.)
Community A: A_Session_Community_Enrollment / A_Session_Community_Maximum
Community B: B_Session_Community_Enrollment / B_Session_Community_Maximum
Token Information about Travel
Token Name |
Description |
TRAVEL_ADDITIONAL |
|
TRAVEL_CHECKINDATE |
|
TRAVEL_CHECKOUTDATE |
|
TRAVEL_COMMENTS |
|
TRAVEL_HOTELNAME |
|
TRAVEL_MAPURL |
|
TRAVEL_OCCUPANCY |
|
TRAVEL_SMOKING |
|
Token Information about Bundles
Token Name |
Description |
BUNDLE_DATEEFFECTIVE |
|
BUNDLE_DATEEXPIRES |
|
BUNDLE_DESCRIPTION |
|
BUNDLE_EXTERNALID |
|
BUNDLE_NAME |
|
BUNDLE_REGDATE |
|
BUNDLE_TERMDATE |
|
BUNDLE_TIMEALLOTTED |
|
BUNDLE_TIMELEFT |
|
System Tokens
SYSTEM_URL
SYSTEM_EMAIL