Use a document template
Add a published Smart Document to a user, use the Smart Document action for many users, or set up self-service so eligible people generate documents themselves.
Using a document template means turning a published smart document into a real document for a person: you add it from Campus Management → User Management → [User] → Documents, use the Smart Document action for many users at once, or let eligible people generate it themselves through self-service.
Why it matters
Templates only save time when they reach the right people. Knowing the three routes (single, bulk, self-service) lets you pick the quickest one for each task, and lets you avoid handing out documents with blank fields.
Before you start
| Requirement | Detail |
|---|---|
| Feature | Smart Documents in the FuxamCMS package. |
| Template ready | A template with content and, if people must fill in anything, at least one form field (see the Form Fields column). |
| User data | The user's profile holds the data the variables need. See Document variables and data sources. |
| Default template | Optional. The template marked Default is preselected when you add a document. |
| Settings permission | Only for self-service setup: read-write:settings-service-contracts. |
How to add a document to one user
Open Campus Management → User Management and select the user. Open the Documents tab. See View a user.
Select Smart Document. A sheet titled Smart Document opens.
Pick a template. Templates are grouped as TipTap templates and PDF templates. The default template is already selected.
If the template is a Module template, pick the module. If it uses time-tracking variables, pick the time-tracking period.
Select Add. For a TipTap template, the fill screen opens. For a legacy PDF template, the Edit and Upload flow opens.
You can also ask the user to complete the document themselves. Use Request Completion from User in the Requested Documents section. See Manage documents.
How self-service works
Self-service lets eligible users generate a document without an administrator.
Go to Settings → Communication & Documents → Documents and find the Self-Service Documents section.
Select Add Document. In the Add self-service document sheet, choose the Template, the Roles that may use it, and optionally a requirement such as "Is enrolled in active semester".
Keep Active on. When it is active, eligible users can generate this document. Select Save changes.
Eligible users then choose Self-Service in their documents, select the available template, and can download a copy or use Save to documents. A second entry with the same template, roles, and requirement is rejected as a duplicate.
Best practices
- Test with a real user first. Add the document to a test user and check the result.
- Mark one template as Default for the document you generate most often.
- Use roles and requirements for self-service. Give access only to those who need it.
- Check the Form Fields column. A template with zero form fields cannot collect input.
- Use clear template names. People pick from a list.
Common pitfalls
| Pitfall | How to avoid it |
|---|---|
| Blank values in the document | Check the user's profile data or add a When empty rule in the editor. |
| Template missing from the picker | Check its Object Type. Module templates need a module. |
| No time-tracking period | Pick a period when the sheet asks for one. The document cannot be added without it. |
| Duplicate self-service entry | Change the template, roles, or requirement, or edit the existing entry. |
| Turning Active off by mistake | Users then cannot generate the document any more. |
FAQ
What is the difference between adding a document and requesting completion?
Adding a document creates it for the user. Requesting completion asks the user to fill in the form fields themselves and tracks it as Pending or Finished.
Where do I find generated documents?
On the user's Documents tab. See Manage documents.
Can students save their generated document?
Yes. In the self-service viewer they can download a copy or select Save to documents.
Can I add a document to many users at once?
Yes. Use the Smart Document action in the Users table. See Generate documents in bulk.