NPQ Registration is a Rails application that allows users to apply for National Professional Qualifications (NPQs) in England. Applications submitted are then sent via an API to the ECF (Early Careers Framework) application where they are picked up by Lead Providers and processed.
The core flow of NPQ is the Registration Wizard. This is a series of questions that the user must answer in order to complete their application.
This core flow is a loop through the registration_wizard#show and registration_wizard#update actions. The user visits a page, the corresponding Form object is loaded with the user's store from their session and the form is rendered, this occurs within registration_wizard#show.
When the user submits the form, the corresponding Form object is loaded with the user's store from their session and the form is validated. If the form is valid, the user's store is updated with the form's attributes and the user is redirected to the next step in the wizard. If the form is invalid, the user is redirected back to the form with the errors displayed.
Form objects are found within app/forms. Each Form Object is responsible for validating the user's input and updating the user's store with the form's attributes.
It defines the question name, it's validations, and the next_step and previous_step.
The store is a session based store of the user's current application state. It is a hash that is stored in the user's session and is updated as the user progresses through the wizard. It is accessed by calling wizard.store on or within a form. The Query Store (detailed below) provides a way to access the store in a stuctured way.
The RegistrationQueryStore service is a wrapper around the store hash to provide a way to provide helper methods to access store information.
The Course model represents the different NPQs that are available to apply for. Each course has an identifier which is used to identify the course in the ECF application.
The LeadProvider model represents the different Lead Providers that are able to provide training on the various NPQ courses. Each course has a different set of LeadProviders that can be selected. This is determined by calling LeadProvider.for(course:) when the user is presented their list of Lead Providers to choose from.
Funding Eligibility occurs once the user has finished questions related to their application, selected their NPQ and their provider. This information is then fed into FundingEligibility. This service then determines the user's eligibility for government funding and will provide a boolean funded status along with a funding_eligiblity_status_code which encodes the reason why a user may not have been funded.
Targeted support funding is extra funding that some schools will receive if they meet a certain criteria.
There is 2 levels of targeted support;
Eligibility::TargetedDeliveryFundingEligibility::TsfPrimaryEligibility
The TargetedDeliveryFunding checks on various criteria examples below:
- institution exisiting
- Elgibile
fe_ukprn - Whether they are a Local Authroity or Private Childcare Provider school
- Number of pupils
- Employment role
- Course
- Eligible establishment
The TsfPrimaryEligibility service check on:
- Phase of education
- Number of pupils
If a school passes the TargetedDeliveryFunding rules then that school will receive £200 and if the pass the TsfPrimaryEligibility checks then the school will receiive an additional £600 (£800 in total). NB. "TargetedDeliveryFunding" refers to the payments made to both schools (called Targeted Support Funding) and Lead Providers (called Targeted Delivery Funding).