Skip to content
Esc
↑↓navigate↵open⌘Jpreview
On this page

Smart documents

Smart documents are templates for letters, contracts, and certificates written in the TipTap editor and filled with real data — managed in Settings and generated from user profiles, in bulk, or by self-service.

Smart documents are templates for letters, contracts, and certificates that Fuxam fills with real data. You manage them on Settings → Communication & Documents → Documents and generate them from Campus Management → User Management.

Why it matters

Official paperwork is repetitive and error-prone. With smart documents you write it once in a visual editor, insert variables for names, dates, and program data, and generate a correct version for each person. Changes are versioned, so you can see and restore earlier states.

How this fits

Smart documents use data from User Management, Study programs and cohorts, and Time tracking. Students can see their self-service documents from the Management tab.

Before you start

Requirement Detail
Feature Smart Documents in the FuxamCMS package. See Permissions and features.
Permission read-write:settings-service-contracts to create, edit, and manage templates.
Location Settings → Communication & Documents → Documents. The page title is "Smart Documents".

Key concepts

Concept Meaning
Template A document design with text, variables, and form fields.
Object Type The kind of record a template uses: User, Module, Curriculum, Room, or Certificate.
Variable A placeholder replaced with real data when the document is generated.
Form field An input someone fills in when completing the document. Counted in the Form Fields column.
Version A saved, published state of a template. Visible under Versions in the editor.
Default The template preselected when you add a document.
PDF template An older template type. It still works and appears in the same table. New templates use the TipTap editor.

Ways to generate documents

Route Who Where
Single Staff Campus Management → User Management → [User] → Documents → Smart Document
Bulk Staff Users table → Smart Document action
Self-service Eligible users Set up in the Self-Service Documents section
Study contract Applicants Assigned to application forms in Study Contracts
Certificate Students Certificate template chosen in the course

In this section

Examples

Practical how-tos for typical documents:

Who does what

Role Typical tasks
Administrators with read-write:settings-service-contracts Create and edit templates, set defaults, configure self-service and study contracts.
Registrars and staff Add documents to users, request completion, use the Smart Document action.
Students and applicants Generate self-service documents, complete requested documents, sign contracts.

Data protection

Documents can contain personal data. Only insert variables the reader is allowed to see, limit self-service to the roles that need it, and restrict who can delete user documents (write:user-documents).

Where to start

  1. Create a document.
  2. Edit a document and preview it.
  3. Use a document template.
  4. For many users, read Generate documents in bulk.

Last updated on

Was this page helpful?