Template Merge Fields
Adapt allows you to add a variety of merge fields to your email and letter templates. The tables below show all information that can be added to a template and the merge field name that gathers that information. While you cannot copy and paste the merge field name directly into your template from this page, you can click on the link below to open a Word document, similar to this page, that does allow you to copy and paste the merge field (be sure to include the double carats << and >> when copying and pasting the merge field).
To display a Word document so you can copy and paste, click here.
The list is divided by entity (the Multiple table lists merge fields that apply to more than one entity). To find the merge field you would like to add to a template, you can either scroll down...or click one of the links below to be taken directly to that table:
Multiple
Today's Date |
<<Date>> |
|
Salutation |
<<Salutation>> |
Candidate or Contact. Only available on the Batch workflow menu. Uses text defined on workflow. This defaults to "Dear". |
Candidate
First Name |
<<CandFirstName>> |
|
Last Name |
<<CandLastName>> |
|
Full Name |
<<CandFullName>> |
|
Person ID |
<<CandidateID>> |
|
Address 1 |
<<CandAddr1>> |
First Address Line |
Address 2 |
<<CandAddr2>> |
Second Address Line (for Suites, Apts, etc.) |
City |
<<CandCity>> |
|
State |
<<CandState>> |
|
Zip |
<<CandPostal>> |
Postal Code |
|
<<CandGeneric>> |
Displays Address 1, Address 2, City, State and Zip |
Status |
<<CandStatus>> |
|
Availability Status |
<<AvailStatus>> |
|
Availability Date |
<<AvailDate>> |
|
Recruiter Name |
<<RecrName>> |
|
Candidate Email |
<<CandEmail>> |
Email 1 only |
Branch |
<<CandBranch>> |
|
Division |
<<CandDiv>> |
|
Home Phone |
<<CandHome>> |
|
Mobile |
<<CandMobile>> |
|
Text Msg |
<<CandTextMsg>> |
Y if checked, N if not checked |
Salutation Type |
<<SalutationType>> |
Allows user to select the format of the presented name. |
Preview Text |
<<PreviewText>> |
Contains text to be presented when selecting Preview on the Batch workflow. |
Beginning Add Text |
<<BAddText>> |
Available only on the Batch workflow menu. This adds the text defined on the workflow to the beginning of the paragraph. |
End Add Text |
<<EAddText>> |
Available only on the Batch workflow menu. This adds the text defined on the workflow to the end of the paragraph. |
Closing |
<<Closing>> |
Available only on the Batch workflow menu. This adds the defined text to the closing. |
Name of User running workflow |
<<ConsultantName>> |
Letters only (Batch or Single) |
Title of User running workflow |
<<ConsultantJobTitle>> |
Letters only (Batch or Single) |
Website |
<<Website>> |
Used on the Generate code and Reset Password Code email text. |
Authorization Code |
<<AuthCode>> |
Used on the Generate code and Reset Password Code email text. |
Username |
<<Username>> |
Used on the Reset Password Code email text. |
Branch Phone Number |
<<CandBranchPhone>> |
|
Required Merge Field for Batch Letters |
<<TableStart:bMark>> |
Allows all letters to merge into one document. This field is Required for Batch Letters and should not be removed. |
Contact
First Name |
<<ContFirstName>> |
|
Last Name |
<<ContLastName>> |
|
Full Name |
<<ContFullName>> |
|
Person ID |
<<ContID>> |
|
Address 1 |
<<ContAddr1>> |
First Address Line |
Address 2 |
<<ContAddr2>> |
Second Address Line (for Suites, Apts, etc.) |
City |
<<ContCity>> |
|
State |
<<ContState>> |
|
Zip |
<<ContPostal>> |
Postal Code |
|
<<ContGeneric>> |
Displays Address 1, Address 2, City, State and Zip |
Account Manager Name |
<<ContAMName>> |
Account Manager 1 only |
Contact Email |
<<ContEmail>> |
Email 1 only |
Branch |
<<ContBranch>> |
|
Division |
<<ContDiv>> |
|
Direct Phone |
<<ContDirect>> |
|
Main Phone |
<<ContMain>> |
|
Mobile |
<<ContMobile>> |
|
Mailing List |
<<ContMailingList>> |
Y if checked, N if not checked |
Text Msg |
<<CandTextMsg>> |
Y if checked, N if not checked |
Salutation Type |
<<SalutationType>> |
Allows user to select the format of the presented name. |
Preview Text |
<<PreviewText>> |
Contains text to be presented when selecting Preview on the Batch workflow. |
Beginning Add Text |
<<BAddText>> |
Available only on the Batch workflow menu. This adds the text defined on the workflow to the beginning of the paragraph. |
End Add Text |
<<EAddText>> |
Available only on the Batch workflow menu. This adds the text defined on the workflow to the end of the paragraph. |
Closing |
<<Closing>> |
Available only on the Batch workflow menu. This adds the defined text to the closing. |
Name of User running workflow |
<<ConsultantName>> |
Letters only (Batch or Single) |
Title of User running workflow |
<<ConsultantJobTitle>> |
Letters only (Batch or Single) |
Required Merge Field for Batch Letters |
<<TableStart:bMark>> |
Allows all letters to merge into one document. This field is Required for Batch Letters and should not be removed. |
Company
Company Name |
<<CompName>> |
|
Company Website |
<<CompWebsite>> |
|
Parent |
<<Parent>> |
|
Company Division |
<<CompDiv>> |
|
Company Branch |
<<CompBranch>> |
|
Job
Requestor |
<<Requestor>> |
|
Job Type |
<<JobType>> |
Role |
Job Status |
<<JobStatus>> |
|
Job ID |
<<JobID>> |
|
Account Manager |
<<JobAM>> |
|
Job Title |
<<JobTitle>> |
|
Category |
<<JobCategory>> |
|
Job Description |
<<JobDescription>> |
|
Reports To |
<<JobReportsTo>> |
|
Start Date |
<<JobStartDate>> |
|
Estimated End Date |
<<JobEstEndDate>> |
Contract Job only |
Bill Rate Low |
<<JobBillLow>> |
Contract Job only |
Bill Rate High |
<<JobBillHigh>> |
Contract Job only |
Pay Rate Low |
<<JobPayLow>> |
Contract Job only |
Pay Rate High |
<<JobPayHigh>> |
Contract Job only |
Estimated Weeks |
<<JobEstWeeks>> |
Contract Job only |
Salary Low |
<<JobSalaryLow>> |
Direct Job only |
Salary High |
<<JobSalaryHigh>> |
Direct Job only |
Full Fee |
<<JobFullFee>> |
Direct Job only |
# Required |
<<JobNoRequire>> |
|
# Remaining |
<<JobNoRemain>> |
|
Worksite Address 1 |
<<JobWorkAddr1>> |
First Address Line |
Worksite Address 2 |
<<JobWorkAddr2>> |
Second Address Line (for Suites, Apts, etc.) |
Worksite City |
<<JobWorkCity>> |
|
Worksite State/Province |
<<JobWorkState>> |
|
Worksite Postal Code |
<<JobWorkPostal>> |
|
|
<<JobGeneric>> |
Includes Worksite Address 1, Worksite Address 2, Worksite City, Worksite State/Province and Worksite Postal Code |
Assignment
Assignment Type |
<<AsgType>> |
Role |
Assignment Status |
<<AsgStatus>> |
|
Assignment ID |
<<AsgID>> |
|
Account Manager |
<<AsgAM>> |
|
Recruiter |
<<AsgRecr>> |
|
Job Title |
<<AsgJobTitle>> |
|
Job Category |
<<AsgCategory>> |
|
Job Description |
<<AsgDescription>> |
|
Reports To |
<<AsgReportsTo>> |
|
Start Date |
<<AsgStartDate>> |
|
Estimated End Date |
<<AsgEstEndDate>> |
Contract Job only |
End Date |
<<AsgEndDate>> |
|
Work Hours Start |
<<AsgWorkStart>> |
Contract Job only |
Work Hours End |
<<AsgWorkEnd>> |
Contract Job only |
Reason Ended |
<<ReasonEnded>> |
|
Bill Rate |
<<AsgBillRate>> |
Contract Job only |
Pay Rate |
<<AsgPayRate>> |
Contract Job only |
OT Pay Rate |
<<AsgOTPayRate>> |
Contract Job only |
Estimated Weeks |
<<AsgEstWeeks>> |
Contract Job only |
Salary |
<<AsgSalary>> |
Direct Job only |
Full Fee Amount |
<<AsgFullFee>> |
Direct Job only |
Discount Amount |
<<AsgDiscAmt>> |
Direct Job only |
Net Fee Amount |
<<AsgNetFee>> |
Direct Job only |
Worksite Address 1 |
<<AsgWorkAddr1>> |
First Address Line |
Worksite Address 2 |
<<AsgWorkAddr2>> |
Second Address Line (for Suites, Apts, etc.) |
Worksite City |
<<AsgWorkCity>> |
|
Worksite State/Province |
<<AsgWorkState>> |
|
Worksite Postal Code |
<<AsgWorkPostal>> |
|
|
<<AsgGeneric>> |
Includes Worksite Address 1, Worksite Address 2, Worksite City, Worksite State/Province and Worksite Postal Code |
Compass Onboarding
Note: If the candidate does not have a Compass login, then the merge fields like portal name, portal user name, etc. will be blank, as there is no generic stand-in for an undefined value.
Compass Site Name |
#PORTAL_SITE_NAME# |
Compass Site URL |
#PORTAL_SITE_URL# |
Compass User Name |
#PORTAL_SITE_USER_NAME# |