Understand document selection, version behaviour, and completion settings for a reading module.
Product location: /training/courses/{id}/edit (fallback: /training/courses). Select the intended learning module and its editing action.
A Read & acknowledge module connects a course to a document learners must read and acknowledge. Use it when the learning task is to read a document and record acknowledgement.
This reference covers the reading module. It does not catalogue every module type or every course setting.
Product location: /training/courses/{id}/edit (fallback: /training/courses). Select the intended learning module and its editing action.
Setting | Meaning |
|---|---|
Module title | The name of this learning step. Use a title that tells the learner what to do. |
Description | Additional context or instructions for the module. |
Module type | Select Read & acknowledge when creating the module. The type cannot be changed after the module is created. |
Document to acknowledge | The document learners will read. Search by title or code, then select a result and check its identity. |
Required to complete the course | Learners must finish this module for the course to be complete. |
Minimum reading time (seconds) | A configured minimum reading duration before acknowledgement. Choose a value appropriate to the content and your organisation's policy. |
The document picker presents readable documents. Publication of a course with a required reading module also checks that the linked document is readable. A title or document reference by itself is insufficient.
Product location: /training/courses/{id}/edit (fallback: /training/courses). Select the intended learning module and its editing action.
Choice | Behaviour described by the release |
|---|---|
Always the latest approved version | Learners read the current approved version. A newer approved version becomes the version presented by this module. |
Pin to the current version | The module keeps the version approved when you select this option, even after a newer version is published. Check the displayed pinned version. |
The module editor initially selects Always the latest approved version. If you need a fixed reading requirement, deliberately choose the pinned option and confirm the version. Neither choice is a universal compliance recommendation; the correct choice depends on your organisation's document-control requirements.
Product location: /training/courses/{id}/edit (fallback: /training/courses). Select the intended learning module and its editing action.
This setting appears when Always the latest approved version is selected. It describes what happens to learners who have already completed the module.
Choice | Behaviour described by the release |
|---|---|
Re-assign learners to read the new version | Learners who already completed it must read and acknowledge the new version, with a due date. |
Notify learners only | Learners receive a notification about the change. Their existing completion remains valid and they do not have to acknowledge again. |
Do nothing | Publication of a new version does not affect learners who have already completed this module. |
The editor initially selects Re-assign learners to read the new version. Review this choice explicitly when configuring a real course.
Product location: /training/courses/{id}/edit (fallback: /training/courses). Select the intended learning module and its editing action.
A course needs at least one required module that learners can complete. Required modules must meet their type-specific publication requirements.
For a required Read & acknowledge module, choose a document that is approved, published, and readable by the learner. A missing, unavailable, or unreadable document can prevent publication. Review the reported validation message and correct the linked document or module configuration.
The first-course tutorial uses one required reading module to demonstrate this path.
