In this article:
Overview
Version control lets administrators update compliance templates in a programme without asking learners to re-sign documents unnecessarily. This cuts administrative effort, improves reporting accuracy and keeps document updates in line with programme needs.
When DfE changes a compliance document
We monitor DfE updates to compliance documents and usually identify changes when they're announced or shortly afterwards. Changes to Aptem must be planned, built and tested, so when a new version is available depends on how complex the change is. Template content is maintained by Aptem and can't be changed by customers.
When a new template version is released, add it to your programmes using the steps below.
Guide to amending and retiring compliance templates
These are the steps and things to consider when managing versions of compliance templates in your programmes.
Administrators need the Manage Programmes role to open the Compliance documents token in Aptem Classic programme settings in Programme Builder.
General policy on template management
Take great care when editing a template assigned to a programme with enrolled learners.
To protect existing learner records and programme configuration, we strongly advise against changing any details of a template version in use.
The only recommended change to an existing template version is setting its Valid To date to retire it.
How to introduce a new template version (recommended)
To update a compliance document, retire the old version and add a new one.
-
Retire the old template version.
- Edit the template you're retiring.
- Set its Valid To date to the day before the new template's Valid From date. This makes sure only one version of that template type is current for all learners across the date ranges.
- Add the new template to your programme configuration. Don't edit the existing document. Create a new one for the updated version. For the full steps, see Adding a new compliance template.
- Select Add.
- Set the Type, Version and Title for the new document.
- Set the Valid From date to when the new template should start being used. It must be after the retired template's end date.
- Note: Backdating the Valid From date affects current learners. They'll need to sign the new template, which may affect their access to their learning plans.
- Optionally, set a Valid To date for when the template stops being valid.
Retiring an existing template
- Default Valid From date: when you edit an older template, Valid From defaults to Aptem's founding date (19/02/2009) so existing compliance documents aren't invalidated. You can change it.
- Overlapping templates:
- You can't create templates with the same processor and type whose date ranges overlap. An error message blocks the dates.
- For templates with the same processor but different types, a confirmation message appears. Confirm to continue, or cancel to change the dates.
- Where date ranges overlap within the same processor (for example, Apprenticeship Agreement), a warning shows under each affected template. You can save anyway, but the warnings flag possible issues.
- Retiring a template: when you're ready to use a new template, retire the old one by entering a Valid To date and applying the change.
Adding a new compliance template
Go to the Compliance documents token in Aptem Classic programme settings in Programme Builder. You need the Manage Programmes role.
- Select Add.
- Set the Type, Version and Title for the new document.
- Set the validity dates. These make sure the template only applies to learners whose programme start dates fall within the range.
-
Valid From sets when the template applies. It must be after the retired date of the template it replaces.
- Note: Backdating the Valid From date affects current learners. They'll need to sign the new template, which may affect their access to their learning plans.
- Valid To sets when the template stops being valid. You can leave it blank.
-
Valid From sets when the template applies. It must be after the retired date of the template it replaces.
Learner application
- A template only applies if the learner's programme start date falls within its date range.
- This affects:
- compliance documents generated in the Onboarding Wizard
- compliance documents created manually in the Signatures grid in Aptem Console, or in the learner profile in Aptem Classic.
- Learners only see the documents relevant to them.
Any change to a template that applies to a learner prompts them to sign it again, even if the document hasn't been generated for them yet. Until they sign, they may be unable to open their learning plan. To generate the document so they can sign, ask the learner to continue through their Onboarding Wizard to Finish, or create it for them. See Generating, updating and signing compliance documents and "Documents need signing" in the Compliance documents: troubleshooting guide.