Merge Fields
A merge field marks a place in a Word template where Full Fabric puts data when a document is generated. Merge fields are inserted in Word as MERGEFIELD fields (Insert > Quick Parts > Field > MergeField in Word), with a field name that starts with =:
| Field name | Becomes |
|---|---|
=profile.first_name |
The profile's first name |
=class.name |
The name of the class the letter is generated for |
=today |
Today's date, in long form |
A field name is a path: the group first (profile, class, course), then the field. Fields of the institution's schemas (profile fields, class fields, application fields) use the field's name in the schema.
Finding Field Names
On Settings > Templates & documents > Documents, click Download field references. This downloads a Word document that lists the merge fields of the institution, with their description, section by section: general fields, profile, profile owner, academic and professional experience, programme, class, course, subject, application templates, evaluation templates, the enrolment plan, and transcript courses. It is built from the institution's own schemas, so custom fields are included.
Field Groups
What a letter can show depends on what it is generated for. The profile, the institution, and the staff member generating the letter are always available. The other groups are only filled in when the letter is generated with an application, a class, a course, or a transcript.
| Group | Prefix | Available when | Examples |
|---|---|---|---|
| Letter | — | Always | =today, =today_as_yyyymmdd, =today_as_ddmmyyyy |
| Institution | institution |
Always | =institution.name, =institution.long_name, =institution.logo_url |
| Profile | profile |
Always | =profile.first_name, any profile field |
| Generated by | staff |
Always | The staff member who generated the letter |
| Signatures | signature |
Always | =signature.full, =signature.initials, =signature.date, =signature.location |
| Application | applic |
Generated with an application | =applic.<document>.<field>, fields of the application's documents |
| Class | class |
Generated with a class, or an application or transcript in a class | =class.name, =class.long_name, =class.name_with_programme, =class.price |
| Programme | programme |
Same as class | =programme.name |
| Course | course |
Generated with a course, or an application or transcript in a course | =course.name, =course.credits, =course.price, =course.subject_code |
| Subject | subject |
Same as course | =subject.name, =subject.code |
| Journey | journey |
Generated with a class or course | The profile's journey in that class or course |
| Journey owner | profile_owner |
Same as journey | The journey owner's profile fields |
| Journey campus | campus |
Same as journey | The journey's campus |
| Transcript | transcript |
Transcript templates | =transcript.final_grade_percentage, =transcript.degree_class, credits totals |
Classes and courses have start_date and end_date, each in three forms: =class.start_date (long form), =class.start_date_as_yyyymmdd, and =class.start_date_as_ddmmyyyy.
Other Data
Letters can also show:
- Payment plans —
=payment_plans(a table of the profile's payment plans) and=payment_plan(the payment plan chosen when generating the letter), with their payers, fees, discounts, and instalments - Offers —
=offers.<offer template>.nameand=offers.<offer template>.conditionsfor the class's offers - Enrolment plan — the courses of the profile's enrolment plan, as a list
Ask Fields
An Ask field takes its value from staff when the letter is generated, rather than from a record. Write it as =ask.<name>, for example =ask.condition or =ask.scholarship_amount.
Uploading the template creates the Ask fields it contains in the template's schema, where they can be labelled and typed (see Templates). Staff fill them in on the Create a letter window. The automation Send letter action has no Ask values to give, so Ask fields stay empty in letters it generates.
Images
An image field replaces a placeholder picture. Place any picture in the template, then put a field named @profile.photo:start before it and @profile.photo:end after it. The profile's photo replaces the picture.
Lists and Tables
A list repeats a block of the template once per item. Start the block with a field named =<list>:each(<item>) and end it with =<list>:endEach. Inside the block, use the item's fields:
=enrolment_plan.courses:each(course)
=course.name =course.credits =course.start_date
=enrolment_plan.courses:endEach
Signature Fields
The signature fields mark where each signer signs, initials, and dates the letter. =signature.* is for the first signer; =signature2.* to =signature100.* are for the next signers, in signing order. See Digital Signatures.
Related
- Templates
- Letters
- Custom Fields — the profile fields that templates can use