Document Template Merge Fields

In order to merge your Cezanne data into a document, you need to add Merge Fields to your template.

This article explains how to use Merge Fields and contains the following sections:

  1. Adding a Merge Field
  2. Merge Field Date and Number Formats
  3. Available Merge Fields

Note:

  • You can only use Document Template Merge Fields in Document Templates. If you are editing an E-mail Template, see: E-mail Template Merge Fields.

1. Adding a Merge Field

To add a Merge Field to a Document Template:

  1. Select the Reports tab and Merge Fields option.
  2. Select the Merge Fields list.
  3. Choose the field that you require.
1. Adding a Merge Field

2. Merge Field Date and Number Formats

When adding a merge field to a Document Template that is a date or number field, e.g. Date of Birth, no specific format is applied by default.

Therefore, you will need to specify the date and / or number format to be used and all recipients will receive the document in the same date format.

  1. Add a Merge Field as described in section 1.
  2. Select the Merge Field, right-click and select Field Properties.
  3. Tick either Date / time format and / or Numeric format and enter one of the available formats (specified below).
  4. Click OK.
2. Merge Field Date and Number Formats

Note:

  • If you need to send this to multiple people in different regions, you may need to create multiple templates that use different merge field date and / or number formats.

Available Date Formats

Date Format Example
dd/MM/yyyy 21/04/2021
dd MMMM yyyy 21 April 2021
dd/MM/yy 21/04/21
dd-MM-yyyy 21-04-2021
dd-MM-yy 21-04-21
dd-MMM-yyyy 21-Apr-2021
M/dd/yyyy 4/21/2021
dd-M-yyyy 21-4-2021
dd.MM.yyyy 21.04.2021
dd/M/yyyy 21/4/2021

Available Number Formats

Number Format Example
##.00 11.57
##.0 11.6
#,###.00 1,123.62
 

3. Available Merge Fields

Note:

  • It is not possible to copy and paste the following Merge Field tags into a Document Template.
  • Therefore, this list is for reference only and you must use the instructions in section 1 above to add a Merge Field to a Document Template.
  • When using People Core Data with Compensation Merge Fields, only Compensation Records that use the Compensation Item with the code 'BASE' will be pulled through as Merge Fields.
  • When using People Core Data with Compensation Merge Fields, only Bonus Records that use the Compensation Item with the code 'BONUS' will be pulled through as Merge Fields.
  • For any Merge Field that doesn't specifically state whether it is Current, Future or Historic, the following rules apply:
    • The Current record takes priority over Future and Historic records.
    • If there is no Current record, the Future record is used.
    • If there is no Current or Future record, the Historic record is used.
Merge Field Tag People Core Data People Core Data with Compensation People Core Data with Multiple Compensation People Core Data with Payroll
Additions&Deductions1/2/3/4/5_CurrentCompanyName
Additions&Deductions1/2/3/4/5_CurrentDescription
Additions&Deductions1/2/3/4/5_CurrentEffectiveFrom
Additions&Deductions1/2/3/4/5_CurrentEffectiveTo
Additions&Deductions1/2/3/4/5_CurrentEffectiveID
Additions&Deductions1/2/3/4/5_CurrentFixedAmount
Additions&Deductions1/2/3/4/5_CurrentFixedAmountMultiplier
Additions&Deductions1/2/3/4/5_CurrentFixedAmountRate
Additions&Deductions1/2/3/4/5_CurrentFixedAmountTotal
Additions&Deductions1/2/3/4/5_CurrentHourlyRateMultiplier
Additions&Deductions1/2/3/4/5_CurrentMultipleOfHourly
Additions&Deductions1/2/3/4/5_CurrentOneOffDay
Additions&Deductions1/2/3/4/5_CurrentPayCode
Additions&Deductions1/2/3/4/5_CurrentPayCodeTitle
Additions&Deductions1/2/3/4/5_CurrentPayCodeType
Additions&Deductions1/2/3/4/5_CurrentPayrollCode
Additions&Deductions1/2/3/4/5_CurrentPercentageOfBasic
Additions&Deductions1/2/3/4/5_CurrentPercentageOfNet
Additions&Deductions1/2/3/4/5_FutureCompanyName
Additions&Deductions1/2/3/4/5_FutureDescription
Additions&Deductions1/2/3/4/5_FutureEffectiveFrom
Additions&Deductions1/2/3/4/5_FutureEffectiveTo
Additions&Deductions1/2/3/4/5_FutureEffectiveID
Additions&Deductions1/2/3/4/5_FutureFixedAmount
Additions&Deductions1/2/3/4/5_FutureFixedAmountMultiplier
Additions&Deductions1/2/3/4/5_FutureFixedAmountRate
Additions&Deductions1/2/3/4/5_FutureFixedAmountTotal
Additions&Deductions1/2/3/4/5_FutureHourlyRateMultiplier
Additions&Deductions1/2/3/4/5_FutureMultipleOfHourly
Additions&Deductions1/2/3/4/5_FutureOneOffDay
Additions&Deductions1/2/3/4/5_FuturePayCode
Additions&Deductions1/2/3/4/5_FuturePayCodeTitle
Additions&Deductions1/2/3/4/5_FuturePayCodeType
Additions&Deductions1/2/3/4/5_FuturePayrollCode
Additions&Deductions1/2/3/4/5_FuturePercentageOfBasic
Additions&Deductions1/2/3/4/5_FuturePercentageOfNet
Additions&Deductions1/2/3/4/5_PreviousCompanyName
Additions&Deductions1/2/3/4/5_PreviousDescription
Additions&Deductions1/2/3/4/5_PreviousEffectiveFrom
Additions&Deductions1/2/3/4/5_PreviousEffectiveTo
Additions&Deductions1/2/3/4/5_PreviousEffectiveID
Additions&Deductions1/2/3/4/5_PreviousFixedAmount
Additions&Deductions1/2/3/4/5_PreviousFixedAmountMultiplier
Additions&Deductions1/2/3/4/5_PreviousFixedAmountRate
Additions&Deductions1/2/3/4/5_PreviousFixedAmountTotal
Additions&Deductions1/2/3/4/5_PreviousHourlyRateMultiplier
Additions&Deductions1/2/3/4/5_PreviousMultipleOfHourly
Additions&Deductions1/2/3/4/5_PreviousOneOffDay
Additions&Deductions1/2/3/4/5_PreviousPayCode
Additions&Deductions1/2/3/4/5_PreviousPayCodeTitle
Additions&Deductions1/2/3/4/5_PreviousPayCodeType
Additions&Deductions1/2/3/4/5_PreviousPayrollCode
Additions&Deductions1/2/3/4/5_PreviousPercentageOfBasic
Additions&Deductions1/2/3/4/5_PreviousPercentageOfNet
Addresses_AddressLine1/2/3/4/5
Addresses_AddressType
Addresses_City
Addresses_Country
Addresses_County
Addresses_FormattedAddress
Addresses_FormattedAddressSingleLine
Addresses_Postcode
BenefitType1/2/3/4/5_CurrentAccountMembershipNo
BenefitType1/2/3/4/5_CurrentBenefitDescription
BenefitType1/2/3/4/5_CurrentBenefitType
BenefitType1/2/3/4/5_CurrentComments
BenefitType1/2/3/4/5_CurrentContributionComments
BenefitType1/2/3/4/5_CurrentContributionCurrency
BenefitType1/2/3/4/5_CurrentContributionEffectiveFrom
BenefitType1/2/3/4/5_CurrentContributionEffectiveTo
BenefitType1/2/3/4/5_CurrentContributionEmployeeActualForPeriod
BenefitType1/2/3/4/5_CurrentContributionEmployeeAnnual
BenefitType1/2/3/4/5_CurrentContributionEmployeePercentageOfSalary
BenefitType1/2/3/4/5_CurrentContributionEmployerActualForPeriod
BenefitType1/2/3/4/5_CurrentContributionEmployerAnnual
BenefitType1/2/3/4/5_CurrentContributionEmployerPercentageOfSalary
BenefitType1/2/3/4/5_CurrentContributionPayPeriod
BenefitType1/2/3/4/5_CurrentContributionTaxableAmountActualForPeriod
BenefitType1/2/3/4/5_CurrentContributionTaxableAmountAnnual
BenefitType1/2/3/4/5_CurrentContributionTotalValueActualForPeriod
BenefitType1/2/3/4/5_CurrentContributionTotalValueAnnual
BenefitType1/2/3/4/5_CurrentSchemeJoinDate
BenefitType1/2/3/4/5_CurrentSchemeLeaveDate
BenefitType1/2/3/4/5_CurrentSchemeName
BenefitType1/2/3/4/5_CurrentSchemeOfferDate
BenefitType1/2/3/4/5_CurrentSchemeProvider
BenefitType1/2/3/4/5_CurrentValidToJoinDate
BenefitType1/2/3/4/5_FutureAccountMembershipNo
BenefitType1/2/3/4/5_FutureBenefitDescription
BenefitType1/2/3/4/5_FutureBenefitType
BenefitType1/2/3/4/5_FutureComments
BenefitType1/2/3/4/5_FutureContributionComments
BenefitType1/2/3/4/5_FutureContributionCurrency
BenefitType1/2/3/4/5_FutureContributionEffectiveFrom
BenefitType1/2/3/4/5_FutureContributionEffectiveTo
BenefitType1/2/3/4/5_FutureContributionEmployeeActualForPeriod
BenefitType1/2/3/4/5_FutureContributionEmployeeAnnual
BenefitType1/2/3/4/5_FutureContributionEmployeePercentageOfSalary
BenefitType1/2/3/4/5_FutureContributionEmployerActualForPeriod
BenefitType1/2/3/4/5_FutureContributionEmployerAnnual
BenefitType1/2/3/4/5_FutureContributionEmployerPercentageOfSalary
BenefitType1/2/3/4/5_FutureContributionPayPeriod
BenefitType1/2/3/4/5_FutureContributionTaxableAmountActualForPeriod
BenefitType1/2/3/4/5_FutureContributionTaxableAmountAnnual
BenefitType1/2/3/4/5_FutureContributionTotalValueActualForPeriod
BenefitType1/2/3/4/5_FutureContributionTotalValueAnnual
BenefitType1/2/3/4/5_FutureSchemeJoinDate
BenefitType1/2/3/4/5_FutureSchemeLeaveDate
BenefitType1/2/3/4/5_FutureSchemeName
BenefitType1/2/3/4/5_FutureSchemeOfferDate
BenefitType1/2/3/4/5_FutureSchemeProvider
BenefitType1/2/3/4/5_FutureValidToJoinDate
BenefitType1/2/3/4/5_PreviousAccountMembershipNo
BenefitType1/2/3/4/5_PreviousBenefitDescription
BenefitType1/2/3/4/5_PreviousBenefitType
BenefitType1/2/3/4/5_PreviousComments
BenefitType1/2/3/4/5_PreviousContributionComments
BenefitType1/2/3/4/5_PreviousContributionCurrency
BenefitType1/2/3/4/5_PreviousContributionEffectiveFrom
BenefitType1/2/3/4/5_PreviousContributionEffectiveTo
BenefitType1/2/3/4/5_PreviousContributionEmployeeActualForPeriod
BenefitType1/2/3/4/5_PreviousContributionEmployeeAnnual
BenefitType1/2/3/4/5_PreviousContributionEmployeePercentageOfSalary
BenefitType1/2/3/4/5_PreviousContributionEmployerActualForPeriod
BenefitType1/2/3/4/5_PreviousContributionEmployerAnnual
BenefitType1/2/3/4/5_PreviousContributionEmployerPercentageOfSalary
BenefitType1/2/3/4/5_PreviousContributionPayPeriod
BenefitType1/2/3/4/5_PreviousContributionTaxableAmountActualForPeriod
BenefitType1/2/3/4/5_PreviousContributionTaxableAmountAnnual
BenefitType1/2/3/4/5_PreviousContributionTotalValueActualForPeriod
BenefitType1/2/3/4/5_PreviousContributionTotalValueAnnual
BenefitType1/2/3/4/5_PreviousSchemeJoinDate
BenefitType1/2/3/4/5_PreviousSchemeLeaveDate
BenefitType1/2/3/4/5_PreviousSchemeName
BenefitType1/2/3/4/5_PreviousSchemeOfferDate
BenefitType1/2/3/4/5_PreviousSchemeProvider
BenefitType1/2/3/4/5_PreviousValidToJoinDate
Communication_AlternateEmail
Communication_ExternalEmail
Communication_HomeNumber
Communication_InternalEmail
Communication_MobileNumber
Communication_OtherNumber
Communication_PersonalMobileNumber
Communication_WorkExtension
Communication_WorkNumber
Compensation_CurrentActualForPeriod
Compensation_CurrentAnnualAmount
Compensation_CurrentBonusAmount
Compensation_CurrentBonusCurrency
Compensation_CurrentChangeReason
Compensation_CurrentCompItem
Compensation_CurrentCurrency
Compensation_CurrentEffectiveFrom
Compensation_CurrentEffectiveTo
Compensation_CurrentNextReviewDate
Compensation_CurrentProRataActualForPeriod
Compensation_CurrentProRataAnnualAmount
Compensation_CurrentProRataCurrency
Compensation_FutureActualForPeriod
Compensation_FutureAnnualAmount
Compensation_FutureBonusAmount
Compensation_FutureBonusCurrency
Compensation_FutureChangeReason
Compensation_FutureCurrency
Compensation_FutureEffectiveFrom
Compensation_FutureNextReviewDate
Compensation_FutureProRataActualForPeriod
Compensation_FutureProRataAnnualAmount
Compensation_FutureProRataCurrency
Compensation_PreviousActualForPeriod
Compensation_PreviousAnnualAmount
Compensation_PreviousBonusAmount
Compensation_PreviousBonusCurrency
Compensation_PreviousCurrency
Compensation_PreviousEffectiveFrom
Compensation_PreviousEffectiveTo
Compensation_PreviousNextReviewDate
Compensation_PreviousProRataActualForPeriod
Compensation_PreviousProRataAnnualAmount
Compensation_PreviousProRataCurrency
CompensationItem1/2/3/4/5_CurrentActualForPeriod
CompensationItem1/2/3/4/5_CurrentAnnualAmount
CompensationItem1/2/3/4/5_CurrentChangeReason
CompensationItem1/2/3/4/5_CurrentCompItem
CompensationItem1/2/3/4/5_CurrentCurrency
CompensationItem1/2/3/4/5_CurrentEffectiveFrom
CompensationItem1/2/3/4/5_CurrentEffectiveTo
CompensationItem1/2/3/4/5_CurrentNextReviewDate
CompensationItem1/2/3/4/5_CurrentProRataActualForPeriod
CompensationItem1/2/3/4/5_urrentProRataAnnualAmount
CompensationItem1/2/3/4/5_CurrentProRataCurrency
CompensationItem1/2/3/4/5_FutureActualForPeriod
CompensationItem1/2/3/4/5_FutureAnnualAmount
CompensationItem1/2/3/4/5_FutureChangeReason
CompensationItem1/2/3/4/5_FutureCurrency
CompensationItem1/2/3/4/5_FutureEffectiveFrom
CompensationItem1/2/3/4/5_FutureNextReviewDate
CompensationItem1/2/3/4/5_FutureProRataActualForPeriod
CompensationItem1/2/3/4/5_FutureProRataAnnualAmount
CompensationItem1/2/3/4/5_FutureProRataCurrency
CompensationItem1/2/3/4/5_PreviousActualForPeriod
CompensationItem1/2/3/4/5_PreviousAnnualAmount
CompensationItem1/2/3/4/5_PreviousCurrency
CompensationItem1/2/3/4/5_PreviousEffectiveFrom
CompensationItem1/2/3/4/5_PreviousEffectiveTo
CompensationItem1/2/3/4/5_PreviousNextReviewDate
CompensationItem1/2/3/4/5_PreviousProRataActualForPeriod
CompensationItem1/2/3/4/5_PreviousProRataAnnualAmount
CompensationItem1/2/3/4/5_PreviousProRataCurrency
ContractualSalaryLevel_CCNL
ContractualSalaryLevel_EffectiveFrom
ContractualSalaryLevel_EffectiveTo
ContractualSalaryLevel_Level
CostCentres_Name
EmploymentContracts_ContractName
EmploymentContracts_ContractTerm
EmploymentContracts_PayrollGroup
EmploymentContracts_PayrollSchedule
EmploymentDetails_AdjustedHireDate
EmploymentDetails_Company
EmploymentDetails_ContinuousServiceMonths
EmploymentDetails_ContinuousServiceYears
EmploymentDetails_DutyEntryDate
EmploymentDetails_EmploymentID
EmploymentDetails_EmploymentReason
EmploymentDetails_HireDate
EmploymentDetails_LastPaidDate
EmploymentDetails_LastWorkedDate
EmploymentDetails_NoticeGivenDate
EmploymentDetails_NoticePeriod
EmploymentDetails_NoticePeriodTimeUnits
EmploymentDetails_OriginalHireDate
EmploymentDetails_ProbationExtendedTo
EmploymentDetails_ProbationPeriod
EmploymentDetails_ProbationPeriodTimeUnits
EmploymentDetails_ProbationPeriodTo
EmploymentDetails_ProbationStatus
EmploymentDetails_RedundancyActualPayment
EmploymentDetails_RedundancyCurrency
EmploymentDetails_RedundancyDateStatementSent
EmploymentDetails_RedundancyNumberOfPaidWeeks
EmploymentDetails_RedundancyStatutoryPaymentDue
EmploymentDetails_TerminationDate
EmploymentDetails_TerminationReason
Grade_CurrentComments
Grade_CurrentDeploymentReason
Grade_CurrentEffectiveFrom
Grade_CurrentEffectiveTo
Grade_CurrentGrade
Grade_CurrentGradeCode
Grade_CurrentGradeGroup
Grade_FutureComments
Grade_FutureDeploymentReason
Grade_FutureEffectiveFrom
Grade_FutureEffectiveTo
Grade_FutureGrade
Grade_FutureGradeCode
Grade_FutureGradeGroup
Holiday_PlanName
HolidayPlan_AccrualEffectiveFrom
HolidayPlan_AccrualEffectiveTo
HolidayPlan_AccruedEntitlement
HolidayPlan_Adjustments
HolidayPlan_CarryOver
HolidayPlan_Remaining
HolidayPlan_Taken
HolidayPlan_Total
Jobs_Name
LegalIdentifiers_Authority
LegalIdentifiers_DocumentType
LegalIdentifiers_EffectiveFrom
LegalIdentifiers_EffectiveTo
LegalIdentifiers_Jurisdiction
LegalIdentifiers_NumberOrId
Locations_Name
NationalContractQualification_DirectManufacturing
NationalContractQualification_EffectiveFrom
NationalContractQualification_EffectiveTo
NationalContractQualification_Qualification
NationalContractQualification_Reason
OrgUnitPositions_BusinessTitle
OrgUnitPositions_DeploymentReason
OrgUnitPositions_EffectiveFrom
OrgUnitPositions_EffectiveTo
OrgUnitPositions_FutureBusinessTitle
OrgUnitPositions_FutureEffectiveFrom
OrgUnitPositions_FutureEffectiveTo
OrgUnitPositions_FutureManagerFamilyName
OrgUnitPositions_FutureManagerFamilyNamePrefix
OrgUnitPositions_FutureManagerFirstName
OrgUnitPositions_FutureManagerFullName
OrgUnitPositions_FutureManagerOfUnit
OrgUnitPositions_FutureOrgUnitName
OrgUnitPositions_FuturePositionTitle
OrgUnitPositions_FutureReason
OrgUnitPositions_FutureSupervisorFamilyName
OrgUnitPositions_FutureSupervisorFamilyNamePrefix
OrgUnitPositions_FutureSupervisorFirstName
OrgUnitPositions_FutureSupervisorFullName
OrgUnitPositions_ManagerofOrgUnitFamilyName
OrgUnitPositions_ManagerofOrgUnitFirstName
OrgUnitPositions_ManagerofOrgUnitFullName
OrgUnitPositions_ManagerofUnit
OrgUnitPositions_ManagerofOrgUnitFamilyNamePrefix
OrgUnitPositions_OrgUnitName
OrgUnitPositions_PositionTitle
OrgUnitPositions_SupervisorFamilyName
OrgUnitPositions_SupervisorFamilyNamePrefix
OrgUnitPositions_SupervisorFirstName
OrgUnitPositions_SupervisorFullName
OrgUnitPosition_SupervisorPositionTitle
PersonDetails_AdditionalFamilyNames
PersonDetails_AgeMonths
PersonDetails_AgeYears
PersonDetails_CityOfBirth
PersonDetails_DateOfBirth
PersonDetails_FamilyName
PersonDetails_FamilyNamePrefix
PersonDetails_FirstName
PersonDetails_FullName
PersonDetails_Gender
PersonDetails_KnownAs
PersonDetails_LegalName
PersonDetails_MiddleName
PersonDetails_Person Code
PersonDetails_Salutation
PersonDetails_SuffixTitle
RegularPay_CurrentAmount/Rate
RegularPay_CurrentBasedOn
RegularPay_CurrentBaseHourlyRate
RegularPay_CurrentCompanyName
RegularPay_CurrentEffectiveFrom
RegularPay_CurrentEffectiveTo
RegularPay_CurrentEmploymentID
RegularPay_CurrentLeaveAdjustments
RegularPay_CurrentMultiplier
RegularPay_CurrentMultiplier
RegularPay_CurrentPayrollCode
RegularPay_CurrentSchedule
RegularPay_CurrentTotal
RegularPay_FutureAmount/Rate
RegularPay_FutureBasedOn
RegularPay_FutureBaseHourlyRate
RegularPay_FutureCompanyName
RegularPay_FutureEffectiveFrom
RegularPay_FutureEffectiveTo
RegularPay_FutureEmploymentID
RegularPay_FutureLeaveAdjustments
RegularPay_FutureMultiplier
RegularPay_FutureMultiplier
RegularPay_FuturePayrollCode
RegularPay_FutureSchedule
RegularPay_FutureTotal
RegularPay_PreviousAmount/Rate
RegularPay_PreviousBasedOn
RegularPay_PreviousBaseHourlyRate
RegularPay_PreviousCompanyName
RegularPay_PreviousEffectiveFrom
RegularPay_PreviousEffectiveTo
RegularPay_PreviousEmploymentID
RegularPay_PreviousLeaveAdjustments
RegularPay_PreviousMultiplier
RegularPay_PreviousMultiplier
RegularPay_PreviousPayrollCode
RegularPay_PreviousSchedule
RegularPay_PreviousTotal
WorkingAndScheduledTime_Comments
WorkingAndScheduledTime_DayFTEHours
WorkingAndScheduledTime_DayHours
WorkingAndScheduledTime_FTERatio
WorkingAndScheduledTime_Name
WorkingAndScheduledTime_WeekFTEHours
WorkingAndScheduledTime_WeekHours