The following is an alphabetical list of tokens that are available to insert into templates that have the Offer Letters or Recruiting - Candidate Emails category. Templates with these categories are used to send offer letters and candidate communication emails in the Recruiting feature.
Administrators can use these tokens when they create templates in Letter Management > Template Designer. The token names are preceded by "Candidate:" in the Options pull-down.
When recruiters create offer letters, they will see these tokens when they are included in the templates that they choose. They are required to provide values for the tokens identified as "editable" in the table below and will be asked to fill in these values before they can preview the offer letters. Their updates are carried over to the Candidate Hire and Internal Candidate Hire forms where indicated.
If authorized, recruiters can change the values of the tokens not identified as editable in the table below. They see the value of these tokens when they preview the offer letters.
Note: Tokens that return values based on job requisition or job posting details will be populated only in candidate communication emails that are sent in the context of a job application
|
Token Name |
Description |
|---|---|
| Candidate: Address | Returns the value from the Address field of the Personal Information section in the candidate's profile of Recruiting. |
| Candidate: Address City | Returns the value from the City field of the Personal Information section in the candidate's profile of Recruiting. |
| Candidate: Address Country | Returns the value from the Country field of the Personal Information section in the candidate's profile of Recruiting. |
| Candidate: Address County | Returns the value from the County field of the Personal Information section in the candidate's profile of Recruiting. |
| Candidate: Address Postcode | Returns the value from the Zip/Postal Code field of the Personal Information section in the candidate's profile of Recruiting. |
| Candidate: Address State | Returns the value from the State/Province field of the Personal Information section in the candidate's profile of Recruiting. |
|
Candidate: Average Daily Hours (Editable. Edits carried over.) |
Returns the value from the Average Daily Hours field of the Details tab for the job requisition that the letter is initiated from. |
|
Candidate: Base Rate Policy (Editable. Edits carried over.) |
Returns the value of the base rate policy used to calculate the offer base salary and base rate set. Available only when the Use Base Rate Policy checkbox is selected for the corresponding job requisition. |
|
Candidate: Base Rate Level (Editable. Edits carried over.) |
Returns the value of the base rate level used to calculate the offer base salary and base rate set. Available only when the Use Base Rate Policy checkbox is selected for the corresponding job requisition. |
|
Candidate: Days Per Week (Editable. Edits carried over.) |
The number of days per week that the normal hours per week are worked over. This field isn’t preconfigured or carried over to the employee's details upon hiring. |
|
Candidate: Employment Indicator (Editable. Edits carried over.) |
Returns the value from the Employment Indicator field of the Details tab for the job requisition that the letter is initiated from. Users can edit the default value in the Required Information section of the Send a Letter wizard. Edits are carried over to the employee's details upon hiring. |
|
Candidate: Field Based Job (Editable. Edits not carried over.) |
Indicates whether the job is field-based. This value is preconfigured with No in the Field Based Job drop-down list in Required Information section of the Send a Letter wizard. You can also select the Yes - In Region or Yes - National option from this drop-down list. This value isn’t carried over to the employee's details upon hiring. |
| Candidate: First Name | Returns the value from the First Name field of the Personal Information section in the candidate's profile of Recruiting. |
| Candidate: Hiring Manager First Name | Returns the first name of the user selected in the Hiring Manager field of the Details tab for the job requisition that the letter is initiated from. |
| Candidate: Hiring Manager Last Name | Returns the last name of the user selected in the Hiring Manager field of the Details tab for the job requisition that the letter is initiated from. |
| Candidate: Hiring Manager Job Assignment | Returns the job assignment of the user selected in the Hiring Manager field of the Details tab for the job requisition that the letter is initiated from. |
| Candidate: Hiring Range Max | Returns the value from the Hiring Range Maximum field of the Details tab for the job requisition that the letter is initiated from. |
| Candidate: Hiring Range Min | Returns the value from the Hiring Range Minimum field of the Details tab for the job requisition that the letter is initiated from. |
| Candidate: Job Assignment | Returns the value from the Job Assignment field of the Details tab for the job requisition that the letter is initiated from. |
| Candidate: Job Posting Title | Returns the value from the Posting Title field for the posting that the candidate applied to in Recruiting. If a recruiter assigned the candidate to the job requisition, this token returns the Job Requisition Title field for the requisition instead, because the candidate isn’t associated with a posting. |
| Candidate: Job Req Location | Returns the value from the Location field of the Details tab for the job requisition that the letter is initiated from. |
| Candidate: Job Req Title | Returns the value from the Job Requisition Title field of the Details tab for the job requisition that the letter is initiated from. |
| Candidate: Job Title | Returns the value from the read-only Job field of the Details tab for the job requisition that the letter is initiated from. |
| Candidate: Last Name | Returns the value from the Last Name field of the Personal Information section in the candidate's profile of Recruiting. |
| Candidate: Middle Name | Returns the value from the Middle Name field of the Personal Information section in the candidate's profile of Recruiting. |
| Candidate: Name Prefix | Returns the value from the Prefix field (for example, Mr. or Mrs.) of the Personal Information section in the candidate's profile of Recruiting. |
| Candidate: Name Suffix | Returns the value from the Suffix field (for example, Jr.) of the Personal Information section in the candidate's profile of Recruiting. |
|
Candidate: Offer Base Salary (Editable. Edits carried over.) |
The base rate or annual salary that is offered to the candidate. This value isn’t preconfigured and needs to be specified when creating the offer letter. The value entered is carried over to the Base Rate and Annual Salary fields in the Candidate Hire and Internal Candidate Hire forms. If there is no pay group or the salary you specify is outside the pay grade of the job, an error appears. If you are using a base rate policy and decide to manually overwrite this value, the base rate policy is no longer applicable for the candidate. |
| Candidate: Offer Base Salary + Super |
Returns the sum of the offer base salary plus this salary multiplied by the superannuation percentage from the Superannuation Rate % field. For example, if $100,000 is the offer base salary and 10 is the superannuation rate, then this token will return $110,000 ($100,000 + 10%). This token is for Australian users. To use it, you must add both the Candidate: Offer base salary (editable) and Candidate: Superannuation Rate (Editable) tokens to the template. |
|
Candidate: Offer End Date (Editable. Edits not carried over.) |
The end date for a fixed term offer. This value isn’t preconfigured and needs to be specified when creating the offer letter. This date isn’t carried over to the employee's details upon hiring. |
| Candidate: Offer Submission Date |
System date that the letter is submitted to workflow. This day can be before the day that the letter is sent to the candidate if the workflow takes more than a day to approve. |
|
Candidate: Offer Start Date (Editable. Edits carried over.) |
The target start date for the candidate should they accept the offer. This value isn’t preconfigured and needs to be specified when creating the offer letter. The value entered is carried over to the Hire Date field of the Candidate Hire and Internal Candidate Hire forms. If you are using a base rate policy and leave this field blank, the current date is used to determine which levels are shown. |
|
Candidate: Pay Class (Editable. Edits carried over.) |
Returns the value from the Pay Class drop-down list (for example full-time or part-time) of the Details tab for the job requisition that the letter is initiated from. Users can edit this default value when creating the offer letter. Edits are carried over to the employee's details upon hiring. |
| Candidate: Pay Grade |
Returns the value from the read-only Pay Grade field of the Details tab for the job requisition that the letter is initiated from. |
| Candidate: Pay Grade Control Rate |
Returns the rate that most employees earn (also known as the market rate) according to the job details of the job requisition that the letter is initiated from. Not necessarily the midpoint between the minimum and maximum, it represents the ideal amount that employees working job assignments with the pay grade should earn. |
| Candidate: Pay Grade Control Salary |
Returns the salary that most employees earn (also known as the market rate) according to the job details of the job requisition that the letter is initiated from. Not necessarily the midpoint between the minimum and maximum, it represents the ideal amount that employees working job assignments with the pay grade should earn. |
| Candidate: Pay Grade Maximum Rate | Returns the rate value, if applicable, from the read-only Pay Grade Maximum field of the Details tab for the job requisition that the letter is initiated from. |
| Candidate: Pay Grade Maximum Salary |
Returns the salary value, if applicable, from the read-only Pay Grade Maximum field of the Details tab for the job requisition that the letter is initiated from. |
| Candidate: Pay Grade Midpoint Rate | Returns the rate value, if applicable, from the read-only Pay Grade Mid field of the Details tab for the job requisition that the letter is initiated from. |
| Candidate: Pay Grade Midpoint Salary |
Returns the salary value, if applicable, from the read-only Pay Grade Mid field of the Details tab for the job requisition that the letter is initiated from. |
| Candidate: Pay Grade Minimum Rate | Returns the rate value, if applicable, from the read-only Pay Grade Minimum field of the Details tab for the job requisition that the letter is initiated from. |
| Candidate: Pay Grade Minimum Salary |
Returns the salary value, if applicable, from the read-only Pay Grade Minimum field of the Details tab for the job requisition that the letter is initiated from. |
| Candidate: Pay Type | Returns the value from the Pay Type field (for example, salaried or hourly) of the Details tab for the job requisition that the letter is initiated from. |
|
Candidate: Position Term (Editable. Edits carried over.) |
Returns the value from the Position Term field (for example, regular or temporary) of the Details tab for the job requisition that the letter is initiated from. Users can edit this value when creating the offer letter. Edits are carried over to the employee's details upon hiring. |
| Candidate: Preferred First Name | This token is used for offer letters for internal candidates and returns the preferred given name field in the employee's record. |
|
Candidate: Primary Job Location (Editable. Edits not carried over.) |
The public name and city of the location that is associated with the posting. This value isn’t preconfigured by default and needs to be specified when creating the offer letter. Users can search for the location by its public name or city. The list includes only locations that have the following fields defined at the minimum in the Address tab of the location slide-out panel in the Organization tab of Org Setup > Organization:
This value isn’t carried over to the employee's details upon hiring. See Configure Organizational Locations and Mapping. |
| Candidate: Recruiter First Name | Returns the first name of the user selected in the Assigned Recruiter field of the Details tab for the job requisition that the letter is initiated from. |
| Candidate: Recruiter Last Name | Returns the last name of the user selected in the Assigned Recruiter field of the Details tab for the job requisition that the letter is initiated from. |
| Candidate: Recruiter Job Assignment | Returns the primary job assignment of the user selected in the Assigned Recruiter field of the Details tab for the job requisition that the letter is initiated from. |
| Candidate: Seniority Date | (Applicable for internal candidates only) Returns the value from the Seniority Date field in the Key Information tab of the Employment > Employment Settings screen in People. |
| Candidate: Site Address Country |
Returns the value from the Country field in the Address tab of the site-level org unit associated with the job requisition that the letter is initiated from. |
| Candidate: Site Address Line 1 | Returns the value from the Address Line 1 field in the Address tab of the site-level org unit associated with the job requisition that the letter is initiated from. |
| Candidate: Site Address Line 2 | Returns the value from the Address Line 2 field in the Address tab of the site-level org unit associated with the job requisition that the letter is initiated from. |
| Candidate: Site Contact Business Phone |
Returns the value from the Business Phone field of the Contact tab for the site-level org unit associated with the job requisition that the letter is initiated from. Note: The application sources this information from the on-site level. If the information is missing from that level, it goes one level up in the organization until it finds a value to use. |
| Candidate: Site City | Returns the value from the City field in the Address tab of the site-level org unit associated with the job requisition that the letter is initiated from. |
| Candidate: Site Contact Cell Phone | Returns the value from the Cell Phone field of the Contact tab for the site-level org unit associated with the job requisition that the letter is initiated from. |
| Candidate: Site Contact Email | Returns the value from the Email field of the Contact tab for the site-level org unit associated with the job requisition that the letter is initiated from. |
| Candidate: Site Contact Name | Returns the value from the Name field of the Contact tab for the site-level org unit associated with the job requisition that the letter is initiated from. |
| Candidate: Site County |
Returns the value from the County field in the Address tab of the site-level org unit associated with the job requisition that the letter is initiated from. |
| Candidate: Site Description | Returns the value from the Description field of the General tab for the site-level org unit associated with the job requisition that the letter is initiated from. |
| Candidate: Site Establishment Name | Returns the value from the Establishment Name field of the Compliance Properties tab for the site-level org unit associated with the job requisition that the letter is initiated from. |
| Candidate: Site Legal Entity Name |
Returns the value from the Name field of the Legal Entity tab for the on-site level org unit associated with the job requisition that the letter is initiated from. If this name is blank, it returns the legal entity name of the site-level org unit. |
| Candidate: Site Name | Returns the value from the Name field of the General tab for the site-level org unit associated with the job requisition that the letter is initiated from. |
| Candidate: Site Postal Code | Returns the value from the Zip / Postal Code field in the Address tab of the site-level org unit associated with the job requisition that the letter is initiated from. |
| Candidate: Site Public Name | Returns the value from the Public Name field in the Address tab of the site-level org unit associated with the job requisition that the letter is initiated from. |
| Candidate: Site State / Province | Returns the value from the State / Province field in the Address tab of the site-level org unit associated with the job requisition that the letter is initiated from. |
| Candidate: Super on Base Salary |
(For Australian users) Returns the superannuation value, which is the offer base salary multiplied by the superannuation percentage from the Superannuation Rate % field. For example, if $100,000 is the offer base salary and 10 is the superannuation rate, then this token returns $10,000 (10% of 100,000). This token is for Australian users. To use it, you must add both the Candidate: Offer base salary (editable) and Candidate: Superannuation Rate (Editable) tokens to the letter template. |
|
Candidate: Superannuation Rate (Editable. Edits not carried over.) |
(For Australian users) Shows the Superannuation Rate % field to Australian users when they create offer letters, candidate emails, or interview requests. By default, this field contains the value of the Superannuation default contribution rate (%) payroll client property. Users can adjust this value as necessary. This token is required before you can include superannuation information in letter templates. You can provide this information with either of the following tokens: Candidate: Super on Base Salary or Candidate: Offer Base Salary + Super. Superannuation is a compulsory system in Australia requiring employers to pay eligible employees per month a super guarantee (or SG) in addition to their wages. For more information, see Overview of Superannuation in the Payroll Administrator Guide. |
|
Candidate: Weekly Hours (Editable. Edits carried over.) |
Returns the value from the Weekly Hours field of the Details tab for the job requisition that the letter is initiated from. For example, regular or temporary. Users can edit this value when creating the offer letter. Edits are carried over to the employee's details upon hiring. |