Templates

Templates are Word documents that staff design in Word, with merge fields where data should go, and upload to Full Fabric. They are managed under Settings > Templates & documents > Documents, which needs documents.setup_templates. See Merge Fields for what to write inside a template.

Creating a Template

  1. Open the tab for the template type: Letter Templates, Application Export Templates, Transcript Templates, or HESA Report Templates.
  2. Click Create a new template.
  3. Enter a Description. This is the name staff see when they choose the template, and it is part of each generated file's name.
  4. Under Template, click Choose file and select the .docx file.
  5. For a letter template that must be signed, tick Requires digital signature (see Digital Signatures).
  6. Click Create template.
Rule Detail
File format Only .docx is accepted. A HESA report template is an .xml file.
Description Required
Requires digital signature Only shown when DocuSign or PandaDoc is set up for the institution

The template list shows each template's Description, File, Created by, and Requires Signature.

Replacing the File

Open the template to see its Template details. Upload a new file under Template to replace the Word document. Letters already generated keep the content they were generated with.

Letter Templates

Letter templates produce the letters stored on a profile's Letters tab (see Letters). A letter template has two tabs:

Tab Contents
Details Description, file, and the digital signature setting
Schema The template's Ask fields: values staff type in each time they generate the letter

Ask Fields

When a template is uploaded, every =ask.<name> merge field in it creates a field in an Ask section of the template's schema. On the Schema tab, staff edit these fields and add more. The field types offered are single line text, paragraph text, dropdown, date, date and time, and country.

When a letter is generated from the template, these fields are asked for before the letter is produced. See Merge Fields.

Previewing

Each letter and application export template in the list has Preview as Docx and Preview as PDF icons. The preview asks for the template's Ask fields, then generates the document for the staff member's own profile, with no application, class, or course. Use it to check the layout and the profile fields: a preview has no application, class, or course to take their fields from.

Application Export Templates

An application export template sets the layout used when an application is downloaded as a PDF. On a profile, the Download application window offers Choose a template or leave it blank for default. Leaving it blank uses the platform's standard layout.

Application export templates can use the application's own fields as well as the profile, class, and course fields (see Merge Fields).

Transcript Templates

Transcript templates produce transcripts for students' registrations and grades. They need affairs.academic_services_transcripts_change. On top of the file and description, a transcript template has these options:

Option Effect
Show reference for final grade (*) Marks courses that do not count towards the final grade
Show reference for credits (†) Marks courses that do not count towards credits
Allow Students to download this transcript template? Lets students download their own transcript with this template
Only include courses Limits the transcript to courses that have published grades, have a final grade, count towards the final grade, or that the student has passed

Students only see the templates that allow student downloads. See Transcripts for how transcripts are generated and sent.

HESA Report Templates

HESA report templates produce the XML returns UK institutions send to HESA. The tab only appears when the HESA report feature is enabled for the institution.

Setting Purpose
Mapping template Downloads a CSV file to fill in with how Full Fabric values map to HESA codes
Upload HESA values mapping Uploads the completed mapping
Products The classes and courses the report covers
Filter segment Limits the report to the profiles in a segment, or No filter
Upload HESA report schema validator file (.xsd) The HESA schema the report is checked against

Generate downloads the XML report. If the report does not pass the schema check, the errors are listed as comments at the top of the file.

Note: HESA templates use {{ }} placeholders in the XML, not Word merge fields.