Creating a Custom Certificate: Certification Certificate Variables
  • 6 Minutes to read
  • Dark
    Light

Creating a Custom Certificate: Certification Certificate Variables

  • Dark
    Light

Article Summary

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

Certification Variables for Certification Certificates

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

certificateID

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

certificationName

The name of the certification that this certificate is being generated for.

certificationProvider

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

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 certification 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 certification in the format DD. For example, for the date September 9, 2017, the completeDay would display 09.

completeMonth

The month the learner completed the certification 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 the learner completed the certification in the format YYYY. For example, for the date September 9, 2017, the completeYear would display 2017.

dateCompleted

The date the learner completed the certification 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>

A calculated date that's based on the certification's completion date. 

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

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

VariableResulting 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.

dateExpiration

The date the certification expires in DD-MMM-YYYY format. For example, for the date December 31, 2018, the dateExpiration would display 31-Dec-2018. 

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

expiresDay

The day of the month the certification expires in the format DD. For example, for the date December 31, 2018, the expiresDay would display 31.

expiresMonth

The month the certification expires in the format MMMM. For example, for the date December 31, 2018, the expiresMonth would display December. 

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

expiresYear

The year the certification expires in the format YYYY. For example, for the date December 31, 2018, the expiresYear would display 2018.

PT_<PointTrackerName>_Label

The name of a specific point tracker that is assigned to one of the certification's courses. 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 Certification Variables Example: PT section for an example.

To display the total number of points of all point trackers associated with all of the certification's courses, 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 Certification Certificates.

PT_<PointTrackerName>_Points

The points earned for a specific point tracker that is assigned to one of the certification's courses. 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 Certification Variables Example: PT section for an example.

To display the total number of points of all point trackers associated with all of the certification's courses, 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 Certification Certificates.

PT_Total_Points

The total value of all point trackers associated with the certification's courses. 

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

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.

Certification Variables Example: PT

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

Point Tracker NamePoints Earned

Fina Product Pro

15

Customer Champion

10

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

VariableResulting Value

PT_Customer_Champion_Label

PT_Customer_Champion_Points

Customer Champion

10

PT_Fina_Product_Pro_Label

PT_Fina_Product_Pro_Points

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 Certification Certificates

The variables listed below are only available for certification certificates when the licensing feature is enabled for the account.

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

Cert_Licensing_Agency

The licensing agency associated with the certification.

Cert_Licensing_Area

The area associated with the certification

Cert_Licensing_License_Type

The license type associated with the certification.

Cert_Licensing_Region

The region associated with the certification.

Cert_Licensing_User_License_Expiry

The expiration date of the user's license associated with the certification's license information in the format DD-MMM-YYYY. For example, for the date December 31, 2018, the Cert_Licensing_User_License_Expiry would display 31-Dec-2018. 

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

Cert_Licensing_User_License_Notes

The user's license notes associated with the certification's license information.

Cert_Licensing_User_License_Number

The user's license number associated with the certification's license information.

Course_Name_List

An alphabetical, comma-delimited list of courses associated with the certification.

PT_Category_<n>_Label

An alphabetical list of all licensing categories associated with the certification's courses.

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 certification's courses.

PT_Total_Licensing_Points

The total of all licensing point trackers associated with the certification's courses. Licensing point trackers are point trackers associated with an area, region, and agency. 

PT_Total_Points

The sum of all point trackers associated with the certification's courses.

Licensing Variables Example: PT

To illustrate how the PT variables work when licensing is enabled, suppose the following point trackers are associated with the Accounting 101 course that's part of the Financial Management certification:

Point TrackerPointsLicense CategoryReference 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_Category variables. Remember that the PT_Category variables are listed in alphabetical order by license category name.

VariableResulting Variable on Certificate

PT_Category_1_Label

PT_Category_1_Points

PT_Category_1_Reference

Accounting

5

61-09995

PT_Category_2_Label

PT_Category_2_Points

PT_Category_2_Reference

Accounting Principles

10

150957-2

PT_Category_3_Label

PT_Category_3_Points

PT_Category_3_Reference

This would not return any values since Federal Taxation is not used for licensing.

PT_Category_List

Accounting, Accounting Principles

PT_Total_Licensing_Points

15

PT_Total_Points

30


Was this article helpful?