Creating a Custom Certificate: Course Certificate Variables

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

Course Variables for Course Certificates

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. 

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. 

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. 

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:

iltLocation

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

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. 

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. 

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:

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. 

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:

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

Licensing Variables for Course Certificates

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.

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:

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.

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:

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.