Example: Create a module handbook (Modulhandbuch)
Step-by-step example for a Modulhandbuch as a Module smart document: Module variables, Parent Module and Submodules smart table, module picker preview, and generation from User Management or the Modules table.
A module handbook (Modulhandbuch) describes a module: name, code, ECTS, attendance, status, and related details. In Fuxam you build it as a Module template. The create page lists this object type as Module → "Module description sheets".
Why it matters
Institutions need consistent module description sheets for accreditation, catalogs, and internal planning. A Module smart document pulls the same fields for every module, so you do not copy them by hand.
How it fits
See Document variables and data sources for Module variables and the smart table data source Parent Module and Submodules.
Before you start
| Requirement | Detail |
|---|---|
| Feature and permission | Smart Documents (FuxamCMS package) and read-write:settings-service-contracts. |
| Object type | Module. |
| Module data | At least one module with filled Details under Campus Management → Database → Modules. |
| Bulk export (optional) | read:course-modules to export module smart documents from the Modules table toolbar. |
What to place
| Content | What to insert |
|---|---|
| Module name | Module Name (Module) |
| Module code | Module Code (Module) |
| Version | Module Version (Module) |
| Description | Module Description (Module) |
| ECTS | ECTS Points (Module) |
| Attendance | Required Attendance % (Module) |
| Status | Module Status (Module) |
| Electable | Currently Electable (Module) |
| Submodules | Insert → Smart table with the data source Parent Module and Submodules |
| Date of issue | Document Generated At (Time Tracking), if you need a generation date |
| Signature | Insert → Signature, if the sheet must be signed |
Variable titles appear in English in the editor. The smart table data source cannot be changed after you insert the table.
How to build the module handbook
Create a Module template under Settings → Communication & Documents → Documents → Create Template. Set Object Type to Module.
Write a heading (for example the module name) and a Table or paragraphs with the Module variables above.
If the handbook should list submodules, choose Insert → Smart table and select Parent Module and Submodules. Then open Configure and pick the columns you need.
Add any fixed text your institution requires (learning outcomes layout, legal notes). Keep only what you can maintain.
In Page setup set the format and margins. Use the module picker (Module templates do not use As user:). Turn on Show sample data, use Preview, then Save. If Save blocked appears, fix the smart table data source first.
How to generate it
- From a user: Campus Management → User Management → [User] → Documents → Smart Document, pick the Module template, then pick the module.
- Bulk PDF from modules: Campus Management → Database → Modules → table toolbar action to bulk-export module smart documents (needs
read:course-modules).
Best practices
- Preview with a parent module that has submodules if you use the smart table.
- Keep module Details complete before large exports; empty fields stay empty in the PDF.
- Reuse one Module template for the institution instead of one template per module.
Common pitfalls
| Pitfall | How to avoid it |
|---|---|
| Empty or missing fields | Fill the module under Campus Management → Database → Modules first. |
| Wrong object type | Create the template as Module, not User or Certificate. |
| Preview without a module | Use the module picker and turn on Show sample data. |
| Save blocked | Fix the smart table data source (Parent Module and Submodules). |
| Bulk export missing | Check read:course-modules and that you start from the Modules table. |
FAQ
Do variable titles stay in English?
Yes. In the editor they appear as Module Name, ECTS Points, and the other Module titles listed above.
Can I list submodules in the handbook?
Yes. Insert a smart table with the data source Parent Module and Submodules.
Is this the same as a transcript of records?
No. A transcript is a User template with grades from the study plan. A Modulhandbuch is a Module template that describes the module itself.