Creating a Custom Certificate: Course Certificate Variables
  • 9 Minutes to read
  • Dark
    Light

Creating a Custom Certificate: Course Certificate Variables

  • Dark
    Light

Article Summary

This page details the course and licensing variables that you can include when you create a custom certificate.

Course Variables for Course Certificates

If you attempt to include a variable that is not applicable to the certificate, it will be replaced with a blank space. For example, if you include the variable instructorList on an online course's certificate, it will be replaced with a blank.

The following course variables may be added to a custom course completion certificate.

certificateID

A certificate identifier. This is unique to the learner and the enrollment. If a learner takes a course multiple times, each completion certificate will have a different certificate ID.

CF_<CustomFieldName>

The value of a custom field. You will need to replace <CustomFieldName> with the name of the custom field and all spaces and special characters in the name with an underscore (_). Dates will be in the format DD-MMM-YYYY.

For example, suppose you have a custom user field named Hire Date and the learner's hire date was January 2, 2018. Including the CF_Hire_Date variable would display 02-Jan-2018 on the course completion certificate. 

All dates are in English only, regardless of the language set for the account or user.

completeDay

The day of the month the learner completed the course in the format DD. For example, for the date September 9, 2017, the completeDay would display 09.

completeMonth

The month the learner completed the course in the format MMMM. For example, for the date September 9, 2017, the completeMonth would display September. 

All dates are in English only, regardless of the language set for the account or user.

completeYear

The year that the learner completed the course in the format YYYY. For example, for the date September 9, 2017, the completeYear would display 2017.

courseGrade

The learner's grade for the course.

courseID

The course identifier.

courseName

The name of the course.

courseProvider

The name of the course provider (i.e., the account's name).

dateCompleted

The date the learner completed the course in the format DD-MMM-YYYY. For example, for the date February 15, 2017, the dateCompleted would display 15-Feb-2017. 

All dates are in English only, regardless of the language set for the account or user.

dateCompleted_<MonthsToAdd>

The date the course completion expires in DD-MMM-YYYY format.

You will need to replace <MonthsToAdd> with the number of months to add to the course completion date. The allowed values are 3, 6, 9, 12, 24, 36, 48, and 60.

For example, suppose the learner's course completion date is February 5, 2018:

Variable

Resulting Value on Certificate

dateCompleted_3

05-May-2018

dateCompleted_6

05-Aug-2018

dateCompleted_12

05-Feb-2019

dateCompleted_60

05-Feb-2023

All dates are in English only, regardless of the language set for the account or user.

iltLocation

The location of an instructor-led course session. The value displayed depends on the session type.

Session TypeData Displayed

Venue

Venue Name - Room Name - Room Location (if provided)

Webinar

If the webinar has a provider, "Webinar - ProviderName" displays; otherwise, "Webinar - Other" displays.

Other

Text provided in the Other setting of the session

instructor<n>

The course instructors listed in the order that they were added; internal instructors will be listed before external instructors. This variable is only applicable to instructor-led courses. 

You will need to replace <n> with a number.

Refer to the Course Variables Example: Instructor section for an example.

instructorTitle<n>

The titles of the course instructors. This variable is only applicable to instructor-led courses. 

You will need to replace <n> with a number. The titles will be sorted in the same order as their associated instructor (i.e., instructor<n>). 

Refer to the Course Variables Example: Instructor section for an example.

instructorList

The course instructors separated by commas in the order that they were added. This variable is only applicable to instructor-led courses. 

Refer to the Course Variables Example: Instructor section for an example.

PT_Total_Points

The total value of all point trackers associated with the course

Refer to the Course Variables Example: PT section for an example.

PT_<PointTrackerName>

The value of the point tracker associated with the course. You will need to replace <PointTrackerName> with the name of your point tracker. You should replace all spaces and special characters in the point tracker name with an underscore (_).

This variable is useful when you only want to include a specific point tracker on the certificate. Refer to the Course Variables Example: PT section for an example.

To display the total number of points of all point trackers associated with the course, use the PT_Total_Points variable

This variable only displays data when the licensing feature is disabled for the account. If the licensing feature is enabled for your account, this variable will not display data. For a list of variables available to accounts with the licensing feature enabled, refer to Licensing Variables for Course Certificates.

PT_<PointTrackerName>_Label

The name of the point tracker associated with the course. You will need to replace <PointTrackerName> with the name of your point tracker. You should replace all spaces and special characters in the point tracker name with an underscore (_).

This variable is useful when you only want to include a specific point tracker on the certificate. Refer to the Course Variables Example: PT section for an example.

To display the total number of points of all point trackers associated with the course, use the PT_Total_Points variable

This variable only displays data when the licensing feature is disabled for the account. If the licensing feature is enabled for your account, this variable will not display data. For a list of variables available to accounts with the licensing feature enabled, refer to Licensing Variables for Course Certificates.

recipientDivision

The learner's division.

recipientEmployeeID

The learner's employee ID.

recipientHomeGroup

The learner's home group.

recipientName

The learner's given name and surname.

recipientOrganization

The learner's organization.

recipientTitle

The learner's title.

Course Variables Example: Instructor

To illustrate how the instructor course variables work suppose a course's instructors are:

Instructor Name

Instructor Title

Type

Dana Brown

Retail Director

Internal

James Lee

HR Director

Internal

Elise Landon

 

External

Peter Brown

HR Specialist

Internal

The grid below illustrates the resulting values for the various instructor variables. Remember that instructors are listed in the order that they were added and that internal instructors are listed before external instructors. 

Variable

Resulting Value 

instructor1

instructorTitle1

Dana Brown

Retail Director

instructor2

instructorTitle2

James Lee

HR Director

instructor3

instructorTitle3

Peter Brown

HR Specialist

instructor4

instructorTitle4

Elise Landon

instructorList

Dana Brown, James Lee, Peter Brown, Elise Landon

Course Variables Example: PT 

To illustrate how the PT course variables work when licensing is disabled, suppose the user's point tracker information for a course is as follows:

Point Tracker Name

Points Earned

Fina Product Pro

15

Customer Champion

10

The grid below illustrates the resulting values for the various PT variables.

Variable

Resulting Value

PT_Customer_Champion_Label

PT_Customer_Champion

Customer Champion

10

PT_Fina_Product_Pro_Label

PT_Fina_Product_Pro

Fina Product Pro

15

PT_Total_Points

25

If licensing is enabled, refer to the Licensing Variables Example: PT section for an example.

Licensing Variables for Course Certificates

  • The variables listed below are only available for course certificates when the licensing feature is enabled for the account.
  • If you attempt to include a variable that is not applicable to the certificate, it will be replaced with a blank space. For example, if you include the variable instructorList on an online course's certificate, it will be replaced with a blank.

The following licensing variables may be added to a custom course completion certificate.

Licensing_User_<n>_Agency

A list of the user's assigned agencies. The agencies will be sorted in the same order as their associated licensing areas (i.e., Licensing_User_<n>_Area). 

You will need to replace <n> with a number. Refer to the Licensing Variables Example: Licensing_User section for an example.

Licensing_User_<n>_Area

An alphabetical list of the user's assigned licensing areas.

You will need to replace <n> with a number. Refer to the Licensing Variables Example: Licensing_User section for an example.

Licensing_User_<n>_License_Expiry

A list of the user's license expiration dates in the format DD-MMM-YYYY. The license expiration dates are listed in the same order as their associated licensing areas (i.e., Licensing_User_<n>_Area). 

You will need to replace <n> with a number. Refer to the Licensing Variables Example: Licensing_User section for an example.

All dates are in English only, regardless of the language set for the account or user.

Licensing_User_<n>_License_Notes

A list of notes associated with the user's license. The notes are listed in the same order as their associated licensing areas (i.e., Licensing_User_<n>_Area). 

You will need to replace <n> with a number. Refer to the Licensing Variables Example: Licensing_User section for an example.

Licensing_User_<n>_License_Number

A list of the user's assigned license numbers. The license numbers will be sorted in the same order as their associated licensing areas (i.e., Licensing_User_<n>_Area). 

You will need to replace <n> with a number. Refer to the Licensing Variables Example: Licensing_User section for an example.

Licensing_User_<n>_License_Type

A list of the user's assigned license types. The license types will be sorted in the same order as their associated licensing areas (i.e., Licensing_User_<n>_Area). 

You will need to replace <n> with a number. Refer to the Licensing Variables Example: Licensing_User section for an example.

Licensing_User_<n>_Region

A list of the user's assigned regions. The regions will be sorted in the same order as their associated licensing areas (i.e., Licensing_User_<n>_Area).

You will need to replace <n> with a number. Refer to the Licensing Variables Example: Licensing_User section for an example.

PT_<n>_Label

An alphabetical list of all point trackers associated with the course.

You will need to replace <n> with a number. The point tracker information will be listed in alphabetical order by point tracker name. Refer to the Licensing Variables Example: PT section for an example. 

PT_<n>_Points

The values of all point trackers associated with the course. The points will be sorted in the same order as their associated label (i.e., PT_<n>_Label). 

You will need to replace <n> with a number. The point tracker information will be listed in alphabetical order by point tracker name. Refer to the Licensing Variables Example: PT section for an example. 

PT_Category_<n>_Label

An alphabetical list of all licensing categories associated with the course.

You will need to replace <n> with a number. The categories will be listed in alphabetical order by category name. Refer to the Licensing Variables Example: PT section for an example.

PT_Category_<n>_Points

The total number of points for the licensing category. The points will be sorted in the same order as their associated label (i.e., PT_Category_<n>_Label). 

You will need to replace <n> with a number. The values will be listed in alphabetical order by category name. Refer to the Licensing Variables Example: PT section for an example. 

PT_Category_<n>_Reference

The reference IDs associated with the licensing category. The reference IDs will be sorted in the same order as their associated category label (i.e., PT_Category_<n>_Label). 

You will need to replace <n> with a number. The values will be listed in alphabetical order by category name. Refer to the Licensing Variables Example: PT section for an example.

PT_Category_List 

An alphabetical, comma-delimited list of all licensing categories associated with the course

PT_Total_Licensing_Points

The total of all licensing point trackers associated with the course. Licensing point trackers are point trackers associated with an area, region, and agency.

PT_Total_Points

The total value of all point trackers associated with the course.

Licensing Variables Example: Licensing_User 

To illustrate how the Licensing_User variables work, suppose the user's licensing information is as follows:

Agency

Type

Area

Region

Expiration

Notes

Number

Agency of HR Professionals

Senior HR Professional

USA

NY

July 1, 2018

License valid for two years

304920

Agency of Financial Management

Bookkeeping Professional

Canada

Manitoba

December 31, 2018

 

469601

The grid below illustrates the resulting values for the various Licensing_User variables. Remember that the values will be listed in alphabetical order by licensing area.

Variable

Resulting Value

Licensing_User_1_Agency

Licensing_User_1_Area

Licensing_User_1_License_Expiry

Licensing_User_1_License_Notes

Licensing_User_1_License_Number

Licensing_User_1_License_Type

Licensing_User_1_License_Region

Agency of Financial Management

Canada

31-Dec-2018

 

469601

Bookkeeping Professional

Manitoba

Licensing_User_2_Agency

Licensing_User_2_Area

Licensing_User_2_License_Expiry

Licensing_User_2_License_Notes

Licensing_User_2_License_Number

Licensing_User_2_License_Type

Licensing_User_2_License_Region

Agency of HR Professionals

USA

01-Jul-2018

License valid for two years

304920

Senior HR Professional

NY

Licensing Variables Example: PT

To illustrate how the PT variables work when licensing is enabled, suppose the user's point tracker information for the Accounting 101 course is as follows:

Point Tracker Name

Points Earned

License Category

License Reference ID

Fina Financial Professional

10

Accounting Principles

150957-2

Business Management

5

Accounting

61-09995

Federal Taxation

15

 

 

The grid below illustrates the resulting values for the various PT variables. Remember that the values will be listed in alphabetical order by point tracker name. 

Variable

Resulting Value

PT_1_Label
PT_1_Points
PT_Category_1_Label

PT_Category_1_Points

PT_Category_1_Reference

Business Management

5

Accounting

5

61-09995

PT_2_Label
PT_2_Points
PT_Category_2_Label

PT_Category_2_Points

PT_Category_2_Reference

Federal Taxation

15

PT_3_Label
PT_3_Points
PT_Category_3_Label

PT_Category_3_Points

PT_Category_3_Reference

Fina Financial Professional

10

Accounting Principles

10

150957-2

PT_Category_List

Accounting, Accounting Principles

PT_Total_Licensing_Points

15

PT_Total_Points

30

If licensing is disabled, refer to the Course Variables Example: PT section for an example.

Was this article helpful?