--- title: "Creating a Custom Certificate: Course Certificate Variables" slug: "creating-a-custom-certificate-course-certificate-variables" tags: ["certificates"] updated: 2024-05-22T16:03:28Z published: 2024-05-22T16:03:28Z canonical: "support.smarteru.com/creating-a-custom-certificate-course-certificate-variables" --- > ## Documentation Index > Fetch the complete documentation index at: https://support.smarteru.com/llms.txt > Use this file to discover all available pages before exploring further. # 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](/v1/docs/creating-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_ The value of a custom field. You will need to replace 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](/v1/docs/account-custom-user-fields) 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_ The date the course completion expires in DD-MMM-YYYY format. You will need to replace 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](/v1/docs/instructor-led-session-main#session-type). | **Session Type** | **Data 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 The course instructors listed in the order that they were added; [internal instructors](/v1/docs/instructor-led-session-session-details#internal-instructors) will be listed before [external instructors](/v1/docs/instructor-led-session-session-details#external-instructors). This variable is only applicable to instructor-led courses. You will need to replace with a number. Refer to the [Course Variables Example: Instructor](/v1/docs/creating-a-custom-certificate-course-certificate-variables#course-variables-example-instructor) section for an example. ### instructorTitle The titles of the course instructors. This variable is only applicable to instructor-led courses. You will need to replace with a number. The titles will be sorted in the same order as their associated instructor (i.e., [instructor](https://help.smarteru.com/course-certificate-variables$course_var_instructor)). Refer to the [Course Variables Example: Instructor](/v1/docs/creating-a-custom-certificate-course-certificate-variables#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](https://help.smarteru.com/course-certificate-variables$coures_var_example_instructor) section for an example. ### **PT_Total_Points** The total value of all [point trackers associated with the course](/v1/docs/course-points-and-rewards). Refer to the [Course Variables Example: PT](/v1/docs/creating-a-custom-certificate-course-certificate-variables#course-variables-example-pt) section for an example. ### PT_* The value of the [point tracker associated with the course](/v1/docs/course-points-and-rewards). 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](/v1/docs/creating-a-custom-certificate-course-certificate-variables#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](/v1/docs/creating-a-custom-certificate-course-certificate-variables#pt_total_points). This variable only displays data when the [licensing feature](/v1/docs/licensing) 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](/v1/docs/creating-a-custom-certificate-course-certificate-variables#licensing-variables-for-course-certificates). ### PT_*<*PointTrackerName*>*_Label The name of the [point tracker associated with the course](/v1/docs/course-points-and-rewards). You will need to replace 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](/v1/docs/creating-a-custom-certificate-course-certificate-variables#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](/v1/docs/creating-a-custom-certificate-course-certificate-variables#pt_total_points). This variable only displays data when the [licensing feature](/v1/docs/licensing) 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](/v1/docs/creating-a-custom-certificate-course-certificate-variables#licensing-variables-for-course-certificates). ### **recipientDivision** The [learner's division](/v1/docs/user-profile-information#division). ### **recipientEmployeeID** The [learner's employee ID](/v1/docs/user-login-information#employee-id-required-if-primary-email-not-specified). ### recipientHomeGroup The [learner's home group](/v1/docs/user-group-permissions). ### **recipientName** The [learner's given name](/v1/docs/user-login-information#given-names-required) and [surname](/v1/docs/user-login-information#surname-required). ### **recipientOrganization** The [learner's organization](/v1/docs/user-profile-information#organization). ### **recipientTitle** The [learner's title](/v1/docs/user-profile-information#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](/v1/docs/creating-a-custom-certificate-course-certificate-variables#instructorn) [instructorTitle1](/v1/docs/creating-a-custom-certificate-course-certificate-variables#instructortitlen) | Dana Brown Retail Director | | instructor2 instructorTitle2 | James Lee HR Director | | instructor3 instructorTitle3 | Peter Brown HR Specialist | | instructor4 instructorTitle4 | Elise Landon | | [instructorList](https://help.smarteru.com/course-certificate-variables$course_var_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](/v1/docs/creating-a-custom-certificate-course-certificate-variables#pt_pointtrackername_label) [PT_Customer_Champion](/v1/docs/creating-a-custom-certificate-course-certificate-variables#pt_pointtrackername) | Customer Champion 10 | | PT_Fina_Product_Pro_Label PT_Fina_Product_Pro | Fina Product Pro 15 | | [PT_Total_Points](https://help.smarteru.com/course-certificate-variables$course_var_pt_total_points) | 25 | If licensing is enabled, refer to the [Licensing Variables Example: PT](/v1/docs/creating-a-custom-certificate-course-certificate-variables#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](/v1/docs/licensing) is [enabled for the account](https://support.smarteru.com/docs/account-settings#enable-licensing). - 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__Agency A list of the [user's assigned agencies](/v1/docs/user-licensing#agency). The agencies will be sorted in the same order as their associated licensing areas (i.e., [Licensing_User__Area](/v1/docs/creating-a-custom-certificate-course-certificate-variables#licensing_user_n_area)). You will need to replace with a number. Refer to the [Licensing Variables Example: Licensing_User](/v1/docs/creating-a-custom-certificate-course-certificate-variables#licensing-variables-example-licensing_user) section for an example. ### Licensing_User__Area An alphabetical list of the [user's assigned licensing areas](/v1/docs/user-licensing#arearegion). You will need to replace with a number. Refer to the [Licensing Variables Example: Licensing_User](/v1/docs/creating-a-custom-certificate-course-certificate-variables#licensing-variables-example-licensing_user) section for an example. ### Licensing_User__License_Expiry A list of the [user's license expiration dates](/v1/docs/user-licensing#license-expiry) 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__Area](/v1/docs/creating-a-custom-certificate-course-certificate-variables#licensing_user_n_area)). You will need to replace with a number. Refer to the [Licensing Variables Example: Licensing_User](/v1/docs/creating-a-custom-certificate-course-certificate-variables#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__License_Notes A list of [notes associated with the user's license](/v1/docs/user-licensing#notes). The notes are listed in the same order as their associated licensing areas (i.e., [Licensing_User__Area](/v1/docs/creating-a-custom-certificate-course-certificate-variables#licensing_user_n_area)). You will need to replace with a number. Refer to the [Licensing Variables Example: Licensing_User](/v1/docs/creating-a-custom-certificate-course-certificate-variables#licensing-variables-example-licensing_user) section for an example. ### Licensing_User__License_Number A list of the [user's assigned license numbers](/v1/docs/user-licensing#license-). The license numbers will be sorted in the same order as their associated licensing areas (i.e., [Licensing_User__Area](/v1/docs/creating-a-custom-certificate-course-certificate-variables#licensing_user_n_area)). You will need to replace with a number. Refer to the [Licensing Variables Example: Licensing_User](/v1/docs/creating-a-custom-certificate-course-certificate-variables#licensing-variables-example-licensing_user) section for an example. ### Licensing_User__License_Type A list of the [user's assigned license types](/v1/docs/user-licensing#license-type). The license types will be sorted in the same order as their associated licensing areas (i.e., [Licensing_User__Area](/v1/docs/creating-a-custom-certificate-course-certificate-variables#licensing_user_n_area)). You will need to replace with a number. Refer to the [Licensing Variables Example: Licensing_User](/v1/docs/creating-a-custom-certificate-course-certificate-variables#licensing-variables-example-licensing_user) section for an example. ### Licensing_User__Region A list of the [user's assigned regions](/v1/docs/user-licensing#arearegion). The regions will be sorted in the same order as their associated licensing areas (i.e., [Licensing_User__Area](/v1/docs/creating-a-custom-certificate-course-certificate-variables#licensing_user_n_area)). You will need to replace with a number. Refer to the [Licensing Variables Example: Licensing_User](/v1/docs/creating-a-custom-certificate-course-certificate-variables#licensing-variables-example-licensing_user) section for an example. ### PT__Label An alphabetical list of all [point trackers associated with the course](/v1/docs/course-points-and-rewards). You will need to replace with a number. The point tracker information will be listed in alphabetical order by point tracker name. Refer to the [Licensing Variables Example: PT](/v1/docs/creating-a-custom-certificate-course-certificate-variables#licensing-variables-example-pt) section for an example. ### PT__Points The [values of all point trackers associated with the course](/v1/docs/course-points-and-rewards#points). The points will be sorted in the same order as their associated label (i.e., [PT__Label](/v1/docs/creating-a-custom-certificate-course-certificate-variables#pt_pointtrackername_label)). You will need to replace with a number. The point tracker information will be listed in alphabetical order by point tracker name. Refer to the [Licensing Variables Example: PT](/v1/docs/creating-a-custom-certificate-course-certificate-variables#licensing-variables-example-pt) section for an example. ### PT_Category__Label An alphabetical list of all [licensing categories associated with the course](/v1/docs/course-points-and-rewards#license-category). You will need to replace with a number. The categories will be listed in alphabetical order by category name. Refer to the [Licensing Variables Example: PT](/v1/docs/creating-a-custom-certificate-course-certificate-variables#licensing-variables-example-pt) section for an example. ### PT_Category__Points The total [number of points](/v1/docs/course-points-and-rewards#points) for the licensing category. The points will be sorted in the same order as their associated label (i.e., [PT_Category__Label](/v1/docs/creating-a-custom-certificate-course-certificate-variables#pt_category_n_label)). You will need to replace with a number. The values will be listed in alphabetical order by category name. Refer to the [Licensing Variables Example: PT](/v1/docs/creating-a-custom-certificate-course-certificate-variables#licensing-variables-example-pt) section for an example. ### PT_Category__Reference The [reference IDs](/v1/docs/course-points-and-rewards#reference-id) associated with the licensing category. The reference IDs will be sorted in the same order as their associated category label (i.e., [PT_Category__Label](/v1/docs/creating-a-custom-certificate-course-certificate-variables#pt_category_n_label)). You will need to replace with a number. The values will be listed in alphabetical order by category name. Refer to the [Licensing Variables Example: PT](/v1/docs/creating-a-custom-certificate-course-certificate-variables#licensing-variables-example-pt) section for an example. ### **PT_Category_List** An alphabetical, comma-delimited list of all [licensing categories associated with the course](/v1/docs/course-points-and-rewards#license-category). ### **PT_Total_Licensing_Points** The total of all [licensing point trackers associated with the course](https://help.smarteru.com/course-points-and-rewards$setting_point_tracker). [Licensing point trackers](https://help.smarteru.com/point-tracker-licensing$top_of_page) are point trackers associated with an area, region, and agency. ### **PT_Total_Points** The total value of all [point trackers associated with the course](/v1/docs/course-points-and-rewards). ## **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](/v1/docs/creating-a-custom-certificate-course-certificate-variables#licensing_user_n_agency) [Licensing_User_1_Area](/v1/docs/creating-a-custom-certificate-course-certificate-variables#licensing_user_n_area) [Licensing_User_1_License_Expiry](/v1/docs/creating-a-custom-certificate-course-certificate-variables#licensing_user_n_license_expiry) [Licensing_User_1_License_Notes](/v1/docs/creating-a-custom-certificate-course-certificate-variables#licensing_user_n_license_notes) [Licensing_User_1_License_Number](/v1/docs/creating-a-custom-certificate-course-certificate-variables#licensing_user_n_license_number) [Licensing_User_1_License_Type](/v1/docs/creating-a-custom-certificate-course-certificate-variables#licensing_user_n_license_type) [Licensing_User_1_License_Region](/v1/docs/creating-a-custom-certificate-course-certificate-variables#licensing_user_n_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](/v1/docs/creating-a-custom-certificate-course-certificate-variables#pt_n_label) [PT_1_Points](/v1/docs/creating-a-custom-certificate-course-certificate-variables#pt_n_points) [PT_Category_1_Label](/v1/docs/creating-a-custom-certificate-course-certificate-variables#pt_category_n_label) [PT_Category_1_Points](/v1/docs/creating-a-custom-certificate-course-certificate-variables#pt_category_n_points) [PT_Category_1_Reference](/v1/docs/creating-a-custom-certificate-course-certificate-variables#pt_category_n_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](/v1/docs/creating-a-custom-certificate-course-certificate-variables#pt_category_list) | Accounting, Accounting Principles | | [PT_Total_Licensing_Points](/v1/docs/creating-a-custom-certificate-course-certificate-variables#pt_total_licensing_points) | 15 | | [PT_Total_Points](/v1/docs/creating-a-custom-certificate-course-certificate-variables#pt_total_points) | 30 | If licensing is disabled, refer to the [Course Variables Example: PT](/v1/docs/creating-a-custom-certificate-course-certificate-variables#course-variables-example-pt) section for an example. ## Related - [Course: Points and Rewards](/course-points-and-rewards.md) - [Creating a Custom Certificate](/creating-a-custom-certificate.md) - [Creating a Custom Certificate: Certification Certificate Variables](/creating-a-custom-certificate-certification-certificate-variables.md) - [Instructor-Led Course: Customization](/instructor-led-course-customization.md) - [Licensing](/licensing.md) - [Online Course: Customization](/online-course-customization.md) - [Points and Rewards](/points-and-rewards.md) - [SCORM Course: Customization](/scorm-course-customization.md)