All Collections
Acceptance & enrolment
Letters
How to create a letter – Part 1 – Merge fields: substituting student and product information into letters
How to create a letter – Part 1 – Merge fields: substituting student and product information into letters

Learn what merge fields are and their names in FULL FABRIC in order to personalise your documents

Cláudia Duarte avatar
Written by Cláudia Duarte
Updated over a week ago

For documents with variable information that frequently changes, what you need is a way to generate dynamic content for each recipient and transfer data directly from Full Fabric to the final doc, as that will let you push out hundreds of letters for the effort of one. The solution is using merge fields, and that's what this article is about.

(Pshhh, have you read our introductory article to Letters? If you haven't, check it out here, but if you have, proceed in peace. 🙏 🏳 )

What are merge fields?

A merge field is a tag representing a field in Full Fabric that will get replaced with the field’s content when a letter is generated for a profile.

To create letter templates in Full Fabric, you need to create a Microsoft Word documents with merge fields and then upload these as letter templates to Full Fabric. Merge fields are inserted inside the MS Word document through Word's Mail Merge feature (after which they take their name).

Merge fields allow you to create personalized documents with specific information about the particular student and their chosen product.

Export your school’s merge field references

The first step for generating letter templates is creating a Microsoft Word document that contains mail merge fields named with the appropriate field reference. Full Fabric provides a list of field references for easy searching. To access it:

     1) Click the gear in the top-right corner and then General settings
     2) Open the Documents tab
     3) Press Download field references

You'll get a Word document that looks something like this:

The file was designed to be self-explanatory, so every tag has a description. The Description is on the left while the Name of the reference field is on the right. That said, some of the field references in the file are not meant for letters, so please just consider these four sections: GENERAL, PROFILE, PROGRAMME and CLASS.

Merge fields for profile fields

Any profile field on your school's profile schema i.e. fields that appear in the info tab of a profile e.g. first name, can be used as merge fields. Please refer to the field references export for the field reference for your school's fields.

Merge fields for class/course/campus information for a profile's journey

You can pull information related to the class/course information of a profile's journey when generating a letter. This includes standard fields as well as class/course schema fields which are particular to your school.

=programme.name

=class.name

=class.start_date

=class.end_date

=class.price

=class.__class_schema_field_name

=subject.name

=course.name

=course.start_date

=course.end_date

=course.price

=course.__course_schema_field_name

=campus.name

=campus.__campus_schema_field_x

Merge fields for a profile's journey fields

It's also possible to substitute information for the journey fields on a profile's journey. Please ask Full Fabric support for the field references for your school's journey fields.

The format of the fields is:

=journey.__journey_schema_field_name

Merge field modifiers

It's possible to add the following modifiers to merge fields for schema fields to generate information in a specific language/date format etc.

Modifiers for language for date, country, drop down, checkbox and cascading drop down fields:

IMPORTANT: Please note that these must always be placed at the end of the merge field, even when other merge fields modifiers are used e.g. _as_long_format_in_en-gb

  • British English - _in_en-gb

  • Danish: _in_da-dk

  • Dutch: _in_nl

  • French: _in_fr-fr

  • German: _in_de-de

  • Italian: _in_it-it

  • Spanish: _in_es-es

Modifiers for different date formats

These modifiers can be applied to date schema fields, class/course dates, and todays date.

  • _as_long_format e.g. 27 July, 1994

  • _as_ddmmyyyy e.g. 27/07/1994

  • _as_yyyymmdd e.g. 1994/07/27

Examples for long format in different languages

  • British English: =profile.__date_of_birth_as_long_format_in_en-gb (example: 27 July, 1994)

  • Danish: =profile.__date_of_birth_as_long_format_in_da-dk (example: 27. juli 1994)

  • Dutch: =profile.__date_of_birth_as_long_format_in_nl (example: 27 juli 1994)

  • French: =profile.__date_of_birth_as_long_format_in_fr-fr (example: 27 juillet 1994)

  • German: =profile.__date_of_birth_as_long_format_in_de-de (example: 27. Juli 1994)

  • Italian: =profile.__date_of_birth_as_long_format_in_it-it (example: 27 luglio 1994)

  • Spanish: =profile.__date_of_birth_as_long_format_in_es-es (example: 27 de julio de 1994)

Produce a list of the selected checkbox or drop down field options

This merge field loop prints the selected checkbox or drop down field offer as a list into the letter:

Merge field format

profile.__checkbox_field_name_array:each(option)

=option

profile.__checkbox_field_name_array:endEach

Letter template example

Please find the conditions that you must meet for your scholarship below:

profile.__scholarship_conditions_checkbox_array:each(option)

  • =option

profile.__scholarship_conditions_checkbox_name_array:endEach

Printed letter example

Please find the conditions that you must meet for your scholarship below:

  • Copy of parent's income

  • Official diploma certificate for your Bachelor's degree with attainment of first degree

Modifiers for cascading drop down fields

These modifiers can be applied to cascading drop down fields

  • _as_long_format

  • .sub_field_name

Letter template and printed letter examples

Please see the examples for an "Industry and job" cascading drop down field with "Industry" and "Job as sub-fields where the selection for "Industry" is "Education" and "Job is "Teacher.

Merge field example

Printed merge field example

=profile.__industry_and_job

Education, Teacher

=profile.__industry_and_job_as_long_format

Industry: Education

Address: Teacher

=profile.__industry_and_job.job

Teacher

Merge fields for a profile's payment plan

These merge fields print the chosen profile payment plan as a table into the letter

Letter template and printed letter examples

=payment_plans

=payment_plans_with_discounts

Merge fields for a profile's offer

This merge field loop prints the conditions of the chosen offer as a list into the letter:

Merge field format

offers.conditional_offer_template_name.conditions:each(condition)

=condition.label

=condition.description

offers.conditional_offer_template_name.conditions:endEach

Letter template example

Please find the conditions that you must meet for your offer below:

offers.conditional_offer_name.conditions:each(condition)

  • =condition.label - =condition.description

offers.conditional_offer_name.conditions:endEach

Printed letter example

Please find the conditions that you must meet for your offer below:

  • Proof of proficiency in English - You must provide proof of an IELTS score above 6

  • Proof of Bachelor's degree - You must provide the official diploma certificate for your Bachelor's degree

Merge fields for a profile's enrolment plan

This merge field loop prints the courses of an enrolment plan into the letter:

Letter template and printed letter example

What if there are conditions, deadlines, costs or other details in the letter that are mutable?

Whenever a letter contains bits of information that may change over time, you don't have to revise and reupload the Word document whenever an update is due. Instead, you can actually convert the "intel" into custom merge fields. Since merge fields are named after field references, what follows is that you need to create input fields in a special schema called Ask representing the changeable details you wish to divulge in the letter; and as a result, the act of generating a letter will prompt a pop-up window with those same input fields, so that you may fill them with the latest data. To display the information where in the letter you want it, just place the respective merge fields into the .docx document as you normally would.

To access the Ask schema:

     1) Tap the gear in the top-right corner and then General settings
     2) Open the Documents tab, which will land you in the Letter Templates tab
     3) Click the gear next to the desired letter template and then Schema

In the image above, two questions were created: Deadline for paying 1st tuition fee and Amount. You can see their field codes in light grey: __deadline_for_paying_the_1st_tuition_fee and __amount.

Meanwhile, getting back to the field references file, you can now make sense of the following item:

As the prefix indicates, it's related to the Ask schema. So, going by the structure that's given, you just have to replace the word condition with the field code, like so:

ask.__deadline_for_paying_1st_tuition_fee
ask.__amount

Then, when you add the Ask merge fields to your Word document, upload it to Full Fabric and generate a letter, you'll get a pop-up window like this:

The outcome being that the inputted values (15-11-2019 and $1000, in the example above) will replace the tags in the letter. 👍 So convenient, right?!


_________________

PUBLISHED: June 22, 2020
LAST UPDATED: July 6, 2022 at 8:22 p.m.

Did this answer your question?