19 August 2024

What are the fields used in communication templates?

The available fields are grouped for fields for the applicant, application, decision, institution, and email subject. Fields are objects in Liquid and are enclosed in double curly brackets. For example, {{ApplicantReferenceNumber}}. For more information, go to Liquid Introduction .

Avoid mailmerge fields in the email subject as the mailmerge fields may result in long subjects, which may cause fail to send issues.

The fields are organised for the following areas:

Applicant

The table Applicant details the fields available on applicants to use in communication templates and which fields can be localised.

Applicant

Field

Applicant

Example value

Can be localised?

ApplicantAddress1

Address line 1

48 Main Street

Not applicable

ApplicantAddress2

Address line 2

Hessle

Not applicable

ApplicantAddress3

Address line 3

Near Hull

Not applicable

ApplicantAddress4

Address line 4

East Riding of Yorkshire

Not applicable

ApplicantAddress5

Address line 5

United Kingdom

Not applicable

ApplicantEmail

Applicant's preferred email in the communication methods

nadia.rajeshwar@tribalgroup.com

Not applicable

ApplicantName

Given name

Nadia

Not applicable

ApplicantPostcode

Postcode

HU12 8HQ

Not applicable

ApplicantReferenceNumber

Student code

10000345

Not applicable

DateOfBirth

Date of birth

08/08/1980

Not applicable

FamilyName

Surname

Rajeshwar

Not applicable

LegalFullName

Legal full name

Nadia Neto Rajeshwar

Not applicable

Nationality1AtRisk and Nationality2AtRisk

Nationality is at risk is an option defined in the reference data for the nationality.

True

Not applicable

Nationality1Code and Nationality2Code

Code for the nationality in reference data.

608

Not applicable

PreferredFullName

Preferred name

Nadia

Not applicable

TitleCode

Title code

DR

Not applicable

TitleDescription

Title

Dr.

Yes

UcasStudentReferenceNumber

UCAS personal ID

541-845-7885

Not applicable

Application

The table Application details the fields available on applications to use in communication templates.

Application

Field

Application

Example value

Can be localised?

AcademicYearCode

Year code

2023/4

Not applicable

AcademicYearDescription

Year

2023/4

Not applicable

AdmissionsEntrySystemCode

Admissions entry system

Code for the admissions system, where D is direct, E is TISC, and U is UCAS.

Not applicable

AdmissionsProgrammeCode

Programme code

PD-ADNURSE

Not applicable

AdmissionsProgrammeDescription

Programme

Adult nursing PGDip

Yes

ApplicantFeeStatusFullName

Fee status

European student (EU)

Yes

ApplicationExpectedEndDate

Expected end date

08/08/1980

Not applicable

ApplicationStartDate

Start date

08/08/1980

Not applicable

CourseOptionLength

Course length

Numerical value for course length, such as 3.

Not applicable

DeferralRequestApplicantFacingFeedback

Feedback for the application on the outcome of a deferral request

Your request for deferral has been approved

Not applicable

DeferralRequestOutcomeDescription

Outcome of a deferral request

Approved or Rejected

Yes

EntryPointCode

Entry point code

PD-ADNURSE-2022-09-01

Not applicable

EntryPointExpectedEndDate

Entry point expected end date

31/08/2023

Not applicable

EntryPointOccurenceFullName

Entry point name

Standard September Intake

Yes

EntryPointStartDate

Entry point start date

01/09/2022

Not applicable

EntryPointStartDate

Entry point start date

01/09/2022

Not applicable

FeeStatusQuoteTotal

Quote total

9250. The quote total for consists of the numerical value only. Therefore, add the currency symbol, such as £ or $, in the template before the quote total. For example, £%%QuoteTotal%%.

Not applicable

ModeFullname

Mode of attendance

Full time

Yes

ProgrammeTitle

Programme name

Postgraduate Diploma - Nursing Studies (Registered Nurse - Mental Health) PGDip - Full Time

Yes

RouteCode

Route code

EA0001-1

Not applicable

RouteDescription

Route description

Nursing Studies (Registered Nurse - Adult Nursing) PGDip - Full Time

Yes

UnitOfMeasurementCode

Code for unit of measurement

1

Not applicable

UnitOfMeasurementDescription

Unit measurement

Years

Yes

Credit offers

The table Credit offers details the fields to add information related to credit offers as used in the Credit offer email.

Credit offers

Field

Description

Can be localised?

ApplicationCreditOffers

Credit offers.

Not applicable

CreditText

Reason for the decision on the credit offer.

Not applicable

CreditOfferElements

Modules and Blocks in the credit offer.

Not applicable

LevelDescription

Blocks of the credit offer.

Not applicable

NumberOfLevelCredits

Number of blocks credits in credit offer.

Not applicable

UnitCode

Module code.

Not applicable

UnitDescription

Modules of the credit offer.

Not applicable

UnitPercentage

Percentage of the credit.

Not applicable

Decision

The table Decision details the fields on decisions of applications available to use in communication templates and which fields can be localised.

Decision

Field

Application

Example value

Can be localised?

AdditionalConditionsOfferText

Additional conditions

Evidence of your English language qualifications and any associated score

Yes

Decision

Decision type

Offer

Yes

Decision1Code

Decision 1

C

Not applicable

Decision1Date

Decision 1 date

08/08/1980

Not applicable

Decision2Code

Decision 2

U

Not applicable

Decision2Date

Decision 2 date

08/08/1980

Not applicable

DecisionFeedback

Decision feedback

This a good application

Not applicable

IsOfferConditional

Is the offer conditional?

true. For example, % if IsOfferConditional == true -%

Not applicable

OfferText

Main decision

BBC including biology, and geography or physics

Yes

RespondBy1Date

Respond 1 by date

08/08/1980

Not applicable

RespondBy2Date

Respond 2 by date

08/08/1980

Not applicable

Response1Code

Response 1

F

Not applicable

Response1Date

Response 1 date

08/08/1980

Not applicable

Response2Code

Response 2

D

Not applicable

Response2Date

Response 2 date

08/08/1980

Not applicable

Institution

The table Institution details the fields on the institution available to use in communication templates.

Institution

Field

Institution

Description

Can be localised?

Institutionname

Description

Hessle uni

Yes

InstitutionOfficialname

Official name

University of Hessle

Yes

Personalised offers

The table Personalised offers details the fields to add personalised offer evidence information to offer letters.

Personalised offers

Field

Description

Can be localised?

ApplicationConditionalOfferEvidenceClearanceChecks

Collection of clearance check types and instructions used for personalised offers.

Yes

ClearanceCheckTypeDescription

Description of the clearance check type as defined in reference data.

Yes

ClearanceCheckApplicantInstructions

Instructions for the applicant defined when adding personalised offer evidence to an application in decision making.

Not applicable

ClearanceCheckDocumentTypeDescriptions

Array of the Document type reference data descriptions associated with the clearance check.

Yes

Visa sponsorship

The table Visa sponsorship details the fields in communication templates used with Visa sponsorship. Localising fields is not applicable as used with UKVI only.

Visa sponsorship
Field Description Example value Can be localised?

ApplicantPassportOrTravelDocumentNumber

Passport number

123456789

Not applicable

CountryOfBirthCode

Code of the country of birth

PRT

Not applicable

CourseDetails.AcademicLevelName

Course level

SCQF level 6

Not applicable

CourseDetails.ApplicantHasWorkPlacement

Work placement required

True

Not applicable

CourseDetails.CourseCurriculumTitle

Course title

Modern Languages BA (Hons)

Not applicable

CourseDetails.CourseIsFullTime%

Course is full time

False

Not applicable

CourseDetails.CourseStartDate

Course start date

22/09/2026

Not applicable

CourseDetails.ExpectedCourseEndDate

Course end date

31/05/2028

Not applicable

CourseDetails.LatestDateForAcceptanceOnCourse

Latest date of acceptance on course

30/09/2025

Not applicable

CourseDetails.MainSiteOfStudyAddressLine1

CourseDetails.MainSiteOfStudyAddressLine2

CourseDetails.MainSiteOfStudyAddressLine3

CourseDetails.MainSiteOfStudyPostCode

CourseDetails.MainSiteOfStudyCity

CourseDetails.MainSiteOfStudyCountryAreaDistrict

Location of study

The Campus Hessle

East Yorkshire

HU31 3ZT

Not applicable

CourseDetails.SecondaryAcademicLevel

Secondary course level

CEFR C2

Not applicable

DateOfBirth

Date of birth

03/052003

Not applicable

Documentation.CourseRequiresAtas

ATAS required

False

Not applicable

Documentation.DocumentsUsedToObtainOffer

Documentary evidence used for offer

Certificate

Not applicable

Documentation.PostgraduateDeanCertificateRequired

Postgraduate dean certificate required

False

Not applicable

EvidenceDetails.CurrentPreviousCourseLevelComparisonName

EvidenceDetails.CurrentPreviousCourseLevelComparison

Course higher, lower, or same level as previous course

Higher

Not applicable

EvidenceDetails.EnglishLanguageLevelAttainedName

English language level attained

Higher

Not applicable

EvidenceDetails.PreviousAcademicLevelName

Previous course level

CEFR C2

Not applicable

EvidenceDetails.PreviousUKStudy

Previously a UK student

Yes

Not applicable

EvidenceDetails.ProgressionJustification

Progression justification for course being applied for

Some reason

Not applicable

EvidenceDetails.ReasonSeltNotRequiredName

Reason SELT not required

Native speaker

Not applicable

EvidenceDetails.SeltListeningLevel

SELT - Listening

B1

Not applicable

EvidenceDetails.SeltReadingLevel

SELT - Reading

B1

Not applicable

EvidenceDetails.SeltRequired

SELT required

B1

Not applicable

EvidenceDetails.SeltSpeakingLevel

SELT - Speaking

B1

Not applicable

EvidenceDetails.SeltWritingLevel

SELT - Writing

B1

Not applicable

EvidenceDetails.TestProviderName

English language test provider

Some Provider

Not applicable

FamilyName

Family name

Larter

Not applicable

FinancialAndAccommodationDetails.AccommodationFeesPaidToDate

Accommodation fees paid to date

5200

Not applicable

FinancialAndAccommodationDetails.AccommodationProvided

Accommodation provided

Yes

Not applicable

FinancialAndAccommodationDetails.CourseFeeIncludesAccommodationCosts

Course fees includes accommodation or boarding costs

Yes

Not applicable

FinancialAndAccommodationDetails.BoardingFeesPaidToDate

Boarding fees paid to date

3350

Not applicable

FinancialAndAccommodationDetails.BoardingFeesForFirstYearOnly

Boarding or accommodation fees for first year

7200

Not applicable

FinancialAndAccommodationDetails.CourseFeesForFirstYearOnly

Course fees for first year

9250

Not applicable

FinancialAndAccommodationDetails.CourseFeesPaidToDate

Course fees paid to date

4600

Not applicable

GenderName

Gender

Male

Not applicable

GivenName

Given name(s)

Andrew

Not applicable

NationalityCode

Nationality

AFG

Not applicable

NonSponsorEducationInstitutionData.OverseasHEInstitutionAddressLine1

NonSponsorEducationInstitutionData.OverseasHEInstitutionAddressLine2

NonSponsorEducationInstitutionData.OverseasHEInstitutionAddressLine3

NonSponsorEducationInstitutionData.OverseasHEInstitutionCity

NonSponsorEducationInstitutionData.OverseasHEInstitutionCountryAreaDistrict

NonSponsorEducationInstitutionData.OverseasHEInstitutionPostCode

NonSponsorEducationInstitutionData.OverseasHEInstitutionCountryCode

Overseas institution address

Avenida 5 de Outubro

Lisboa

2400-390

PRT

Not applicable

NonSponsorEducationInstitutionData.OverseasHEInstitutionName

Overseas institution name

CRIL

Not applicable

NonSponsorEducationInstitutionData.PartnerInstitutionAddressLine1

NonSponsorEducationInstitutionData.PartnerInstitutionAddressLine2

NonSponsorEducationInstitutionData.PartnerInstitutionAddressLine3

NonSponsorEducationInstitutionData.PartnerInstitutionCity

NonSponsorEducationInstitutionData.PartnerInstitutionCountryAreaDistrict

NonSponsorEducationInstitutionData.PartnerInstitutionPostCode

NonSponsorEducationInstitutionData.PartnerInstitutionCountryCode

Partner institution address

Calle Prado, 45

Salamanca

37002

Espana

ESP

 

Not applicable

NonSponsorEducationInstitutionData.PartnerInstitutionName

Partner institution name

CREL

Not applicable

NonSponsorEducationInstitutionData.SponsorLicenseNumber

Partner institution sponsor licence number

4345344

Not applicable

OtherNames

Other names

Hale

Not applicable

PlaceOfBirth

Place of birth

Atlanta

Not applicable

RequestStatus

CAS status

Assigned

Not applicable

SponsorLicenceNumber

Sponsor licence number

4344222

Not applicable

StudentCode

Student ID

55334423

Not applicable

UcasUkPassId

UCAS ID number

4532455

Not applicable

UkviCasNumber

CAS number

49543

Not applicable

WorkPlacementDetails.WorkPlacementAddressLine1

WorkPlacementDetails.WorkPlacementAddressLine2

WorkPlacementDetails.WorkPlacementAddressLine3

WorkPlacementDetails.WorkPlacementCity

WorkPlacementDetails.WorkPlacementCountryAreaDistrict

WorkPlacementDetails.WorkPlacementPostCode

WorkPlacementDetails.WorkPlacementCountryCode

Work placement address

48 The Woods

Hessle

East Yorkshire

HU23 4ZT

GBR

Not applicable

WorkPlacementDetails.WorkPlacementPercentage

Work placement percentage

70

Not applicable

WorkPlacementDetails.WorkPlacementPercentageJustification

Work placement justification

Some reason

Not applicable

System parameters

The table System parameters details system parameters that can be used on email templates.

System parameters

System parameter

Description

Example

SystemParameters.Gateway_URL

Add a URL link to the gateway

Hessle University's gateway URL is https://identity.tribaledge.com/emea/ids/hessle/. Instead of entering the full URL on a link the system parameter can be used.

Example link to the gateway

Add a URL link to the gateway on an email template. For example:

<a href="{{SystemParameters.Gateway_URL}}">Link</a>

When an email is sent using the template, the Link on the email is set to:

https://identity.tribaledge.com/emea/ids/hessle/

Example link to the Academic Reviews app

Add a URL link to the Academic reviews app on an email template by using the system parameter for the gateway followed by the URL details to go to the Academic reviews app. For example:
<a href="{{SystemParameters.Gateway_URL}}academicreviews">Link</a>
When an email is sent using the template, the Link on the email is set to:

https://identity.tribaledge.com/emea/ids/hessle/academicreviews

SystemParameters.Portal_URL

Add a URL link to the portal

Hessle University's portal URL is https://portal.identity.tribaledge.com/emea/ids/hessle/. Instead of entering the full URL on a link the system parameter can be used.

Add a URL link to the portal onto an email template, instead of entering the link details you can use the system parameter for the portal to enter the link details. For example:
<a href="{{SystemParameters.Portal_URL}}">Link</a>
When Hessle sends an email using the template, the Link on the email is set to:

https://portal.identity.tribaledge.com/emea/ids/hessle/

SystemParameters.LanguageCode

Set the template content to the system language, which is English or Welsh.

Set the template content to use the system language for the template, such as <html lang = "{{SystemParameters.LanguageCode}}">

SystemData.InvitationUrl

Add a URL link to register for the applicant portal

Hessle Universities registration URL for the applicant portal is https://emukproductionb2chessle.b2clogin/emukproductionb2chessle.onmicrosoft.com/B2C_1_signupsignin. Instead of entering the full URL on a link the system parameter can be used.

Example link to the applicant portal registration

Add a URL link to the applicant portal registration on an email template. For example:

<a href="{{SystemData.InvitationUrl}}">Link</a>

When an email is sent using the template, the Link on the email is set to:

https://emukproductionb2chessle.b2clogin/emukproductionb2chessle.onmicrosoft.com/B2C_1_signupsignin