Create a document
Create a Smart Document template in Settings, choose an object type, optionally import a .docx file, and open the TipTap editor.
Creating a smart document means adding a new template on Settings → Communication & Documents → Documents: you name it, choose which kind of record it applies to (Object Type), optionally import a Word file, and land in the TipTap editor to write the document.
Why it matters
Every certificate, contract, or official letter your institution issues from Fuxam starts as a template. A clear object type, a name your team recognises, and a first draft you can build on save rework when registrars generate documents for a whole intake.
Templates are reusable. One enrollment confirmation can serve every cohort when its variables pull from data kept in User Management and Study programs and cohorts.
Before you start
| Requirement | Detail |
|---|---|
| Feature | The Smart Documents feature (part of the FuxamCMS package) must be active for your institution. |
| Permission | You need the permission read-write:settings-service-contracts. |
| Object Type decision | Pick the type that matches the data you need: User, Module, Curriculum, Room, or Certificate. |
| Custom fields ready | If the document needs institution-specific attributes, create the custom columns first. |
| Optional Word file | A .docx file up to 5 MB if you want a head start. PDF files are not accepted. |
Object types
| Object Type | Typical data | Common documents |
|---|---|---|
| User (default) | Profile, custom fields, program and cohort, time tracking, institution data | Enrollment confirmations, study contracts, letters |
| Module | Module version and its submodules from Modules | Module description sheets |
| Curriculum | Curriculum data from Curricula | Curriculum overviews |
| Room | Room details from Rooms | Room or facility sheets |
| Certificate | Course-completion data | Completion certificates |
How to create a template
Go to Settings → Communication & Documents → Documents.
In the Smart Documents table, select Create Template. The Create Template sheet opens ("Create a new smart document.").
Enter a Name, for example "Enrollment confirmation 2026". Use a name your colleagues recognise in lists and pickers.
Choose the Object Type. The default is User.
Optional: under Template Document (optional), upload a .docx file to start with its headings, paragraphs, lists, tables, and bold text. If the import fails, check that the file is a valid .docx under 5 MB.
Select Create Template. A "Document created" message appears and the TipTap editor opens so you can write and structure the document.
To create a certificate template, use Create Certificate in the Certificate Documents section. The object type is then fixed to Certificate. See Study contracts and certificates.
Best practices
- Match the object type to the audience. Enrollment letters and contracts are almost always User templates. Module sheets use Module.
- Name templates for staff. Add purpose and year, for example "Study contract 2026".
- Import Word only when it saves time. Clean up the imported text in the editor before you save.
- Add variables and form fields straight away. A template with a Form Fields count of zero has nothing for assignees to fill in.
- Prepare custom columns first. Missing data shows up as empty values in the document.
Common pitfalls
| Pitfall | How to avoid it |
|---|---|
| Wrong object type | Create a new template with the right type. The type cannot be changed later. |
| Uploading a PDF | The import accepts .docx only. Export or save your design as Word first. |
| Expecting the Word layout to survive | Only text structure is kept. Rebuild fonts, headers, and footers in the editor and in Page setup. |
| Duplicate names | Similar names confuse pickers. Use distinct Name values. |
| Missing permission | Without read-write:settings-service-contracts the page and the create action are not available. |
FAQ
Do I need a template for every study program?
Not necessarily. One User template can pull program and cohort data from each user. Create separate templates only when the wording or layout differs.
Do I have to import a Word file?
No. The import is optional. You can create an empty template and write everything in the editor.
Can I change the object type later?
No. The object type is chosen at creation. Create a new template if you need a different one.
Where do I generate documents afterwards?
Administrators use Campus Management → User Management → [User] → Documents, or the Smart Document action in the Users table for many users. See Generate documents in bulk.